From 8c46bbd9494b9d78eb235099b6464747dab14706 Mon Sep 17 00:00:00 2001 From: Antoine Nguyen Date: Fri, 7 Jul 2017 18:34:06 +0200 Subject: [PATCH] Added documentation. see #138 --- README.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 978e460..91df716 100644 --- a/README.rst +++ b/README.rst @@ -31,13 +31,14 @@ A configuration file will be automatically generated the first time you run the installer, please don't copy the ``installer.cfg.template`` file manually. -By default, the following components are installed: +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:: @@ -46,6 +47,15 @@ run the following command:: 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 + +.. 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.