diff --git a/README.md b/README.md index 3278c200..79cf26ef 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,30 @@ This package deploys Postfix and Dovecot servers, including OpenDKIM for DKIM si Postfix uses Dovecot for authentication as described in +## Structure (wip) + +``` + +# package doveauth tool and deploy chatmail server to a envvar-specified ssh-reachable host +deploy.py + +# chatmail pyinfra deploy package +pyinfra-src + pyproject.toml + chatmail/__init__ ... + + # tests against the deployed system + tests/test_online_test.py + +# doveauth tool used by dovecot's auth mechanism on the host system +doveauth-src + README.md + pyproject.toml + doveauth.py + doveauth.lua + test_doveauth.py +``` + ## Ports Postfix listens on ports 25 (smtp) and 587 (submission) and 465 (submissions).