How to use Django with Gunicorn¶
Gunicorn (‘Green Unicorn’) is a pure-Python WSGI server for UNIX. It has no dependencies and is easy to install and use.
There are two ways to use Gunicorn with Django. One is to have Gunicorn treat Django as just another WSGI application. The second is to use Gunicorn’s special integration with Django.
Installing gunicorn is as easy as sudo pip install gunicorn. For more details, see the gunicorn documentation.
Running Django in Gunicorn as a generic WSGI application¶
When Gunicorn is installed, a gunicorn command is available which starts the Gunicorn server process. At its simplest, gunicorn just needs to be called with a the location of a WSGI application object.:
gunicorn [OPTIONS] APP_MODULE
Where APP_MODULE is of the pattern MODULE_NAME:VARIABLE_NAME. The module name should be a full dotted path. The variable name refers to a WSGI callable that should be found in the specified module.
So for a typical Django project, invoking gunicorn would look like:
(This requires that your project be on the Python path; the simplest way to ensure that is to run this command from the same directory as your manage.py file.)
Using Gunicorn’s Django integration¶
If you are using Django 1.4 or newer, it’s highly recommended to simply run your application with the WSGI interface using the gunicorn command as described above.
To use Gunicorn’s built-in Django integration, first add "gunicorn" to INSTALLED_APPS. Then run python manage.py run_gunicorn.
This provides a few Django-specific niceties:
- sets the gunicorn process name to be that of the project
- validates installed models
- allows an --adminmedia option for passing in the location of the admin media files.
See Gunicorn’s deployment documentation for additional tips on starting and maintaining the Gunicorn server.
Having trouble? We'd like to help!
- Try the FAQ — it's got answers to many common questions.
- Search for information in the archives of the django-users mailing list, or post a question.
- Ask a question in the #django IRC channel, or search the IRC logs to see if it has been asked before.
- If you notice errors with this documentation, please open a ticket and let us know! Please only use the ticket tracker for criticisms and improvements on the docs. For tech support, use the resources above.