gunicorn/doc/site/installation.rst
2010-05-06 20:55:38 -04:00

102 lines
2.8 KiB
ReStructuredText

template: doc.html
title: Installing Gunicorn
Installation
============
Requirements
------------
- **Python 2.x >= 2.5** (Python 3.x will be supported soon)
- setuptools >= 0.6c6
- nosetests (for the test suite only)
Installing with easy_install
----------------------------
If you don't already have ``easy_install`` available you'll want to download
and run the ``ez_setup.py`` script::
$ curl -O http://peak.telecommunity.com/dist/ez_setup.py
$ sudo python ez_setup.py -U setuptools
To install or upgrade to the latest released version of Gunicorn::
$ sudo easy_install -U gunicorn
Installing from source
----------------------
You can install Gunicorn from source just as you would install any other
Python package. Gunicorn uses setuptools which will automatically fetch all
dependencies (including setuptools itself).
Get a Copy
++++++++++
You can download a tarball of the latest sources from `GitHub Downloads`_ or
fetch them with git_::
$ git clone git://github.com/benoitc/gunicorn.git
Installation
++++++++++++
::
$ python setup.py install
If you've cloned the git repository, its highly recommended that you use the
``develop`` command which will allow you to use Gunicorn from the source
directory. This will allow you to keep up to date with development on GitHub as
well as make changes to the source::
$ python setup.py develop
Enabling async workers
----------------------
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. Check out the FAQ_ for more information on when you'll
want to consider one of the alternate worker types.
To install eventlet::
$ easy_install -U eventlet
Replace ``eventlet`` with ``gevent`` to use to the ``gevent`` based workers.
.. note::
If you encounter errors when compiling the extensions for Eventlet_ or
Gevent_ you most likely need to install a newer version of libev_.
Installing on Ubuntu/Debian systems
-----------------------------------
If you use Ubuntu_ karmic, you can update your system with packages from
our PPA_ by adding ``ppa:bchesneau/gunicorn`` to your system's Software
Sources.
Or this PPA can be added to your system manually by copying the lines below
and adding them to your system's software sources::
deb http://ppa.launchpad.net/bchesneau/gunicorn/ubuntu karmic main
deb-src http://ppa.launchpad.net/bchesneau/gunicorn/ubuntu karmic main
Signing key::
1024R/15E5EB06
Fingerprint::
49AEEDFF5CDCD82CEA8AB4DABC981A8115E5EB06
.. _`GitHub Downloads`: http://github.com/benoitc/gunicorn/downloads
.. _FAQ: faq.html
.. _git: http://git-scm.com/
.. _Eventlet: http://eventlet.net
.. _Gevent: http://gevent.org
.. _libev: http://software.schmorp.de/pkg/libev.html
.. _Ubuntu: http://www.ubuntu.com/
.. _PPA: https://launchpad.net/~bchesneau/+archive/gunicorn