From a24883aa0126eeec8085794994183a1b27aa4e4a Mon Sep 17 00:00:00 2001
From: Antoine Nguyen <tonio@ngyn.org>
Date: Sun, 29 Jun 2014 09:37:37 +0200
Subject: [PATCH] Amavis configuration instructions added.

fix #567
---
 doc/getting_started/plugins.rst | 55 +++++++++++++++++++++++++--------
 1 file changed, 42 insertions(+), 13 deletions(-)

diff --git a/doc/getting_started/plugins.rst b/doc/getting_started/plugins.rst
index 9a395055c..ad1ce99c4 100644
--- a/doc/getting_started/plugins.rst
+++ b/doc/getting_started/plugins.rst
@@ -99,8 +99,46 @@ This plugin provides a simple management frontend for `amavisd-new
    you're planning to use the :ref:`selfservice`, you'll need version
    **2.8.0**.
 
-Database
-========
+Quick Amavis setup
+==================
+
+By default, amavis doesn't use a database. To configure this
+behaviour, you first need to create a dedicated database. This step is a
+bit manual since no *ready-to-use* SQL schema is provided by
+amavis. The information is located inside README files, one for `MySQL
+<http://www.amavis.org/README.sql-mysql.txt>`_ and one for `PostgreSQL
+<http://www.amavis.org/README.sql-pg.txt>`_.
+
+Then, you must tell amavis to use this database for lookups and
+quarantined messages storing. Here is a working configuration sample::
+
+  @lookup_sql_dsn =
+    (['DBI:<driver>:database=<database>;host=<dbhost>;port=<dbport>', '<dbuser>', '<password>]']);
+
+  @storage_sql_dsn =
+    (['DBI:<driver>:database=<database>;host=<dbhost>;port=<dbport>', '<dbuser>', '<password>]']);
+
+  $virus_quarantine_method = 'sql:';
+  $spam_quarantine_method = 'sql:';
+  $banned_files_quarantine_method = 'sql:';
+  $bad_header_quarantine_method = 'sql:';
+
+  $virus_quarantine_to = 'virus-quarantine';
+  $banned_quarantine_to = 'banned-quarantine';
+  $bad_header_quarantine_to = 'bad-header-quarantine';
+  $spam_quarantine_to = 'spam-quarantine';
+
+Replace values between ``<>`` by yours. To know how to configure
+amavis to allow quarantined messages release, read this :ref:`section
+<amavis_release>`.
+
+.. note::
+
+   Amavis configuration allows for separate lookup and storage
+   databases but Modoboa doesn't support it yet.
+
+Connect Modoboa and Amavis
+==========================
 
 You must tell to Modoboa where it can find the amavis
 database. Inside :file:`settings.py`, add a new connection to the
@@ -120,17 +158,6 @@ database. Inside :file:`settings.py`, add a new connection to the
 
 Replace values between ``<>`` with yours.
 
-.. note::
-
-   Modoboa doesn't create amavis tables. You need to install them
-   following the `official documentation
-   <http://www.amavis.org/#doc>`_.
-
-.. note::
-
-   Amavis configuration allows for separate lookup and storage
-   databases but Modoboa doesn't support it yet.
-
 Cleanup
 -------
 
@@ -150,6 +177,8 @@ By default, messages older than 14 days are automatically purged. You
 can modify this value by changing the ``MAX_MESSAGES_AGE`` parameter
 in the online panel.
 
+.. _amavis_release:
+
 Release messages
 ================