Merge pull request #4 from bmillemathias/update-params-readme

Document missing environment variables
djjudas21 · Feb 23, 2024 · 49b200e · 49b200e
2 parents 5c4119b + 63f3e31
commit 49b200e
Showing 1 changed file with 9 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -12,11 +12,13 @@ This image supports the following enironment variables. All are **required**.
 
 | Variable                   | Use                                                                 | Example                   |
 |----------------------------|---------------------------------------------------------------------|---------------------------|
-| `SMTP_RELAY_HOST`       | Hostname of upstream SMTP relay server                              | `[smtp.sendgrid.net]:587` |
-| `SMTP_RELAY_USERNAME`   | Username for upstream SMTP relay server                             | `apikey`                  |
-| `SMTP_RELAY_PASSWORD`   | Password for upstream SMTP relay server                             | `pAsSwOrD`                |
-| `SMTP_RELAY_MYHOSTNAME` | Hostname of this SMTP relay                                         | `smtp-relay.yourhost.com` |
-| `SMTP_RELAY_MYNETWORKS` | Comma-separated list of local networks that can use this SMTP relay | `127.0.0.0/8,10.0.0.0/8`  |
+| `SMTP_RELAY_HOST`          | Hostname of upstream SMTP relay server                              | `[smtp.sendgrid.net]:587` |
+| `SMTP_RELAY_USERNAME`      | Username for upstream SMTP relay server                             | `apikey`                  |
+| `SMTP_RELAY_PASSWORD`      | Password for upstream SMTP relay server                             | `pAsSwOrD`                |
+| `SMTP_RELAY_MYHOSTNAME`    | Hostname of this SMTP relay                                         | `smtp-relay.yourhost.com` |
+| `SMTP_RELAY_MYNETWORKS`    | Comma-separated list of local networks that can use this SMTP relay | `127.0.0.0/8,10.0.0.0/8`  |
+| `SMTP_RELAY_WRAPPERMODE`   | Request postfix connects using SUBMISSIONS/SMTPS protocol instead of STARTTLS | `no`                      |
+| `SMTP_TLS_SECURITY_LEVEL`  | default SMTP TLS security level for the Postfix SMTP client         | `""`                      |
 
 # Quickstart
 Run on docker
@@ -27,6 +29,8 @@ docker run --rm -it -p 2525:25 \
 	-e SMTP_RELAY_USERNAME=username \
 	-e SMTP_RELAY_PASSWORD=password \
 	-e SMTP_RELAY_MYNETWORKS=127.0.0.0/8,10.0.0.0/8 \
+	-e SMTP_RELAY_WRAPPERMODE=no \
+	-e SMTP_TLS_SECURITY_LEVEL="" \
 	djjudas21/smtp-relay
 
 ```