diff --git a/README.md b/README.md index f85e05b..e434123 100644 --- a/README.md +++ b/README.md @@ -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 + +* **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 + + +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