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 greenlet  # Required for both
$ easy_install -U eventlet  # For eventlet workers
$ easy_install -U gevent    # For gevent workers

Note

If installing greenlet fails you probably need to install the Python headers. These headers are available in most package managers. On Ubuntu the package name for apt-get is python-dev.

Gevent also requires that libevent 1.4.x or 2.0.4 is installed. This could be a more recent version than what is available in your package manager. If Gevent fails to build even with libevent installed, this is the most likely reason.

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