Gunicorn as WSGI server in Django

Introduction

Gunicorn helps your Django app talk to the web by running it safely and efficiently. It acts like a waiter taking web requests and giving back responses.

You want to run your Django app on a real web server for users to access.

You need a simple way to serve your app in production without complex setup.

You want to handle many users at once by running multiple worker processes.

You want to connect your Django app to a web server like Nginx for better performance.

Syntax

Django

gunicorn myproject.wsgi:application

Replace myproject with your Django project name.

This command starts Gunicorn using the WSGI application from your Django project.

Examples

Starts Gunicorn with default settings to serve your Django app.

Django

gunicorn myproject.wsgi:application

Runs Gunicorn with 3 worker processes to handle multiple requests at the same time.

Django

gunicorn --workers 3 myproject.wsgi:application

Binds Gunicorn to all network interfaces on port 8000, making your app accessible on your local network.

Django

gunicorn --bind 0.0.0.0:8000 myproject.wsgi:application

Sample Program

This command starts Gunicorn with 2 workers, listening only on your computer's local address at port 8000. You can open http://127.0.0.1:8000 in your browser to see your Django app.

Django

# Run this command in your terminal inside your Django project folder

gunicorn --workers 2 --bind 127.0.0.1:8000 myproject.wsgi:application

Important Notes

Gunicorn works only with WSGI-compatible apps like Django.

Use multiple workers to improve handling many users but don't use too many to avoid slowing your server.

For public access, combine Gunicorn with a web server like Nginx for security and speed.

Summary

Gunicorn runs your Django app by acting as a bridge between the web and your code.

You start Gunicorn with your Django project's WSGI application to serve requests.

Adjust workers and binding options to control performance and accessibility.

Practice

1. What is the primary role of Gunicorn when used with a Django project?

easy

A. It replaces the Django ORM for database queries.

B. It acts as a bridge between the web server and the Django application.

C. It manages static files like CSS and JavaScript.

D. It compiles Django templates into HTML.

Solution

1. Step 1: Understand Gunicorn's purpose

   Gunicorn is a WSGI server that connects web requests to the Django app code.

2. Step 2: Identify what Gunicorn does not do

   Gunicorn does not handle database queries, static files, or template compilation directly.

3. Final Answer:

   It acts as a bridge between the web server and the Django application. -> Option B

4. Quick Check:

   Gunicorn = bridge server [OK]

Hint: Gunicorn connects web requests to Django code [OK]

Common Mistakes:

• Thinking Gunicorn manages static files
• Confusing Gunicorn with Django ORM
• Assuming Gunicorn compiles templates

2. Which of the following is the correct command to start Gunicorn for a Django project named myproject with the default WSGI application?

easy

A. gunicorn myproject.settings:application

B. gunicorn myproject.manage:application

C. gunicorn myproject.urls:application

D. gunicorn myproject.wsgi:application

Solution

1. Step 1: Identify the WSGI application path

   In Django, the WSGI app is located at projectname.wsgi:application.

2. Step 2: Match the correct command format

   The correct Gunicorn command uses gunicorn myproject.wsgi:application.

3. Final Answer:

   gunicorn myproject.wsgi:application -> Option D

4. Quick Check:

   WSGI app path = myproject.wsgi:application [OK]

Hint: Gunicorn command uses <project>.wsgi:application [OK]

Common Mistakes:

• Using manage or settings instead of wsgi
• Confusing URLs module with WSGI
• Omitting the ':application' part

3. Given the command gunicorn --workers 3 --bind 0.0.0.0:8000 myproject.wsgi:application, what will happen when you run it?

medium

A. Gunicorn will start 1 worker and listen only on localhost at port 8000.

B. Gunicorn will fail because the bind address is invalid.

C. Gunicorn will start 3 worker processes and listen on all network interfaces at port 8000.

D. Gunicorn will start 3 workers but will not bind to any port.

Solution

1. Step 1: Analyze the --workers option

   The command specifies 3 workers, so Gunicorn will start 3 worker processes.

2. Step 2: Analyze the --bind option

   Binding to 0.0.0.0:8000 means listening on all network interfaces at port 8000.

3. Final Answer:

   Gunicorn will start 3 worker processes and listen on all network interfaces at port 8000. -> Option C

4. Quick Check:

   --workers 3 + --bind 0.0.0.0:8000 = Gunicorn will start 3 worker processes and listen on all network interfaces at port 8000. [OK]

Hint: 0.0.0.0 binds all interfaces, workers set process count [OK]

Common Mistakes:

• Assuming 0.0.0.0 is invalid
• Thinking workers default to 1 always
• Ignoring the bind port

4. You run gunicorn myproject.wsgi:application --workers two and get an error. What is the likely cause?

medium

A. The workers option must be a number, not a word.

B. The WSGI application path is incorrect.

C. Gunicorn does not accept the --workers option.

D. The command is missing the --bind option.

Solution

1. Step 1: Check the --workers option value

   The value 'two' is a word, but --workers expects an integer number.

2. Step 2: Confirm Gunicorn option requirements

   Gunicorn requires a numeric value for workers; using a word causes an error.

3. Final Answer:

   The workers option must be a number, not a word. -> Option A

4. Quick Check:

   --workers needs number, not text [OK]

Hint: Workers count must be numeric, not text [OK]

Common Mistakes:

• Assuming WSGI path error causes this
• Thinking --workers is unsupported
• Believing --bind is mandatory for this error

5. You want to deploy your Django app with Gunicorn on a server accessible only on port 8080 and use 4 workers for better performance. Which command correctly achieves this?

hard

A. gunicorn --workers 4 --bind 0.0.0.0:8080 myproject.wsgi:application

B. gunicorn --workers 4 --bind 127.0.0.1:8080 myproject.wsgi:application

C. gunicorn --workers 1 --bind 0.0.0.0:8080 myproject.wsgi:application

D. gunicorn --bind 0.0.0.0:80 myproject.wsgi:application

Solution

1. Step 1: Set the correct number of workers

   The requirement is 4 workers, so use --workers 4.

2. Step 2: Bind to port 8080 on all interfaces

   Binding to 0.0.0.0:8080 makes the app accessible on port 8080 from any network interface.

3. Step 3: Verify the WSGI application path

   The path myproject.wsgi:application is the correct WSGI app for Django.

4. Final Answer:

   gunicorn --workers 4 --bind 0.0.0.0:8080 myproject.wsgi:application -> Option A

5. Quick Check:

   4 workers + bind 0.0.0.0:8080 = gunicorn --workers 4 --bind 0.0.0.0:8080 myproject.wsgi:application [OK]

Hint: Use --workers 4 and bind 0.0.0.0:8080 for access [OK]

Common Mistakes:

• Binding only to localhost (127.0.0.1) limits access
• Using wrong port number
• Setting wrong number of workers