jingrow/gunicorn
1
0
Fork 0
mirror of https://github.com/frappe/gunicorn.git synced 2026-01-14 11:09:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

Consistent formatting and some addditions.

Browse Source 
Ensures sphinx will generate consistent html headings. Some
addition of header text.
This commit is contained in:
Prateek Singh Paudel 2012-10-03 16:25:26 +05:45
parent 5e543bc3dd
commit 9eba21fb8e
9 changed files with 104 additions and 136 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/source/community.rst
View File

@ -1,12 +1,8 @@
template: doc.html =========
title: Community Community
=========
_TOC_TOP_ Use these channels to communicate about the project.
.. contents::
:backlinks: top
_TOC_BOT_
Mailing list Mailing list
============ ============

28
docs/source/configure.rst
View File

@ -1,16 +1,6 @@
template: doc.html ======================
title: Configure Configuration Overview
insert_settings: true ======================
_TOC_TOP_
.. contents::
:backlinks: top
_TOC_BOT_
Overview
--------
Gunicorn pulls configuration information from three distinct places. Gunicorn pulls configuration information from three distinct places.
@ -31,7 +21,7 @@ Once again, in order of least to most authoritative:
3. Command Line 3. Command Line
Framework Settings Framework Settings
------------------ ==================
Currently, only Paster applications have access to framework specific Currently, only Paster applications have access to framework specific
settings. If you have ideas for providing settings to WSGI applications or settings. If you have ideas for providing settings to WSGI applications or
@ -41,7 +31,7 @@ let us know.
.. _issue: http://github.com/benoitc/gunicorn/issues .. _issue: http://github.com/benoitc/gunicorn/issues
Paster Applications Paster Applications
+++++++++++++++++++ -------------------
In your INI file, you can specify to use Gunicorn as the server like such:: In your INI file, you can specify to use Gunicorn as the server like such::
@ -57,7 +47,7 @@ the base configuration. Remember that these will be overridden by the config
file and/or the command line. file and/or the command line.
Configuration File Configuration File
------------------ ==================
The configuration file should be a valid Python source file. It only needs to The configuration file should be a valid Python source file. It only needs to
be readable from the file system. More specifically, it does not need to be be readable from the file system. More specifically, it does not need to be
@ -78,14 +68,14 @@ On a side note, Python's older than 2.6 can use sysconf to get the
number of processors:: number of processors::
import os import os
def numCPUs(): def numCPUs():
if not hasattr(os, "sysconf"): if not hasattr(os, "sysconf"):
raise RuntimeError("No sysconf detected.") raise RuntimeError("No sysconf detected.")
return os.sysconf("SC_NPROCESSORS_ONLN") return os.sysconf("SC_NPROCESSORS_ONLN")
Command Line Command Line
------------ ============
If an option is specified on the command line, it overrides all other values If an option is specified on the command line, it overrides all other values
that may have been specified in the app specific settings, or in the optional that may have been specified in the app specific settings, or in the optional
@ -99,7 +89,7 @@ There is also a ``--version`` flag available to the command line scripts that
isn't mentioned in the list of settings. isn't mentioned in the list of settings.
Settings Settings
-------- ========
This is an exhaustive list of settings for Gunicorn. Some settings are only This is an exhaustive list of settings for Gunicorn. Some settings are only
able to be set from a configuration file. The setting name is what should be able to be set from a configuration file. The setting name is what should be

57
docs/source/deploy.rst
View File

@ -1,15 +1,11 @@
template: doc.html ==================
title: Deploy Deploying Gunicorn
==================
_TOC_TOP_ We strongly recommend to use Gunicorn behind a proxy server.
.. contents::
:backlinks: top
_TOC_BOT_
Nginx Configuration Nginx Configuration
------------------- ===================
Although there are many HTTP proxies available, we strongly advise that you Although there are many HTTP proxies available, we strongly advise that you
use Nginx_. If you choose another proxy server you need to make sure that it use Nginx_. If you choose another proxy server you need to make sure that it
@ -20,16 +16,16 @@ You can use slowloris_ to check if your proxy is behaving properly.
An `example configuration`_ file for fast clients with Nginx_:: An `example configuration`_ file for fast clients with Nginx_::
worker_processes 1; worker_processes 1;
user nobody nogroup; user nobody nogroup;
pid /tmp/nginx.pid; pid /tmp/nginx.pid;
error_log /tmp/nginx.error.log; error_log /tmp/nginx.error.log;
events { events {
worker_connections 1024; worker_connections 1024;
accept_mutex off; accept_mutex off;
} }
http { http {
include mime.types; include mime.types;
default_type application/octet-stream; default_type application/octet-stream;
@ -41,17 +37,17 @@ An `example configuration`_ file for fast clients with Nginx_::
# For a TCP configuration: # For a TCP configuration:
# server 192.168.0.7:8000 fail_timeout=0; # server 192.168.0.7:8000 fail_timeout=0;
} }
server { server {
listen 80 default; listen 80 default;
client_max_body_size 4G; client_max_body_size 4G;
server_name _; server_name _;
keepalive_timeout 5; keepalive_timeout 5;
# path for static files # path for static files
root /path/to/app/current/public; root /path/to/app/current/public;
location / { location / {
# checks for static file, if not found proxy to app # checks for static file, if not found proxy to app
try_files $uri @proxy_to_app; try_files $uri @proxy_to_app;
@ -61,10 +57,10 @@ An `example configuration`_ file for fast clients with Nginx_::
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header Host $http_host; proxy_set_header Host $http_host;
proxy_redirect off; proxy_redirect off;
proxy_pass http://app_server; proxy_pass http://app_server;
} }
error_page 500 502 503 504 /500.html; error_page 500 502 503 504 /500.html;
location = /500.html { location = /500.html {
root /path/to/app/current/public; root /path/to/app/current/public;
@ -95,7 +91,7 @@ To turn off buffering, you only need to add ``proxy_buffering off;`` to your
... ...
Using Virtualenv Using Virtualenv
---------------- ================
To serve an app from a Virtualenv_ it is generally easiest to just install To serve an app from a Virtualenv_ it is generally easiest to just install
Gunicorn directly into the Virtualenv. This will create a set of Gunicorn Gunicorn directly into the Virtualenv. This will create a set of Gunicorn
@ -120,7 +116,7 @@ passing ``-I`` or ``--ignore-installed`` option to pip::
$ pip install -I gunicorn $ pip install -I gunicorn
Monitoring Monitoring
---------- ==========
.. note:: .. note::
Make sure that when using either of these service monitors you do not Make sure that when using either of these service monitors you do not
@ -130,7 +126,7 @@ Monitoring
confuses the monitor services. confuses the monitor services.
Circus Circus
++++++ ------
`Circus <http://circus.readthedocs.org/en/latest/index.html>`_ can be `Circus <http://circus.readthedocs.org/en/latest/index.html>`_ can be
used to monitor gunicorn. A simple configuration is:: used to monitor gunicorn. A simple configuration is::
@ -143,37 +139,36 @@ used to monitor gunicorn. A simple configuration is::
Then you can easily manage Gunicorn using the `circusctl <http://circus.readthedocs.org/en/latest/commands/#cli>`_ command. Then you can easily manage Gunicorn using the `circusctl <http://circus.readthedocs.org/en/latest/commands/#cli>`_ command.
Runit Runit
+++++ -----
A popular method for deploying Gunicorn is to have it monitored by runit_. A popular method for deploying Gunicorn is to have it monitored by runit_.
Here is an `example service`_ definition:: Here is an `example service`_ definition::
#!/bin/sh #!/bin/sh
GUNICORN=/usr/local/bin/gunicorn GUNICORN=/usr/local/bin/gunicorn
ROOT=/path/to/project ROOT=/path/to/project
PID=/var/run/gunicorn.pid PID=/var/run/gunicorn.pid
APP=main:application APP=main:application
if [ -f $PID ]; then rm $PID; fi if [ -f $PID ]; then rm $PID; fi
cd $ROOT cd $ROOT
exec $GUNICORN -c $ROOT/gunicorn.conf.py --pid=$PID $APP exec $GUNICORN -c $ROOT/gunicorn.conf.py --pid=$PID $APP
Save this as ``/etc/sv/[app_name]/run``, and make it executable Save this as ``/etc/sv/[app_name]/run``, and make it executable
(``chmod u+x /etc/sv/[app_name]/run``). (``chmod u+x /etc/sv/[app_name]/run``).
Then run ``ln -s /etc/sv/[app_name] /etc/service/[app_name]``. Then run ``ln -s /etc/sv/[app_name] /etc/service/[app_name]``.
If runit is installed, gunicorn should start running automatically as soon If runit is installed, gunicorn should start running automatically as soon
as you create the symlink. as you create the symlink.
If it doesn't start automatically, run the script directly to troubleshoot. If it doesn't start automatically, run the script directly to troubleshoot.
Supervisor Supervisor
++++++++++ ----------
Another useful tool to monitor and control Gunicorn is Supervisor_. A Another useful tool to monitor and control Gunicorn is Supervisor_. A
`simple configuration`_ is:: `simple configuration`_ is::
[program:gunicorn] [program:gunicorn]
@ -185,7 +180,7 @@ Another useful tool to monitor and control Gunicorn is Supervisor_. A
redirect_stderr=True redirect_stderr=True
Logging Logging
------- =======
Logging can be configured by using various flags detailed in the Logging can be configured by using various flags detailed in the
`configuration documentation`_ or by creating a `logging configuration file`_. `configuration documentation`_ or by creating a `logging configuration file`_.

12
docs/source/design.rst
View File

@ -1,12 +1,8 @@
template: doc.html ======
title: Design Design
======
_TOC_TOP_ A brief description of an architecture of Gunicorn.
.. contents::
:backlinks: top
_TOC_BOT_
Server Model Server Model
============ ============

15
docs/source/faq.rst
View File

@ -1,13 +1,6 @@
template: doc.html ===
title: FAQ FAQ
===
_TOC_TOP_
.. contents::
:backlinks: top
_TOC_BOT_
WSGI Bits WSGI Bits
========= =========
@ -118,7 +111,7 @@ of open file descriptors for a given process. For the confused out there,
remember that Unices treat sockets as files. remember that Unices treat sockets as files.
:: ::
$ sudo ulimit -n 2048 $ sudo ulimit -n 2048
How can I increase the maximum socket backlog? How can I increase the maximum socket backlog?

45
docs/source/index.rst
View File

@ -1,22 +1,33 @@
.. Gunicorn documentation master file, created by ======================
sphinx-quickstart on Wed Oct 3 04:59:09 2012. Gunicorn - wsgi server
You can adapt this file completely to your liking, but it should at least ======================
contain the root `toctree` directive.
Welcome to Gunicorn's documentation! Gunicorn 'Green Unicorn' is a Python WSGI HTTP Server for UNIX. It's a pre-fork
==================================== worker model ported from Ruby's Unicorn project. The Gunicorn server is broadly
compatible with various web frameworks, simply implemented, light on server
resources, and fairly speedy.
Contents: Features
--------
* Natively supports WSGI, Django, and Paster
* Automatic worker process management
* Simple Python configuration
* Multiple worker configurations
* Various server hooks for extensibility
* Compatible with Python 2.x >= 2.5
Contents
========
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
install
run
configure
deploy
design
community
faq
news

32
docs/source/install.rst
View File

@ -1,22 +1,18 @@
template: doc.html ============
title: Install Installation
============
_TOC_TOP_ Follow the following steps to install Gunicorn.
.. contents::
:backlinks: top
_TOC_BOT_
Requirements Requirements
------------ ============
- **Python 2.x >= 2.5** (Python 3.x will be supported soon) - **Python 2.x >= 2.5** (Python 3.x will be supported soon)
- setuptools >= 0.6c6 - setuptools >= 0.6c6
- nosetests (for the test suite only) - nosetests (for the test suite only)
With easy_install With easy_install
----------------- =================
If you don't already have ``easy_install`` available you'll want to download If you don't already have ``easy_install`` available you'll want to download
and run the ``ez_setup.py`` script:: and run the ``ez_setup.py`` script::
@ -38,7 +34,7 @@ To install or upgrade to the latest released version of Gunicorn::
$ pip install -f http://github.com/tilgovi/gunicorn/tarball/py24 gunicorn $ pip install -f http://github.com/tilgovi/gunicorn/tarball/py24 gunicorn
From Source From Source
----------- ===========
You can install Gunicorn from source just as you would install any other You can install Gunicorn from source just as you would install any other
Python package. Gunicorn uses setuptools which will automatically fetch all Python package. Gunicorn uses setuptools which will automatically fetch all
@ -67,7 +63,7 @@ well as make changes to the source::
$ python setup.py develop $ python setup.py develop
Async Workers Async Workers
------------- =============
You may also want to install Eventlet_ or Gevent_ if you expect that your You may also want to install Eventlet_ or Gevent_ if you expect that your
application code may need to pause for extended periods of time during request application code may need to pause for extended periods of time during request
@ -92,7 +88,7 @@ want to consider one of the alternate worker types.
installed, this is the most likely reason. installed, this is the most likely reason.
Debian GNU/Linux Debian GNU/Linux
---------------- ================
If you are using Debian GNU/Linux and it is recommended that you use If you are using Debian GNU/Linux and it is recommended that you use
system packages to install Gunicorn except maybe when you want to use system packages to install Gunicorn except maybe when you want to use
@ -114,7 +110,7 @@ advantages:
entirely from the system in seconds. entirely from the system in seconds.
Stable ("squeeze") Stable ("squeeze")
++++++++++++++++++ ------------------
The version of Gunicorn in the Debian_ "stable" distribution is 0.10.0 (July The version of Gunicorn in the Debian_ "stable" distribution is 0.10.0 (July
2010). It is not recommended that you use this version. 2010). It is not recommended that you use this version.
@ -133,7 +129,7 @@ You can then install the latest version using::
$ sudo apt-get -t squeeze-backports install gunicorn $ sudo apt-get -t squeeze-backports install gunicorn
Testing ("wheezy") / Unstable ("sid") Testing ("wheezy") / Unstable ("sid")
+++++++++++++++++++++++++++++++++++++ -------------------------------------
"wheezy" and "sid" contain the latest released version of Gunicorn. You can "wheezy" and "sid" contain the latest released version of Gunicorn. You can
install it in the usual way:: install it in the usual way::
@ -142,7 +138,7 @@ install it in the usual way::
Ubuntu Ubuntu
------ ======
If you use Ubuntu_, you can update your system with packages from If you use Ubuntu_, you can update your system with packages from
our PPA_ by adding ``ppa:gunicorn/ppa`` to your system's Software our PPA_ by adding ``ppa:gunicorn/ppa`` to your system's Software
@ -160,14 +156,14 @@ and adding them to your system's software sources::
Replace 'lucid' with your Ubuntu distribution series. Replace 'lucid' with your Ubuntu distribution series.
Signing key Signing key
+++++++++++ -----------
:: ::
1024R/5370FF2A 1024R/5370FF2A
Fingerprint Fingerprint
+++++++++++ -----------
:: ::

12
docs/source/news.rst
View File

@ -1,12 +1,6 @@
template: doc.html =========
title: News Changelog
=========
_TOC_TOP_
.. contents::
:backlinks: top
_TOC_BOT_
0.14.6 / 2012-07-26 0.14.6 / 2012-07-26
------------------- -------------------

27
docs/source/run.rst
View File

@ -1,15 +1,12 @@
template: doc.html ================
title: Run Running Gunicorn
================
_TOC_TOP_ You can run Gunicorn by using commands or integrate with Django or Paster. For
deploying Gunicorn in production see :doc:`deploy`.
.. contents::
:backlinks: top
_TOC_BOT_
Commands Commands
-------- ========
After installing Gunicorn you will have access to three command line scripts After installing Gunicorn you will have access to three command line scripts
that can be used for serving the various supported web frameworks: that can be used for serving the various supported web frameworks:
@ -19,7 +16,7 @@ that can be used for serving the various supported web frameworks:
* ``gunicorn_paster`` * ``gunicorn_paster``
gunicorn gunicorn
++++++++ --------
The first and most basic script is used to serve 'bare' WSGI applications The first and most basic script is used to serve 'bare' WSGI applications
that don't require a translation layer. Basic usage:: that don't require a translation layer. Basic usage::
@ -53,7 +50,7 @@ Example with test app::
$ gunicorn --workers=2 test:app $ gunicorn --workers=2 test:app
gunicorn_django gunicorn_django
+++++++++++++++ ---------------
You might not have guessed it, but this script is used to serve Django You might not have guessed it, but this script is used to serve Django
applications. Basic usage:: applications. Basic usage::
@ -74,7 +71,7 @@ Example with your Django project::
the `gunicorn`_ command. the `gunicorn`_ command.
gunicorn_paster gunicorn_paster
+++++++++++++++ ---------------
Yeah, for Paster-compatible frameworks (Pylons, TurboGears 2, ...). We Yeah, for Paster-compatible frameworks (Pylons, TurboGears 2, ...). We
apologize for the lack of script name creativity. And some usage:: apologize for the lack of script name creativity. And some usage::
@ -87,14 +84,14 @@ Simple example::
$ gunicorn_paste --workers=2 development.ini $ gunicorn_paste --workers=2 development.ini
Integration Integration
----------- ===========
Alternatively, we also provide integration for both Django and Paster Alternatively, we also provide integration for both Django and Paster
applications in case your deployment strategy would be better served by such applications in case your deployment strategy would be better served by such
invocation styles. invocation styles.
Django ./manage.py Django ./manage.py
++++++++++++++++++ ------------------
You can add a ``run_gunicorn`` command to your ``./manage.py`` simply by adding You can add a ``run_gunicorn`` command to your ``./manage.py`` simply by adding
gunicorn to your ``INSTALLED_APPS``:: gunicorn to your ``INSTALLED_APPS``::
@ -109,7 +106,7 @@ Then you can run::
python manage.py run_gunicorn python manage.py run_gunicorn
paster serve paster serve
++++++++++++ ------------
If you're wanting to keep on keeping on with the usual paster serve command, 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:: you can specify the Gunicorn server settings in your configuration file::