Metadata-Version: 2.1
Name: modoboa-amavis
Version: 1.4.0
Summary: The amavis frontend of Modoboa
Home-page: http://modoboa.org/
Author: Antoine Nguyen
Author-email: tonio@ngyn.org
License: MIT
Keywords: email amavis spamassassin
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django :: 2.2
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Communications :: Email
Classifier: Topic :: Internet :: WWW/HTTP
License-File: LICENSE

modoboa-amavis
==============

|gha| |codecov|

The `amavis <http://www.amavis.org/>`_ frontend of Modoboa.

Installation
------------

Install this extension system-wide or inside a virtual environment by
running the following command::

  $ pip install modoboa-amavis

Edit the settings.py file of your modoboa instance and add
``modoboa_amavis`` inside the ``MODOBOA_APPS`` variable like this::

    MODOBOA_APPS = (
        'modoboa',
        'modoboa.core',
        'modoboa.lib',
        'modoboa.admin',
        'modoboa.relaydomains',
        'modoboa.limits',
        'modoboa.parameters',
        # Extensions here
        # ...
        'modoboa_amavis',
    )

Then, add the following at the end of the file::

  from modoboa_amavis import settings as modoboa_amavis_settings
  modoboa_amavis_settings.apply(globals())

Run the following commands to setup the database tables::

  $ cd <modoboa_instance_dir>
  $ python manage.py migrate
  $ python manage.py collectstatic
  $ python manage.py load_initial_data

Finally, restart the python process running modoboa (uwsgi, gunicorn,
apache, whatever).

Note
----
Notice that if you dont configure amavis and its database, Modoboa
won't work. Check `docs/setup` for more information.

.. |gha| image:: https://github.com/modoboa/modoboa-amavis/actions/workflows/plugin.yml/badge.svg
   :target: https://github.com/modoboa/modoboa-amavis/actions/workflows/plugin.yml

.. |codecov| image:: https://codecov.io/gh/modoboa/modoboa-amavis/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/modoboa/modoboa-amavis


