mailman3/README.md

# mailman3

A mailing list management system.

<!-- metadata -->

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

<!-- endmetadata -->

> https://docs.mailman3.org

## 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 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 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 a 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.

## 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`

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 -->`

Add placeholder 2020-10-07 08:43:26 +00:00			`> https://docs.mailman3.org`

Fix naming 2021-05-21 15:37:29 +00:00			`## 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.`
Add some docs 2021-05-21 15:33:45 +00:00
			`This configuration assumes the following:`

Fix naming 2021-05-21 15:37:29 +00:00			- 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)
Add some docs 2021-05-21 15:33:45 +00:00			- you have an MX and an SPF record setup on your `lists.example.com` for incoming mail
Fix naming 2021-05-21 15:37:29 +00:00			- 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)
Fix typo 2021-05-21 15:38:27 +00:00			- you have a shared volume between your Mailman3 and Mailu stack which exposes the mailman generated aliases which can be fed into a 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)
Add some docs 2021-05-21 15:33:45 +00:00
			`More documentation coming after we recover from the diabolical hacking required to get this working.`
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