Skip to content

Commit

Permalink
docs(README): usage examples and dockerhub links
Browse files Browse the repository at this point in the history
  • Loading branch information
niall-byrne committed Nov 16, 2023
1 parent 0377947 commit a60cadb
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
1 change: 1 addition & 0 deletions .vale/Vocab/smtp/accept.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
aws|AWS
certbot
cloudflare|Cloudflare
dockerhub|DockerHub
dkim|DKIM
env|Env
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,33 @@

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:main](https://hub.docker.com/repository/docker/niallbyrne/smtp-aws/general)
- [docker.io/niallbyrne/smtp-cloudflare:main](https://hub.docker.com/repository/docker/niallbyrne/smtp-cloudflare/general)

## Usage Examples

```bash
docker pull docker.io/niallbyrne/smtp-aws:main
docker run -v \
$(pwd)/certs:/etc/letsencrypt/live/ \
$(pwd)/aws.env:/mnt/aws.env \
-e ENV_FILE=/mnt/aws.env \
docker.io/niallbyrne/smtp-aws:main
```

or

```bash
docker pull docker.io/niallbyrne/smtp-cloudflare:main
docker run -v \
$(pwd)/certs:/etc/letsencrypt/live \
$(pwd)/cloudflare.env:/mnt/cloudflare.env \
-e ENV_FILE=/mnt/cloudflare.env \
docker.io/niallbyrne/smtp-cloudflare:main
```

## Build Arguments

| Name | Value | Default |
Expand Down

0 comments on commit a60cadb

Please sign in to comment.