diff --git a/doc/getting_started/configuration.rst b/doc/getting_started/configuration.rst index c56271a05..d7050cc34 100644 --- a/doc/getting_started/configuration.rst +++ b/doc/getting_started/configuration.rst @@ -66,6 +66,14 @@ The *admin* application exposes several parameters, they are presented below: | |is specified | | +--------------------+--------------------+--------------------+ +.. note:: + + If you are not familiar with virtual domain hosting, you should + take a look at `postfix's documentation + `_. This `How to + `_ + also contains useful information. + .. note:: A random secret key will be generated each time the *Parameters* @@ -297,6 +305,9 @@ online panel. To use it, you can setup a cron job to run every night:: 0 0 * * * /manage.py cleanlogs + # + # Or like this if you use a virtual environment: + # 0 0 * * * /manage.py cleanlogs Cleaning the session table ========================== @@ -311,3 +322,6 @@ cleanup``. That script deletes any session in the session table whose For example, you could setup a cron job to run this script every night:: 0 0 * * * /manage.py cleanup + # + # Or like this if you use a virtual environment: + # 0 0 * * * /manage.py cleanup diff --git a/doc/getting_started/install.rst b/doc/getting_started/install.rst index 8a5afff43..0d7c6bce6 100644 --- a/doc/getting_started/install.rst +++ b/doc/getting_started/install.rst @@ -155,8 +155,9 @@ server:: You should be able to access Modoboa at http://localhost:8000/. -For a fully working interface using the embedded HTTP server, you need to set the ``DEBUG`` -parameter in settings.py to ``True``. +For a fully working interface using the embedded HTTP server, you need +to set the ``DEBUG`` parameter in settings.py to ``True``. For a production environment, we recommend using a stable webserver -like :ref:`apache2` or :ref:`nginx-label`. Don't forget to set ``DEBUG`` back to ``False``. +like :ref:`apache2` or :ref:`nginx-label`. Don't forget to set +``DEBUG`` back to ``False``. diff --git a/doc/getting_started/plugins.rst b/doc/getting_started/plugins.rst index 61556029e..9a395055c 100644 --- a/doc/getting_started/plugins.rst +++ b/doc/getting_started/plugins.rst @@ -140,6 +140,9 @@ purge the quarantine database. To use it, add the following line inside root's crontab:: 0 0 * * * /manage.py qcleanup + # + # Or like this if you use a virtual environment: + # 0 0 * * * /manage.py qcleanup Replace ``modoboa_site`` with the path of your Modoboa instance. @@ -206,6 +209,9 @@ administrators or domain administrators. To use it, add the following example line to root's crontab:: 0 12 * * * /manage.py amnotify --baseurl='' + # + # Or like this if you use a virtual environment: + # 0 12 * * * /manage.py amnotify --baseurl='' You are free to change the frequency. @@ -279,7 +285,7 @@ files (see `rrdtool `_) and then generates graphics in PNG format. To use it, go to the online parameters panel and adapt the following -ones to your environnement: +ones to your environment: +--------------------+--------------------+--------------------------+ |Name |Description |Default value | @@ -307,6 +313,9 @@ To finish, you need to collect information periodically in order to feed the RRD files. Add the following line into root's crontab:: */5 * * * * /manage.py logparser &> /dev/null + # + # Or like this if you use a virtual environment: + # 0/5 * * * * /manage.py logparser &> /dev/null Replace ```` with the path of your Modoboa instance. diff --git a/doc/getting_started/upgrade.rst b/doc/getting_started/upgrade.rst index fde360a62..fb1643141 100644 --- a/doc/getting_started/upgrade.rst +++ b/doc/getting_started/upgrade.rst @@ -560,7 +560,7 @@ requires a migration. $ python manage.py migrate admin -#. Update SQL queries used in your environnement (see +#. Update SQL queries used in your environment (see :ref:`postfix` or :ref:`dovecot`). #. Update Postfix configuration so that it can handle domain aliases