mailman3/README.md

# mailman3

> https://docs.mailman3.org

A mailing list management system.

<!-- metadata -->

- **Category**:
- **Status**:
- **Image**: [`maxking/mailman-*`](https://github.com/maxking/docker-mailman)
- **Healthcheck**:
- **Backups**:
- **Email**:
- **Tests**:
- **SSO**:

<!-- endmetadata -->

## 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**. A shared volume (Mailman core generated aliases for mail delivery) and a shared network (Mailu and Mailman can then see each other) are used to ensure that the postfix service in the Mailu stack can handle incoming and outgoing mail for Mailman.

This configuration assumes the following:

- a working Mailu instance (e.g. `mail.example.com`)
- a MX and SPF domain record for your mailing list domain (e.g. `lists.example.com`) ponting to your Mailu instance for incoming mail (e.g. `mail.example.com`)
- the `mailman-core` container IP range configured in the `RELAYNETS` environment variable on the Mailu side for outgoing mail relaying (ensure you do not an open relay using a tool like [mxtoolbox](https://mxtoolbox.com))
- overlay networks configured for both the Mailu and Mailman3 stacks (see `SMTP_HOST` and `SMTP_NETWORK` in the [.env.sample](./.env.sample) and `MAILMAN_CORE_NETWORK` [in the Mailu config](https://git.autonomic.zone/coop-cloud/mailu/src/branch/main/.env.sample))
- a shared volume between your Mailman3 and Mailu stack which exposes the Mailman generated aliases to Mailu (see `MAILMAN_CORE_VOLUME` [in the mailu config](https://git.autonomic.zone/coop-cloud/mailu/src/branch/main/.env.sample))

## Basic usage

1. Set up Docker Swarm and [`abra`]
2. Deploy [`coop-cloud/traefik`]
3. `abra app new mailman3 --secrets` (optionally with `--pass` if you'd like
   to save secrets in `pass`)
4. `abra app YOURAPPDOMAIN config` - be sure to change `$DOMAIN` to something that resolves to
   your Docker swarm box
5. `abra app YOURAPPDOMAIN deploy`
6. Open the configured domain in your browser to finish set-up

[`abra`]: https://git.autonomic.zone/autonomic-cooperative/abra
[`coop-cloud/traefik`]: https://git.autonomic.zone/coop-cloud/traefik
Add placeholder 2020-10-07 08:43:26 +00:00			`# mailman3`

Shuffle that up too 2021-05-21 15:40:05 +00:00			`> https://docs.mailman3.org`

Get boilerplate into the README 2021-05-08 15:50:02 +00:00			`A mailing list management system.`

Shuffle that up top 2021-05-21 15:39:34 +00:00			`<!-- metadata -->`

			`- Category:`
			`- Status:`
			- Image: [`maxking/mailman-*`](https://github.com/maxking/docker-mailman)
			`- Healthcheck:`
			`- Backups:`
			`- Email:`
			`- Tests:`
			`- SSO:`

			`<!-- endmetadata -->`

Fix naming 2021-05-21 15:37:29 +00:00			`## Mailu integration`

Try to trim up that documentation once again 2021-05-23 10:20:38 +00:00			`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. A shared volume (Mailman core generated aliases for mail delivery) and a shared network (Mailu and Mailman can then see each other) are used to ensure that the postfix service in the Mailu stack can handle incoming and outgoing mail for Mailman.`
Add some docs 2021-05-21 15:33:45 +00:00
			`This configuration assumes the following:`

Try to trim up that documentation once again 2021-05-23 10:20:38 +00:00			- a working Mailu instance (e.g. `mail.example.com`)
			- a MX and SPF domain record for your mailing list domain (e.g. `lists.example.com`) ponting to your Mailu instance for incoming mail (e.g. `mail.example.com`)
			- the `mailman-core` container IP range configured in the `RELAYNETS` environment variable on the Mailu side for outgoing mail relaying (ensure you do not an open relay using a tool like [mxtoolbox](https://mxtoolbox.com))
			- overlay networks configured for both the Mailu and Mailman3 stacks (see `SMTP_HOST` and `SMTP_NETWORK` in the [.env.sample](./.env.sample) and `MAILMAN_CORE_NETWORK` [in the Mailu config](https://git.autonomic.zone/coop-cloud/mailu/src/branch/main/.env.sample))
			- a shared volume between your Mailman3 and Mailu stack which exposes the Mailman generated aliases to Mailu (see `MAILMAN_CORE_VOLUME` [in the mailu config](https://git.autonomic.zone/coop-cloud/mailu/src/branch/main/.env.sample))
Add note about mailu 2021-05-08 21:01:34 +00:00
Get boilerplate into the README 2021-05-08 15:50:02 +00:00			`## Basic usage`

			1. Set up Docker Swarm and [`abra`]
			2. Deploy [`coop-cloud/traefik`]
			3. `abra app new mailman3 --secrets` (optionally with `--pass` if you'd like
			to save secrets in `pass`)
			4. `abra app YOURAPPDOMAIN config` - be sure to change `$DOMAIN` to something that resolves to
			`your Docker swarm box`
			5. `abra app YOURAPPDOMAIN deploy`
			`6. Open the configured domain in your browser to finish set-up`

			[`abra`]: https://git.autonomic.zone/autonomic-cooperative/abra
			[`coop-cloud/traefik`]: https://git.autonomic.zone/coop-cloud/traefik