modoboa 2.6.1__tar.gz → 2.6.3__tar.gz

modoboa-2.6.3/.github/workflows/modoboa.yml

@@ -0,0 +1,233 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Modoboa App
+
+on:
+  push:
+    branches: [ master, 2.3.x ]
+    paths-ignore:
+      - 'modoboa/**.po'
+      - 'frontend/**'
+      - 'doc/**'
+  pull_request:
+    branches: [ master ]
+    paths-ignore:
+      - 'modoboa/**.po'
+      - 'frontend/**'
+      - 'doc/**'
+  release:
+    branches: [ master ]
+    types: [ published ]
+
+env:
+  POSTGRES_HOST: localhost
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    environment: test
+    services:
+      postgres:
+        image: postgres:14
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: modoboa
+        ports:
+        # will assign a random free host port
+        - 5432/tcp
+        # needed because the postgres container does not provide a healthcheck
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+      mysql:
+        image: mariadb:11
+        env:
+          MARIADB_ROOT_PASSWORD: root
+          MARIADB_USER: modoboa
+          MARIADB_PASSWORD: modoboa
+          MARIADB_DATABASE: modoboa
+        ports:
+          - 3306/tcp
+        options: --health-cmd="mariadb-admin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+      redis:
+        image: redis
+        ports:
+          - 6379/tcp
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+      openldap:
+        image: docker.pkg.github.com/modoboa/docker-openldap/docker-openldap
+        ports:
+          - 389/tcp
+        env:
+          LDAP_DOMAIN: example.com
+          LDAP_ADMIN_PASSWORD: test
+        credentials:
+          username: tonioo
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+    strategy:
+      matrix:
+        database: ['postgres', 'mysql']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          sudo apt-get update -y \
+          && sudo apt-get install -y \
+            postfix librrd-dev rrdtool libldap2-dev libsasl2-dev libssl-dev redis-server
+          python -m pip install --upgrade pip
+          pip install -e .[ldap,test,dev]
+          echo "Testing redis connection"
+          redis-cli -h $REDIS_HOST -p $REDIS_PORT ping
+        env:
+          REDIS_HOST: localhost
+          REDIS_PORT: ${{ job.services.redis.ports[6379] }}
+      - name: Install postgres requirements
+        if: ${{ matrix.database == 'postgres' }}
+        run: |
+          pip install -e .[postgresql]
+          pip install coverage
+          echo "DB=postgres" >> $GITHUB_ENV
+      - name: Install mysql requirements
+        if: ${{ matrix.database == 'mysql' }}
+        run: |
+          pip install -e .[mysql]
+          echo "DB=mysql" >> $GITHUB_ENV
+      - name: Run tests
+        if: ${{ matrix.python-version != '3.12' || matrix.database != 'postgres' }}
+        run: |
+          python ./tests.py
+          cd test_project
+          python3 manage.py test modoboa
+        env:
+          # use localhost for the host here because we are running the job on the VM.
+          # If we were running the job on in a container this would be postgres
+          POSTGRES_PORT: ${{ job.services.postgres.ports[5432] }} # get randomly assigned published port
+          MYSQL_HOST: 127.0.0.1
+          MYSQL_PORT: ${{ job.services.mysql.ports[3306] }} # get randomly assigned published port
+          MYSQL_USER: root
+          REDIS_HOST: localhost
+          REDIS_PORT: ${{ job.services.redis.ports[6379] }}
+          LDAP_SERVER_PORT: ${{ job.services.openldap.ports[389] }}
+
+      - name: Start redis sentinel
+        if: ${{ matrix.python-version == '3.12' && matrix.database == 'postgres' }}
+        uses: hoverkraft-tech/compose-action@v2.0.1
+        with:
+          compose-file: "./docker/compose.redis-sentinel.yml"
+
+      - name: Run tests againt redis sentinel
+        if: ${{ matrix.python-version == '3.12' && matrix.database == 'postgres' }}
+        run: |
+          cd test_project
+          coverage run manage.py test modoboa.policyd
+        env:
+          POSTGRES_PORT: ${{ job.services.postgres.ports[5432] }}
+          REDIS_SENTINEL: 1
+          REDIS_SENTINEL_HOST: localhost
+          REDIS_SENTINEL_PORT: 26379
+          REDIS_MASTER: mymaster
+          OIDC_RSA_PRIVATE_KEY: ${{ vars.OIDC_RSA_PRIVATE_KEY }}
+
+      - name: Run tests and coverage
+        if: ${{ matrix.python-version == '3.12' && matrix.database == 'postgres' }}
+        run: |
+          python ./tests.py
+          cd test_project
+          coverage run manage.py test modoboa
+          coverage combine
+          coverage xml
+          coverage report
+        env:
+          # use localhost for the host here because we are running the job on the VM.
+          # If we were running the job on in a container this would be postgres
+          POSTGRES_PORT: ${{ job.services.postgres.ports[5432] }} # get randomly assigned published port
+          MYSQL_HOST: 127.0.0.1
+          MYSQL_PORT: ${{ job.services.mysql.ports[3306] }} # get randomly assigned published port
+          MYSQL_USER: root
+          REDIS_HOST: localhost
+          REDIS_PORT: ${{ job.services.redis.ports[6379] }}
+          LDAP_SERVER_PORT: ${{ job.services.openldap.ports[389] }}
+
+      - name: Upload coverage result
+        if: ${{ matrix.python-version == '3.12' && matrix.database == 'postgres' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-results
+          path: test_project/coverage.xml
+
+  coverage:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download coverage results
+        uses: actions/download-artifact@v4
+        with:
+          name: coverage-results
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4.5.0
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml
+
+  release:
+    if: github.event_name != 'pull_request'
+    needs: coverage
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    environment:
+      name: pypi
+      url: https://pypi.org/p/modoboa
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - name: Build frontend
+        shell: bash -l {0}
+        run: |
+          sudo apt-get install gettext
+          cd frontend
+          nvm install 20
+          yarn install
+          yarn gettext:compile
+          yarn build
+          cd ..
+      - name: Build packages
+        run: |
+          sudo apt-get install librrd-dev rrdtool libssl-dev
+          python -m pip install --upgrade "pip!=25.3" build pip-tools
+          pip-compile -o requirements.txt pyproject.toml
+          pip install -r requirements.txt
+          cd modoboa
+          django-admin compilemessages
+          cd ..
+          python -m build
+      - name: Publish to Test PyPI
+        if: endsWith(github.event.ref, '/master')
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          verbose: true
+          skip-existing: true
+      - name: Publish distribution to PyPI
+        if: startsWith(github.event.ref, 'refs/tags') || github.event_name == 'release'
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true

modoboa-2.6.3/PKG-INFO

@@ -0,0 +1,192 @@
+Metadata-Version: 2.4
+Name: modoboa
+Version: 2.6.3
+Summary: Mail hosting made simple
+Author-email: Antoine Nguyen <tonio@ngyn.org>
+License: ISC License
+        
+        Copyright (c) 2009-2025, 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.8
+Requires-Dist: django-phonenumber-field[phonenumbers]==8.3.0
+Requires-Dist: django-reversion==6.0.0
+Requires-Dist: django-xforwardedfor-middleware==2.0
+Requires-Dist: django-otp==1.6.3
+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==4.3.0
+Requires-Dist: asgiref
+Requires-Dist: dnspython==2.8.0
+Requires-Dist: feedparser==6.0.12
+Requires-Dist: fido2==2.0.0
+Requires-Dist: gevent==25.9.1
+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.1.2
+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 is 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