An installer for Modoboa
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Updated issue template. Apr 24, 2017
modoboa_installer Created /run/uwsgi folder if not present on CentOS. Nov 29, 2018
.gitignore Initial commit Oct 14, 2015
.travis.yml Added unit test. Oct 8, 2017
LICENSE Initial commit Oct 14, 2015
README.rst Clarified some points in README Sep 14, 2018
run.py Fixed A record definition. Oct 24, 2018
test-requirements.txt Added unit tests. Oct 8, 2017
tests.py OpenDKIM setup. (#196) Apr 2, 2018

README.rst

modoboa-installer

travis codecov

An installer which deploy a complete mail server based on Modoboa.

Warning

This tool is still in beta stage, it has been tested on:

  • Debian Jessie (8) and Stretch (9)
  • Ubuntu Trusty (14.04) and upper
  • CentOS 7

Warning

/tmp partition must be mounted without the noexec option.

Note

The server (physical or virtual) running Modoboa needs at least 2GB of RAM in order to compile the required dependencies during the installation process. Passwords should not contain any special characters as they may cause the installation to fail

Usage:

$ git clone https://github.com/modoboa/modoboa-installer
$ cd modoboa-installer
$ sudo ./run.py <your domain>

A configuration file will be automatically generated the first time you run the installer, please don't copy the installer.cfg.template file manually.

The following components are installed by the installer:

  • Database server (PostgreSQL or MySQL)
  • Nginx and uWSGI
  • Postfix
  • Dovecot
  • Amavis (with SpamAssassin and ClamAV)
  • automx (autoconfiguration service)

If you want to customize configuration before running the installer, run the following command:

$ ./run.py --stop-after-configfile-check <your domain>

An interactive mode is also available:

$ ./run.py --interactive <your domain>

Make your modifications and run the installer as usual.

By default, the latest Modoboa version is installed but you can select a previous one using the --version option:

$ sudo ./run.py --version=X.X.X <your domain>

Note

Version selection is available only for Modoboa >= 1.8.1.

If you want more information about the installation process, add the --debug option to your command line.

Change the generated hostname

By default, the installer will setup your email server using the following hostname: mail.<your domain>. If you want a different value, generate the configuration file like this:

$ ./run.py --stop-after-configfile-check <your domain>

Then edit installer.cfg and look for the following section:

[general]
hostname = mail.%(domain)s

Replace mail by the value you want to use and save your modifications.

Finally, run the installer without the --stop-after-configfile-check option.

Let's Encrypt certificate

Warning

Please note this option requires the hostname you're using to be valid (ie. it can be resolved with a DNS query) and to match the server you're installing Modoboa on.

If you want to generate a valid certificate using Let's Encrypt, edit the installer.cfg file and modify the following settings:

[certificate]
generate = true
type = letsencrypt

[letsencrypt]
email = admin@example.com

Change the email setting to a valid value since it will be used for account recovery.