mirror of
https://github.com/jwinterm/modoboa.git
synced 2026-10-18 05:51:26 +02:00
230 lines
8.1 KiB
ReStructuredText
230 lines
8.1 KiB
ReStructuredText
.. _amavis_frontend:
|
|
|
|
####################
|
|
Amavisd-new frontend
|
|
####################
|
|
|
|
This plugin provides a simple management frontend for `amavisd-new
|
|
<http://www.amavis.org>`_. The supported features are:
|
|
|
|
* SQL quarantine management : available to administrators or users,
|
|
possibility to delete or release messages
|
|
* Per domain customization (using policies): specify how amavisd-new
|
|
will handle traffic
|
|
|
|
.. note::
|
|
|
|
The per-domain policies feature only works for new
|
|
installations. Currently, you can't use modoboa with an existing
|
|
database (ie. with data in ``users`` and ``policies`` tables).
|
|
|
|
.. note::
|
|
|
|
This plugin requires amavisd-new version **2.7.0** or higher. If
|
|
you're planning to use the :ref:`selfservice`, you'll need version
|
|
**2.8.0**.
|
|
|
|
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
|
|
``DATABASES`` variable like this::
|
|
|
|
DATABASES = {
|
|
# Stuff before
|
|
#
|
|
"amavis": {
|
|
"ENGINE" : "<your value>",
|
|
"HOST" : "<your value>",
|
|
"NAME" : "<your value>",
|
|
"USER" : "<your value>",
|
|
"PASSWORD" : "<your value>"
|
|
}
|
|
}
|
|
|
|
Replace values between ``<>`` with yours.
|
|
|
|
Cleanup
|
|
-------
|
|
|
|
Storing quarantined messages to a database can quickly become a
|
|
perfomance killer. Modoboa provides a simple script to periodically
|
|
purge the quarantine database. To use it, add the following line
|
|
inside root's crontab::
|
|
|
|
0 0 * * * <modoboa_site>/manage.py qcleanup
|
|
#
|
|
# Or like this if you use a virtual environment:
|
|
# 0 0 * * * <virtualenv path/bin/python> <modoboa_site>/manage.py qcleanup
|
|
|
|
Replace ``modoboa_site`` with the path of your Modoboa instance.
|
|
|
|
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
|
|
================
|
|
|
|
To release messages, first take a look at `this page
|
|
<http://www.ijs.si/software/amavisd/amavisd-new-docs.html#quar-release>`_. It
|
|
explains how to configure amavisd-new to listen somewhere for the
|
|
AM.PDP protocol. This protocol is used to send requests.
|
|
|
|
Below is an example of a working configuration::
|
|
|
|
$interface_policy{'SOCK'} = 'AM.PDP-SOCK';
|
|
$interface_policy{'9998'} = 'AM.PDP-INET';
|
|
|
|
$policy_bank{'AM.PDP-SOCK'} = {
|
|
protocol => 'AM.PDP',
|
|
auth_required_release => 0,
|
|
};
|
|
$policy_bank{'AM.PDP-INET'} = {
|
|
protocol => 'AM.PDP',
|
|
inet_acl => [qw( 127.0.0.1 [::1] )],
|
|
};
|
|
|
|
Don't forget to update the ``inet_acl`` list if you plan to release from
|
|
the network.
|
|
|
|
Once amavisd-new is configured, just tell Modoboa where it can find
|
|
the *release server* by modifying the following parameters in the
|
|
online panel:
|
|
|
|
+--------------------+--------------------+------------------------+
|
|
|Name |Description |Default value |
|
|
+====================+====================+========================+
|
|
|Amavis connection |Mode used to access |unix |
|
|
|mode |the PDP server | |
|
|
+--------------------+--------------------+------------------------+
|
|
|PDP server address |PDP server address |localhost |
|
|
| |(if inet mode) | |
|
|
+--------------------+--------------------+------------------------+
|
|
|PDP server port |PDP server port (if | |
|
|
| |inet mode) 9998 | |
|
|
+--------------------+--------------------+------------------------+
|
|
|PDP server socket |Path to the PDP |/var/amavis/amavisd.sock|
|
|
| |server socket (if | |
|
|
| |unix mode) | |
|
|
+--------------------+--------------------+------------------------+
|
|
|
|
Deferred release
|
|
----------------
|
|
|
|
By default, simple users are not allowed to release messages
|
|
themselves. They are only allowed to send release requests to
|
|
administrators.
|
|
|
|
As administrators are not always available or logged into Modoboa, a
|
|
notification tool is available. It sends reminder e-mails to every
|
|
administrators or domain administrators. To use it, add the following
|
|
example line to root's crontab::
|
|
|
|
0 12 * * * <modoboa_site>/manage.py amnotify --baseurl='<modoboa_url>'
|
|
#
|
|
# Or like this if you use a virtual environment:
|
|
# 0 12 * * * <virtualenv path/bin/python> <modoboa_site>/manage.py amnotify --baseurl='<modoboa_url>'
|
|
|
|
You are free to change the frequency.
|
|
|
|
.. note::
|
|
|
|
If you want to let users release their messages alone (not
|
|
recommended), go to the admin panel.
|
|
|
|
The following parameters are available to let you customize this
|
|
feature:
|
|
|
|
+--------------------+--------------------+------------------------+
|
|
|Name |Description |Default value |
|
|
+====================+====================+========================+
|
|
|Check requests |Interval between two|30 |
|
|
|interval |release requests | |
|
|
| |checks | |
|
|
+--------------------+--------------------+------------------------+
|
|
|Allow direct release|Allow users to |no |
|
|
| |directly release | |
|
|
| |their messages | |
|
|
+--------------------+--------------------+------------------------+
|
|
|Notifications sender|The e-mail address |notification@modoboa.org|
|
|
| |used to send | |
|
|
| |notitications | |
|
|
+--------------------+--------------------+------------------------+
|
|
|
|
.. _selfservice:
|
|
|
|
Self-service mode
|
|
=================
|
|
|
|
The *self-service* mode let users act on quarantined messages without
|
|
beeing authenticated. They can:
|
|
|
|
* View messages
|
|
* Remove messages
|
|
* Release messages (or send release requests)
|
|
|
|
To access a specific message, they only need the following information:
|
|
|
|
* Message's unique identifier
|
|
* Message's secret identifier
|
|
|
|
This information is controlled by *amavis*, which is in charge of
|
|
notifying users when new messages are put into quarantine. Each
|
|
notification (one per message) must embark a direct link containing
|
|
the required identifiers.
|
|
|
|
To activate this feature, go the administration panel and set the
|
|
**Enable self-service mode** parameter to yes.
|
|
|
|
The last step is to customize the notification messages amavis
|
|
sends. The most important is to embark a direct link. Take a look at
|
|
the `README.customize <http://amavis.org/README.customize.txt>`_ file to
|
|
learn what you're allowed to do.
|
|
|
|
Here is a link example::
|
|
|
|
http://<modoboa_url>/quarantine/%i/?rcpt=%R&secret_id=[:secret_id]
|
|
|