diff --git a/README.md b/README.md index 480f2d6..9cd0d5b 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,17 @@ A mailing list management system. > https://docs.mailman3.org -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**. +## Mailu integration + +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` and the remote host is your `mailman-core` service hostname, see following setups below for more on the shared network configuration) +- 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` and the remote host is your `mailman-core` service hostname, see following setups below for more on the shared network configuration) - 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) +- you have overlay networks configured for both your Mailu and Mailman3 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 Mailman3 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.