Get Modoboa

You can choose between two options:

  • Use the Python package available on the PyPI
  • Download the sources tarball

The easiest one is to install it from the PyPI. Just run the following command and you’re done:

$ pip install modoboa

If you prefer to use the tarball, download the latest one and run the following procedure:

$ tar xzf modoboa-<version>.tar.gz
$ cd modoboa-<version>
$ python install

All dependencies will be installed regardless the way you chose. The only exception concerns the RRDtool binding because there isn’t any python package available, it is directly provided with the official tarball.

Fortunately, all major distributions include a ready-to-use package. On Debian/Ubuntu:

$ apt-get install libcairo2-dev libpango1.0-dev librrd-dev
$ pip install python-rrdtool


Thanks to django, Modoboa supports several databases. Depending on the one you will use, you must install the appropriate python package:

Then, create a user and a database that will be used by Modoboa. Make sure your database is using UTF8 as a default charset.

Deployment, a command line tool, let you deploy a ready-to-use Modoboa site using only one instruction:

$ deploy modoboa_example --syncdb --collectstatic [--with-amavis]

Just answer the few questions and you’re done. You can now go to the First use section.


The –with-amavis option must be set only if you intend to use the Amavisd-new frontend.


If you plan to serve Modoboa using a URL prefix, you must change the value of the LOGIN_URL parameter to LOGIN_URL = '/<prefix>/accounts/login/'.

First use

Your installation should now have a default super administrator:

  • Username: admin
  • Password: password

It is strongly recommended to change this password the first time you log into Modoboa.

To check if your installation works, just launch the embedded HTTP server:

$ python runserver

You should be able to access Modoboa at http://locahost:8000/.

For a production environnement, we recommend using a stable webserver like Apache2 or Nginx.

Project Versions

Table Of Contents

Previous topic

Modoboa’s documentation!

Next topic

Upgrading an existing installation

This Page