diff --git a/.vale/Vocab/smtp/accept.txt b/.vale/Vocab/smtp/accept.txt index b69b024..446fd90 100644 --- a/.vale/Vocab/smtp/accept.txt +++ b/.vale/Vocab/smtp/accept.txt @@ -1,6 +1,7 @@ aws|AWS certbot cloudflare|Cloudflare +dockerhub|DockerHub dkim|DKIM env|Env mailarchive diff --git a/README.md b/README.md index c5569b2..40b84ae 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,35 @@ Wraps [cisagov/postfix-docker](https://github.com/cisagov/postfix-docker) in automation for generating [Let's Encrypt](https://letsencrypt.org/) SSL certificates and dkim DNS records. +On DockerHub: + +- [docker.io/niallbyrne/smtp-aws](https://hub.docker.com/repository/docker/niallbyrne/smtp-aws) +- [docker.io/niallbyrne/smtp-cloudflare](https://hub.docker.com/repository/docker/niallbyrne/smtp-cloudflare) + +## Usage Examples + +```bash +docker pull docker.io/niallbyrne/smtp-aws +docker run \ + -v $(pwd)/certs:/etc/letsencrypt \ + -v $(pwd)/aws.env:/mnt/aws.env \ + -e ENV_FILE=/mnt/aws.env \ + -p 587:587 \ + docker.io/niallbyrne/smtp-aws +``` + +or + +```bash +docker pull docker.io/niallbyrne/smtp-cloudflare +docker run -v \ + -v $(pwd)/certs:/etc/letsencrypt \ + -v $(pwd)/cloudflare.env:/mnt/cloudflare.env \ + -e ENV_FILE=/mnt/cloudflare.env \ + -p 587:587 \ + docker.io/niallbyrne/smtp-cloudflare +``` + ## Build Arguments | Name | Value | Default |