Installation

Requirements:Python 2.x >= 2.6 or Python 3.x >= 3.1

To install the latest released version of Gunicorn:

$ pip install gunicorn

From Source

You can install Gunicorn from source just as you would install any other Python package:

$ pip install git+https://github.com/benoitc/gunicorn.git

This will allow you to keep up to date with development on GitHub:

$ pip install -U git+https://github.com/benoitc/gunicorn.git

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 design docs for more information on when you’ll want to consider one of the alternate worker types.

$ pip install greenlet  # Required for both
$ pip install eventlet  # For eventlet workers
$ pip install 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.

Debian GNU/Linux

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 different versions of gunicorn with virtualenv. This has a number of advantages:

  • Zero-effort installation: Automatically starts multiple Gunicorn instances based on configurations defined in /etc/gunicorn.d.
  • Sensible default locations for logs (/var/log/gunicorn). Logs can be automatically rotated and compressed using logrotate.
  • Improved security: Can easily run each Gunicorn instance with a dedicated UNIX user/group.
  • Sensible upgrade path: Upgrades to newer versions result in less downtime, handle conflicting changes in configuration options, and can be quickly rolled back in case of incompatibility. The package can also be purged entirely from the system in seconds.

Stable (“wheezy”)

The version of Gunicorn in the Debian “stable” distribution is 0.14.5 (June 2012). You can install it using:

$ sudo apt-get install gunicorn

You can also use the most recent version by using Debian Backports. First, copy the following line to your /etc/apt/sources.list:

deb http://backports.debian.org/debian-backports wheezy-backports main

Then, update your local package lists:

$ sudo apt-get update

You can then install the latest version using:

$ sudo apt-get -t wheezy-backports install gunicorn

Oldstable (“squeeze”)

The version of Gunicorn in the Debian “oldstable” distribution is 0.10.0 (July 2010). It is not recommended that you use this version.

However, you can use the most recent version by using Debian Backports. First, copy the following line to your /etc/apt/sources.list:

deb http://backports.debian.org/debian-backports squeeze-backports main

Then, update your local package lists:

$ sudo apt-get update

You can then install the latest version using:

$ sudo apt-get -t squeeze-backports install gunicorn

Testing (“jessie”) / Unstable (“sid”)

“jessie” and “sid” contain the latest released version of Gunicorn. You can install it in the usual way:

$ sudo apt-get install gunicorn

Ubuntu

If you use Ubuntu, you can update your system with packages from our PPA by adding ppa:gunicorn/ppa to your system’s Software Sources. Use the apt-add-repository command from the python-software-properties package to add the Gunicorn software source.

$ sudo apt-add-repository ppa:gunicorn/ppa

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/gunicorn/ppa/ubuntu lucid main
deb-src http://ppa.launchpad.net/gunicorn/ppa/ubuntu lucid main

Replace lucid with your Ubuntu distribution series.

Signing key:1024R/5370FF2A
Fingerprint:FC7B41B54C9B8476D9EC22A2C6773E575370FF2A