modoboa 2.4.10__tar.gz → 2.5.0__tar.gz

modoboa-2.5.0/.dockerignore

@@ -0,0 +1,12 @@
+build
+dist
+frontend/node_modules
+modoboa.egg-info
+docker/mariadb
+
+.tox
+
+**/.python-version
+**/__pycache__
+**/*.pyc
+**/.ropeproject

modoboa-2.5.0/.gitignore

@@ -0,0 +1,46 @@
+.*~$
+*.pyc
+*.mo
+*.db
+modoboa.egg-info
+doc/.build
+doc/.static
+doc/.templates
+DEV
+.idea
+.ropeproject
+modoboa.iml
+.tox
+.eggs/
+modoboa_test
+bin/instance
+.coverage
+./build/
+dist/
+modoboa/frontend_dist
+# JS stuff
+node_modules
+/static/dist
+/frontend/webpack-stats.json
+/frontend/src/translations.json
+/frontend/.__mf__temp/
+
+# TOX stuff
+test_project/modoboa.db
+
+/.project
+/.pydevproject
+
+# Misc
+.ash_history
+modoboa.kdev4
+.kateproject
+test_project/cert.crt
+test_project/cert.key
+test_project/envfile
+test_project/media
+
+# Docker
+docker/collections
+docker/redis
+docker/mariadb

modoboa-2.5.0/PKG-INFO

@@ -0,0 +1,192 @@
+Metadata-Version: 2.4
+Name: modoboa
+Version: 2.5.0
+Summary: Mail hosting made simple
+Author-email: Antoine Nguyen <tonio@ngyn.org>
+License: ISC License
+        
+        Copyright (c) 2009-2023, Antoine Nguyen <tonio@ngyn.org>
+        
+        Permission to use, copy, modify, and/or distribute this software for any
+        purpose with or without fee is hereby granted, provided that the above
+        copyright notice and this permission notice appear in all copies.
+        
+        THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+        WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+        MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+        ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+        WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+        ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+        OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+        
+Project-URL: Homepage, http://modoboa.org/
+Project-URL: Documentation, https://modoboa.readthedocs.io/en/latest/
+Project-URL: Repository, https://github.com/modoboa/modoboa
+Project-URL: Changelog, https://github.com/modoboa/modoboa/blob/master/CHANGELOG.md
+Project-URL: Issues, https://github.com/modoboa/modoboa/issues
+Keywords: email
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django :: 5.2
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: ISC License (ISCL)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Communications :: Email
+Classifier: Topic :: Internet :: WWW/HTTP
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: django==5.2.6
+Requires-Dist: django-phonenumber-field[phonenumbers]==8.1.0
+Requires-Dist: django-reversion==5.1.0
+Requires-Dist: django-xforwardedfor-middleware==2.0
+Requires-Dist: django-otp==1.6.1
+Requires-Dist: django-filter
+Requires-Dist: django-rename-app==0.1.7
+Requires-Dist: django-environ
+Requires-Dist: dj-database-url
+Requires-Dist: djangorestframework<3.17,>=3.16
+Requires-Dist: drf-spectacular
+Requires-Dist: uritemplate
+Requires-Dist: django-oauth-toolkit
+Requires-Dist: django-cors-headers
+Requires-Dist: passlib~=1.7.4
+Requires-Dist: bcrypt
+Requires-Dist: asgiref
+Requires-Dist: dnspython==2.8.0
+Requires-Dist: feedparser==6.0.11
+Requires-Dist: fido2==2.0.0
+Requires-Dist: gevent==25.8.2
+Requires-Dist: progressbar33==2.4
+Requires-Dist: python-dateutil
+Requires-Dist: cryptography
+Requires-Dist: pytz
+Requires-Dist: requests
+Requires-Dist: lxml_html_clean
+Requires-Dist: chardet
+Requires-Dist: ovh
+Requires-Dist: oath
+Requires-Dist: packaging
+Requires-Dist: redis>=4.2.0rc1
+Requires-Dist: rrdtool-bindings>=0.2.0
+Requires-Dist: qrcode
+Requires-Dist: aiosmtplib
+Requires-Dist: reportlab
+Requires-Dist: tldextract>=2.0.2
+Requires-Dist: defusedxml>=0.6.0
+Requires-Dist: python-magic>=0.4.24
+Requires-Dist: rq>=1.13.0
+Requires-Dist: django-rq
+Requires-Dist: sievelib>=1.4.1
+Requires-Dist: drf-nested-routers
+Requires-Dist: vobject
+Requires-Dist: caldav==2.0.1
+Requires-Dist: html2text
+Requires-Dist: idna
+Provides-Extra: dev
+Requires-Dist: django-debug-toolbar; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: django-extensions; extra == "dev"
+Requires-Dist: Werkzeug; extra == "dev"
+Requires-Dist: pyOpenSSL; extra == "dev"
+Provides-Extra: mysql
+Requires-Dist: mysqlclient<2.2.8; extra == "mysql"
+Provides-Extra: postgresql
+Requires-Dist: psycopg[binary]>=3.1; extra == "postgresql"
+Provides-Extra: test
+Requires-Dist: argon2-cffi>=16.1.0; extra == "test"
+Requires-Dist: factory-boy<3.4.0; extra == "test"
+Requires-Dist: httmock==1.4.0; extra == "test"
+Requires-Dist: testfixtures==8.3.0; extra == "test"
+Requires-Dist: tox; extra == "test"
+Provides-Extra: ldap
+Requires-Dist: django-auth-ldap<6.0.0; extra == "ldap"
+Dynamic: license-file
+
+############################################
+Modoboa (`website <https://modoboa.org/>`_)
+############################################
+
+|workflow| |codecov| |latest-version|
+
+`Modoboa <https://modoboa.org>`_ is a mail hosting and management platform including a modern
+and simplified Web User Interface. It provides useful components such
+as an administration panel and webmail.
+
+Modoboa integrates with well known software such as `Postfix
+<http://postfix.org/>`_ or `Dovecot <http://dovecot.org/>`_. A SQL
+database (`MySQL <http://www.mysql.com>`_, `PostgreSQL
+<http://www.postgresql.org/>`_ or `SQLite <http://www.sqlite.org>`_)
+is used as a central point of communication between all components.
+
+Modoboa is developed with modularity in mind, expanding it is really
+easy. Actually, all current features are extensions.
+
+It is written in Python 3 and uses the `Django
+<https://www.djangoproject.com>`_ and `Vue <https://vuejs.org/>`_
+frameworks.
+
+*************
+Main features
+*************
+
+* Administration panel
+* Reputation protection: `DNSBL <https://en.wikipedia.org/wiki/DNSBL>`_ checks, `DMARC <https://dmarc.org/>`_ `reports <https://github.com/modoboa/modoboa-dmarc>`_ and more
+* `Amavis <http://www.amavis.org>`_ `frontend <https://github.com/modoboa/modoboa-amavis>`_
+* Webmail 
+* Calendar
+* Address book
+* Per-user Sieve filters
+* Autoreply messages 
+* Graphical statistics about email traffic
+
+************
+Installation
+************
+
+The easiest way to install modoboa is to use the
+`official installer <https://github.com/modoboa/modoboa-installer>`_.
+More information is available in the documentation.
+
+*************
+Documentation
+*************
+
+A detailed `documentation <https://modoboa.readthedocs.io/>`_ will help you
+to install, use or extend Modoboa.
+
+*****************
+Demo Installation
+*****************
+
+If you want to try out Modoboa, check out our `demo installation <https://demo.modoboa.org/>`_.
+
+************
+Getting help
+************
+
+Modoboa is a free software and is totally open source BUT you can hire the team if you need professional services. More information here: https://modoboa.org/en/professional-services/.
+
+Contracting a support plan if a good way to ensure your installation stays available and up-to-date and it will help the project to be sustainable :)
+
+*********
+Community
+*********
+
+If you have any questions, you can get help through the following platforms:
+
+* `Discord <https://discord.gg/WuQ3v3PXGR>`_
+* Github: open an issue if you found a bug
+
+.. |latest-version| image:: https://img.shields.io/pypi/v/modoboa.svg
+   :target: https://pypi.python.org/pypi/modoboa/
+   :alt: Latest version on Pypi
+.. |workflow| image:: https://github.com/modoboa/modoboa/actions/workflows/modoboa.yml/badge.svg
+.. |codecov| image:: https://codecov.io/gh/modoboa/modoboa/graph/badge.svg?token=1E5eBxJO33
+   :target: https://codecov.io/gh/modoboa/modoboa

modoboa-2.5.0/doc/index.rst

@@ -0,0 +1,43 @@
+.. Modoboa documentation master file, created by
+   sphinx-quickstart on Mon Jan  3 22:29:25 2011.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Modoboa documentation
+=====================
+
+.. image:: _static/modoboa_logo.png
+   :align: center
+
+Overview
+--------
+
+Modoboa is a mail hosting and management platform including a modern
+and simplified Web User Interface designed to work with `Postfix
+<http://www.postfix.org>`_ and `Dovecot <http://www.dovecot.org>`_.
+
+And it is extensible by nature and comes with a lot of additional extensions:
+
++---------------------------------------------------------+-------------------------+------------------------------------------------------+
+|Name                                                     |Description              |Documentation                                         |
+|                                                         |                         |                                                      |
+|                                                         |                         |                                                      |
+|                                                         |                         |                                                      |
++---------------------------------------------------------+-------------------------+------------------------------------------------------+
+|`modoboa-pfxadmin-migrate                                |A tool to migrate from   |https://github.com/modoboa/modoboa-pfxadmin-migrate   |
+|<https://github.com/modoboa/modoboa-pfxadmin-migrate>`_  |Postfixadmin             |                                                      |
++---------------------------------------------------------+-------------------------+------------------------------------------------------+
+
+Table of contents
+-----------------
+
+.. toctree::
+   :maxdepth: 1
+
+   installation
+   upgrade
+   configuration
+   moving
+   rest_api
+   contributing
+   contributors

modoboa-2.5.0/doc/installation.rst

@@ -0,0 +1,101 @@
+############
+Installation
+############
+
+Requirements
+===============
+You will need a Server to perform well with at least:
+
+* CPU: 2
+* RAM: 2GB
+* Disk: 10GB
+* Python 3.8+
+* Postgres 12+ or MariaDB 10.4+ or MySQL 8+ or sqlite3 or LDAP
+
+.. note:: **👀 Heads up for modoboa versions 1.15 and later**
+
+   Python 2 support has been dropped with modoboa version 1.15.
+   If you still have Python 2 installed on your system either uninstall it
+   or force modoboa user to run with Python 3.
+
+If you want to run virus scan on your server you will need **4GB** of RAM.
+
+Recommended way
+===============
+
+If you start from scratch and want to deploy a complete mail server,
+you will love the `modoboa installer
+<https://github.com/modoboa/modoboa-installer>`_! It is the easiest
+and the quickest way to setup a fully functional server (modoboa,
+postfix, dovecot, amavis and more) on one machine.
+
+.. warning::
+
+   For now, only Debian based Linux distributions are
+   supported. We do our best to improve compatibility but if you use
+   another Linux or a UNIX system, you will have to install Modoboa
+   :ref:`manually <by_hand>`.
+
+To use it, just run the following commands in your terminal:
+
+.. sourcecode:: bash
+
+  > git clone https://github.com/modoboa/modoboa-installer
+  > cd modoboa-installer
+  > sudo ./run.py <your domain>
+
+
+if you get this warning - '/usr/bin/env: ‘python’: No such file or directory', do make sure sure python is installed on your server. Sometimes python is installed but the installer can't detect it or which python version to run, especially on a debian based system. Then run this command first.
+
+.. sourcecode:: bash
+
+   > sudo apt-get install python3-virtualenv python3-pip
+
+For the sake of simplicity, you can also install the ``python-is-python3`` package.
+It allows you to use ``python`` command.
+
+Wait a few minutes and you're done \o/
+
+.. _by_hand:
+
+Manual installation
+===================
+
+For those who need a manual installation or who just want to setup a
+specific part, here are the steps you must follow:
+
+.. toctree::
+   :maxdepth: 1
+
+   manual_installation/modoboa
+   manual_installation/webserver
+   manual_installation/dovecot
+   manual_installation/postfix
+   manual_installation/opendkim
+   manual_installation/radicale
+   manual_installation/amavis
+
+Extensions
+----------
+
+Only few commands are needed to add a new extension to your setup.
+
+In case you use a dedicated user and/or a virtualenv, do not forget to
+use them:
+
+.. sourcecode:: bash
+
+   > sudo -u <modoboa_user> -i bash
+   > source <virtuenv_path>/bin/activate
+
+Then, run the following commands:
+
+.. sourcecode:: bash
+
+   > pip install <EXTENSION>==<VERSION>
+   > cd <modoboa_instance_dir>
+   > python manage.py migrate
+   > python manage.py collectstatic
+   > python manage.py check --deploy
+
+Then, restart your web server.

modoboa-2.5.0/doc/manual_installation/amavis.rst

@@ -0,0 +1,292 @@
+######
+Amavis
+######
+
+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>]']);
+
+  # PostgreSQL users NEED this parameter!
+  # MySQL users only need this parameter is email addresses are stored
+  # using the VARBINARY type.
+  $sql_allow_8bit_address = 1;
+
+  $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.
+
+.. note::
+
+   ``$sql_partition_tag`` should remain undefined in ``amavisd.conf``. Modoboa
+   does not support the use of ``sql_partition_tag``, setting this value can
+   result in quarantined messages not showing or the wrong messages being
+   released or learnt as ham/spam.
+
+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 lets 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::
+
+  https://<modoboa_url>/user/selfquarantine/%i/%R?secret_id=[:secret_id]
+
+.. _sa_manual_learning:
+
+Manual SpamAssassin learning
+============================
+
+It is possible to manually train `SpamAssassin
+<http://spamassassin.apache.org/>`_ using the quarantine's content. By
+train, we mean:
+
+* Mark message(s) as spam (false negative(s))
+
+* Mark message(s) as non-spam (false positive(s))
+
+This feature is available to all users (from super administrators to
+simple users) but not enabled by default.
+
+SpamAssassin configuration
+--------------------------
+
+For better performance and to enable the per-user level, SpamAssassin
+must store bayes information into a SQL database.
+
+Create a new database and a new user/password (using your favorite
+database server) and edit the default configuration file
+(:file:`/etc/spamassassin/local.cf`) to add the following lines
+inside:
+
+.. sourcecode:: perl
+
+  bayes_store_module    Mail::SpamAssassin::BayesStore::<Driver>
+  bayes_sql_dsn         <DSN>
+  bayes_sql_username    <db username>
+  bayes_sql_password    <db password>
+
+Replace values between ``<>`` by yours. Possible values for ``Driver``
+are ``PgSQL`` or ``MySQL`` (non exhaustive list). The syntax for
+``DSN`` depends on the driver you choose. Please consult the official
+documentation.
+
+Enable the feature through Modoboa
+----------------------------------
+
+Manual learning is disabled by default. You can activate it through
+the administration panel (*Modoboa > Paremeters > Amavis*). There two
+learning levels:
+
+#. Global: available to administrators only. A single (global) bayes
+   database is shared between everyone.
+
+#. Per domain: available to administrators and domain
+   administrators. Each domain can have a dedicated database.
+
+#. Per user: each user can create its own database to customize the
+   way SpamAssassin will detect spam.
+
+The domain and user levels are not activated by default, dedicated
+parameters are available through the panel.
+
+.. note::
+
+   Domain and user databases are only created the first time someone
+   calls the learning feature through the quarantine.
+
+.. warning::
+
+   A bayes database needs to reach pre-defined thresholds before it
+   can be used by SpamAssassin. The default values are **200** spams
+   and **200** hams.
+
+You will find other paramaters related to this feature. You won't need
+to change them most of the time, unless SpamAssassin is hosted on a
+different machine than Modoboa. (in this case, ``spamc`` will be used
+instead of ``sa-learn``).