diff --git a/README.md b/README.md index f6e8273..98bcc91 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,17 @@ A mailing list management system. > https://docs.mailman3.org -This configuration is intended to be used with [mailu](https://git.autonomic.zone/coop-cloud/mailu), assumes the use of a postfix MTA and requires that you share networks and volumes between your Mailu stack and your Mailman3 stack. After installation, you need to run `manage.py createsuperuser` against your `mailman-web` container to create an admin account. +This configuration is intended to be used with a [mailu](https://git.autonomic.zone/coop-cloud/mailu) instance which is setup **on the same VPS**. + +This configuration assumes the following: + +- you have a correctly configured mailu instance (e.g. `mail.example.com`) +- you have a relay domain setup on your mailu side which relays mails (e.g. `lists.example.com`) +- you have an MX and an SPF record setup on your `lists.example.com` for incoming mail +- you have overlay networks configured for both your mailu and mailman stacks (see `SMTP_HOST` and `SMTP_NETWORK` in the [.env.sample](./.env.sample) on the mailman side and `MAILMAN_CORE_NETWORK` [in the mailu config](https://git.autonomic.zone/coop-cloud/mailu/src/branch/main/.env.sample) on the mailu side) +- you have a shared volume between your mailman and mailu stack which exposes the mailman generated aliases which can be fed into an postfix override on the mailu side (see `MAILMAN_CORE_VOLUME` [in the mailu config](https://git.autonomic.zone/coop-cloud/mailu/src/branch/main/.env.sample) on the mailu side) + +More documentation coming after we recover from the diabolical hacking required to get this working.