generated from coop-cloud/example
Update README
[ci skip]
This commit is contained in:
10
README.md
10
README.md
@ -9,9 +9,7 @@ The basic idea is to run one instance of this on each swarm, and configure that
|
||||
swarm's apps to send all their email through it.
|
||||
|
||||
By default, this stack will try to deliver e-mail directly (i.e. looking up the
|
||||
recipient's mail server using `MX` records).
|
||||
|
||||
**NOTE**: If you use this direct delivery, make sure that:
|
||||
recipient's mail server using `MX` records). **NOTE**: make sure that:
|
||||
- your Traefik server and host firewall are configured to allow port 587,
|
||||
- you have an MX record for your configured `$DOMAIN` pointing to this server,
|
||||
- you have an SPF record for `$DOMAIN` that includes `mx` or this server's IP
|
||||
@ -33,7 +31,7 @@ FIXME 3wc: Pass `RELAYHOST` etc. from `.envrc` to service
|
||||
3. `cp .envrc.sample .envrc`
|
||||
4. Edit `.envrc` - be sure to change `DOMAIN` to something that resolves to
|
||||
your Docker swarm box, and add any extra domains (including subdomains) you'd
|
||||
like to be able to send mail from in `EXTRA_SENDER_DOMAINS`.
|
||||
like to be able to send mail from in `EXTRA_SENDER_DOMAINS`
|
||||
5. `direnv allow` (or `. .envrc`)
|
||||
6. `abra deploy`
|
||||
|
||||
@ -44,10 +42,10 @@ the image supports for auto-configuring SMTP settings.
|
||||
|
||||
For reusable stacks, you probably want to put this configuration in a separate
|
||||
`compose.mailrelay.yml` file, e.g. [the version in
|
||||
`compose-stacks/nextcloud`][nextcloud-compose].
|
||||
`compose-stacks/wordpress`][wordpress-compose].
|
||||
|
||||
[`boky/postfix`]: https://hub.docker.com/r/boky/postfix
|
||||
[boky-postfix-options]: https://github.com/bokysan/docker-postfix#postfix-specific-options
|
||||
[`abra`]: https://git.autonomic.zone/autonomic-cooperative/abra
|
||||
[`compose-stacks/traefik`]: https://git.autonomic.zone/compose-stacks/traefik
|
||||
[nextcloud-compose]: https://git.autonomic.zone/compose-stacks/nextcloud/src/branch/main/compose.mailrelay.yml
|
||||
[wordpress-compose]: https://git.autonomic.zone/compose-stacks/wordpress/src/branch/master/compose.mailrelay.yml
|
||||
|
Reference in New Issue
Block a user