modoboa 2.4.11__tar.gz → 2.5.1__tar.gz

modoboa-2.5.1/.dockerignore

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

modoboa-2.5.1/.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.1/PKG-INFO

@@ -0,0 +1,192 @@
+Metadata-Version: 2.4
+Name: modoboa
+Version: 2.5.1
+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.1/doc/conf.py

@@ -0,0 +1,226 @@
+#
+# Modoboa documentation build configuration file, created by
+# sphinx-quickstart on Mon Jan  3 22:29:25 2011.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+from unittest.mock import Mock as MagicMock
+import sys
+
+
+class Mock(MagicMock):
+    @classmethod
+    def __getattr__(cls, name):
+        return MagicMock()
+
+
+MOCK_MODULES = ["rrdtool"]
+sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+# sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+    "sphinx.ext.intersphinx",
+    "sphinx_rtd_theme",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = [".templates"]
+
+# The suffix of source filenames.
+source_suffix = ".rst"
+
+# The encoding of source files.
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = "index"
+
+# General information about the project.
+project = "Modoboa"
+copyright = "2025, Antoine Nguyen"  # NOQA:A001
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = "2.5.0"
+# The full version, including alpha/beta/rc tags.
+release = "2.5.0"
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+# language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+# today = ''
+# Else, today_fmt is used as the format for a strftime call.
+# today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = [".build"]
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+# add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+
+html_theme = "sphinx_rtd_theme"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+# html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+# html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+# html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+# html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+# html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+# html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+# html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+# html_domain_indices = True
+
+# If false, no index is generated.
+# html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+# html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+# html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+# html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+# html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "Modoboadoc"
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+# latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+# latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+    ("index", "Modoboa.tex", "Modoboa Documentation", "Antoine Nguyen", "manual"),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+# latex_use_parts = False
+
+# If true, show page references after internal links.
+# latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+# latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+# latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+# latex_appendices = []
+
+# If false, no module index is generated.
+# latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [("index", "modoboa", "Modoboa Documentation", ["Antoine Nguyen"], 1)]

modoboa-2.5.1/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.1/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.