django-postfix-dovecot-api/README.md

django-postfix-dovecot-api

REST API for managing the virtual domains, users and aliases that Postfix and Dovecot read from the database. Used by mailadmin.

Development

mise install
uv sync
prek install
uv run python manage.py migrate
uv run python manage.py runserver
uv run pytest

API docs are served at /api/docs. Override settings (database, secret key, Sentry) in dpdapisite/local_settings.py.

Deployment

CI builds an image for each push to main and deploys it to lynx while the repository variable DEPLOY_LYNX is true. The image reads its settings from the environment (dpdapisite/settings_prod.py).