mirror of
https://github.com/frappe/gunicorn.git
synced 2026-01-14 11:09:11 +08:00
90fb09f618
Using gunicorn with paster command line causes the application to load before gunicorn. In this case, there is no choice but to preload the application. Document this fact. Fixes #528.
130 lines
3.4 KiB
ReStructuredText
130 lines
3.4 KiB
ReStructuredText
================
|
|
Running Gunicorn
|
|
================
|
|
|
|
You can run Gunicorn by using commands or integrate with Django or Paster. For
|
|
deploying Gunicorn in production see :doc:`deploy`.
|
|
|
|
Commands
|
|
========
|
|
|
|
After installing Gunicorn you will have access to three command line scripts
|
|
that can be used for serving the various supported web frameworks:
|
|
|
|
* ``gunicorn``
|
|
* ``gunicorn_django``
|
|
* ``gunicorn_paster``
|
|
|
|
gunicorn
|
|
--------
|
|
|
|
The first and most basic script is used to serve 'bare' WSGI applications
|
|
that don't require a translation layer. Basic usage::
|
|
|
|
$ gunicorn [OPTIONS] APP_MODULE
|
|
|
|
Where ``APP_MODULE`` is of the pattern ``$(MODULE_NAME):$(VARIABLE_NAME)``. The
|
|
module name can be a full dotted path. The variable name refers to a WSGI
|
|
callable that should be found in the specified module.
|
|
|
|
Example with test app::
|
|
|
|
$ cd examples
|
|
$ cat test.py
|
|
# -*- coding: utf-8 -
|
|
#
|
|
# This file is part of gunicorn released under the MIT license.
|
|
# See the NOTICE for more information.
|
|
|
|
def app(environ, start_response):
|
|
"""Simplest possible application object"""
|
|
data = 'Hello, World!\n'
|
|
status = '200 OK'
|
|
response_headers = [
|
|
('Content-type','text/plain'),
|
|
('Content-Length', str(len(data)))
|
|
]
|
|
start_response(status, response_headers)
|
|
return iter([data])
|
|
|
|
$ gunicorn --workers=2 test:app
|
|
|
|
gunicorn_django
|
|
---------------
|
|
|
|
You might not have guessed it, but this script is used to serve Django
|
|
applications. Basic usage::
|
|
|
|
$ gunicorn_django [OPTIONS] [SETTINGS_PATH]
|
|
|
|
By default ``SETTINGS_PATH`` will look for ``settings.py`` in the current
|
|
directory.
|
|
|
|
Example with your Django project::
|
|
|
|
$ cd path/to/yourdjangoproject
|
|
$ gunicorn_django --workers=2
|
|
|
|
.. note:: If you run Django 1.4 or newer, it's highly recommended to
|
|
simply run your application with the `WSGI interface
|
|
<https://docs.djangoproject.com/en/1.4/howto/deployment/wsgi/>`_ using
|
|
the `gunicorn`_ command.
|
|
|
|
gunicorn_paster
|
|
---------------
|
|
|
|
Yeah, for Paster-compatible frameworks (Pylons, TurboGears 2, ...). We
|
|
apologize for the lack of script name creativity. And some usage::
|
|
|
|
$ gunicorn_paster [OPTIONS] paste_config.ini
|
|
|
|
Simple example::
|
|
|
|
$ cd yourpasteproject
|
|
$ gunicorn_paster --workers=2 development.ini
|
|
|
|
Integration
|
|
===========
|
|
|
|
Alternatively, we also provide integration for both Django and Paster
|
|
applications in case your deployment strategy would be better served by such
|
|
invocation styles.
|
|
|
|
Django ./manage.py
|
|
------------------
|
|
|
|
You can add a ``run_gunicorn`` command to your ``./manage.py`` simply by adding
|
|
gunicorn to your ``INSTALLED_APPS``::
|
|
|
|
INSTALLED_APPS = (
|
|
...
|
|
"gunicorn",
|
|
)
|
|
|
|
Then you can run::
|
|
|
|
python manage.py run_gunicorn
|
|
|
|
paster serve
|
|
------------
|
|
|
|
If you're wanting to keep on keeping on with the usual paster serve command,
|
|
you can specify the Gunicorn server settings in your configuration file::
|
|
|
|
[server:main]
|
|
use = egg:gunicorn#main
|
|
host = 127.0.0.1
|
|
port = 5000
|
|
# Uncomment the line below to use other advanced gunicorn settings
|
|
#config = %(here)/gunicorn.conf.py
|
|
|
|
And then as per usual::
|
|
|
|
$ cd yourpasteproject
|
|
$ paster serve development.ini workers=2
|
|
|
|
However, in this configuration, Gunicorn does not reload the application when
|
|
new workers are started. See the note about preloading_.
|
|
|
|
.. _preloading: configure.html#preload-app
|