Skip to content

Commit

Permalink
Simplify README.rst.
Browse files Browse the repository at this point in the history
  • Loading branch information
berkerpeksag committed Dec 1, 2014
1 parent 7ce9037 commit 43d1eba
Showing 1 changed file with 16 additions and 119 deletions.
135 changes: 16 additions & 119 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,90 +1,37 @@
About
-----
Gunicorn
--------

.. image::
https://secure.travis-ci.org/benoitc/gunicorn.png?branch=master
:alt: Build Status
:target: https://travis-ci.org/benoitc/gunicorn

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
resource usage, and fairly speedy.

Feel free to join us in `#gunicorn`_ on freenode_.

.. image::
https://secure.travis-ci.org/benoitc/gunicorn.png?branch=master
:alt: Build Status
:target: https://travis-ci.org/benoitc/gunicorn
Feel free to join us in `#gunicorn`_ on Freenode_.

Documentation
-------------

http://docs.gunicorn.org
The documentation is hosted at http://docs.gunicorn.org.

Installation
------------

Gunicorn requires **Python 2.x >= 2.6** or **Python 3.x >= 3.2**.

Install from sources::

$ python setup.py install

Or from PyPI::

$ pip install -U gunicorn

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 processing. If you're on Python 3 you may also consider one of
the Asyncio_ workers. Check out the FAQ_ for more information on when you'll
want to consider one of the alternate worker types.

To install eventlet::

$ pip install -U eventlet

If you encounter errors when compiling the extensions for Eventlet_ or
Gevent_ you most likely need to install a newer version of libev_ or libevent_.
Install from PyPI::

Basic Usage
-----------
$ pip install gunicorn

After installing Gunicorn you will have access to the command line script
``gunicorn``.

Commonly Used Arguments
+++++++++++++++++++++++

* ``-c CONFIG, --config=CONFIG`` - Specify the path to a `config file`_ or
python module.
* ``-b BIND, --bind=BIND`` - Specify a server socket to bind. Server sockets
can be any of ``$(HOST)``, ``$(HOST):$(PORT)``, or ``unix:$(PATH)``.
An IP is a valid ``$(HOST)``.
* ``-w WORKERS, --workers=WORKERS`` - The number of worker processes. This
number should generally be between 2-4 workers per core in the server.
Check the FAQ_ for ideas on tuning this parameter.
* ``-k WORKERCLASS, --worker-class=WORKERCLASS`` - The type of worker process
to run. You'll definitely want to read the `production page`_ for the
implications of this parameter. You can set this to ``egg:gunicorn#$(NAME)``
where ``$(NAME)`` is one of ``sync``, ``eventlet``, ``gevent``, or
``tornado``, ``gthread``, ``gaiohttp`. ``sync`` is the default.
* ``-n APP_NAME, --name=APP_NAME`` - If setproctitle_ is installed you can
adjust the name of Gunicorn process as they appear in the process system
table (which affects tools like ``ps`` and ``top``).

sync=gunicorn.workers.sync:SyncWorker
eventlet=gunicorn.workers.geventlet:EventletWorker
gevent=gunicorn.workers.ggevent:GeventWorker
tornado

There are various other parameters that affect user privileges, logging, etc.
You can see the complete list with the expected::

$ gunicorn -h

gunicorn
++++++++
Usage
-----

The first and most basic script is used to serve 'bare' WSGI applications
that don't require a translation layer. Basic usage::
Basic usage::

$ gunicorn [OPTIONS] APP_MODULE

Expand All @@ -97,46 +44,6 @@ Example with test app::
$ cd examples
$ gunicorn --workers=2 test:app

Integration
-----------

We also provide integration for both Django and Paster applications.

Django
++++++

Gunicorn will look for a WSGI callable named ``application`` if not specified.
So for a typical Django project, invoking gunicorn would look like::

gunicorn myproject.wsgi

(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.)

You can use the
`--env <http://docs.gunicorn.org/en/latest/settings.html#raw-env>`_ option
to set the path to load the settings. In case you need it you can also
add your application path to ``PYTHONPATH`` using the
`--pythonpath <http://docs.gunicorn.org/en/latest/settings.html#pythonpath>`_
option::

gunicorn --env DJANGO_SETTINGS_MODULE=myproject.settings myproject.wsgi

Paste
+++++

If you are a user/developer of a paste-compatible framework/app (as
Pyramid, Pylons and Turbogears) you can use the gunicorn
`--paste <http://docs.gunicorn.org/en/latest/settings.html#paste>`_ option
to run your application.

For example:

gunicorn --paste development.ini -b :8080 --chdir /path/to/project

It is all here. No configuration files nor additional python modules to
write !!

Instrumentation
---------------
Expand Down Expand Up @@ -167,23 +74,13 @@ To generate new metrics you can `log.info` with a few additional keywords::

log.info("...", extra={"metric": "my.metric", "value": "1.2", "mtype": "gauge"})

LICENSE
License
-------

Gunicorn is released under the MIT License. See the LICENSE_ file for more
details.

.. _Unicorn: http://unicorn.bogomips.org/
.. _`#gunicorn`: http://webchat.freenode.net/?channels=gunicorn
.. _freenode: http://freenode.net
.. _Eventlet: http://eventlet.net
.. _Gevent: http://gevent.org
.. _Asyncio: https://docs.python.org/3/library/asyncio.html
.. _FAQ: http://docs.gunicorn.org/en/latest/faq.html
.. _libev: http://software.schmorp.de/pkg/libev.html
.. _libevent: http://monkey.org/~provos/libevent
.. _`production page`: http://docs.gunicorn.org/en/latest/deploy.html
.. _`config file`: http://docs.gunicorn.org/en/latest/configure.html
.. _setproctitle: http://pypi.python.org/pypi/setproctitle/
.. _statsD: http://github.com/etsy/statsd
.. _Freenode: http://freenode.net
.. _LICENSE: http://github.com/benoitc/gunicorn/blob/master/LICENSE

0 comments on commit 43d1eba

Please sign in to comment.