Follow new exciting README standard
continuous-integration/drone/push Build is passing Details

See coop-cloud/organising#31
This commit is contained in:
3wc 2021-03-02 18:38:40 +02:00
parent 6ff4b4958b
commit a97a71b1e4
1 changed files with 22 additions and 14 deletions

View File

@ -1,8 +1,19 @@
# Postfix-Relay
[![Build Status](https://drone.autonomic.zone/api/badges/compose-stacks/postfix-relay/status.svg)](https://drone.autonomic.zone/compose-stacks/postfix-relay)
[![Build Status](https://drone.autonomic.zone/api/badges/coop-cloud/postfix-relay/status.svg)](https://drone.autonomic.zone/coop-cloud/postfix-relay)
Centralised email delivery for all your `compose-stacks` apps using the
<!-- metadata -->
* **Category**: Utilities
* **Status**: ❷💛
* **Image**: [`boky/postfix`](https://hub.docker.com/r/boky/postfix/), ❶💚, upstream
* **Healthcheck**: Yes
* **Backups**: No
* **Email**: N/A
* **Tests**: ❷💛
* **SSO**: N/A
<!-- endmetadata -->
Centralised email delivery for all your `coop-cloud` apps using the
[`boky/postfix`] outgoing-only mail image.
The basic idea is to run one instance of this on each swarm, and configure that
@ -25,15 +36,12 @@ FIXME 3wc: Pass `RELAYHOST` etc. from `.envrc` to service
## Basic usage
1. Set up Docker Swarm and [`abra`]
2. Deploy [`compose-stacks/traefik`]
3. `git clone https://git.autonomic.zone/compose-stacks/postfix-relay.git && cd postfix-relay`
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`
5. `direnv allow` (or `. .envrc`)
6. `abra deploy`
1. Set up Docker Swarm and [`abra`][abra]
2. Deploy [`coop-cloud/traefik`][compose-traefik]
3. `abra app new postfix-relay`
4. `abra app YOURAPPDOMAIN config` - be sure to change `$DOMAIN` to something that resolves to
your Docker swarm box
5. `abra app YOURAPPDOMAIN deploy`
## Using this in other stacks
@ -42,10 +50,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/wordpress`][wordpress-compose].
`coop-cloud/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
[wordpress-compose]: https://git.autonomic.zone/compose-stacks/wordpress/src/branch/master/compose.mailrelay.yml
[`coop-cloud/traefik`]: https://git.autonomic.zone/coop-cloud/traefik
[wordpress-compose]: https://git.autonomic.zone/coop-cloud/wordpress/src/branch/master/compose.mailrelay.yml