From 373b6d3038a7e046f21609cd5a027ab8a0d50923 Mon Sep 17 00:00:00 2001 From: Niall Byrne <9848926+niall-byrne@users.noreply.github.com> Date: Sat, 25 Nov 2023 13:16:32 -0500 Subject: [PATCH] docs(README): add detail to user list variable --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 0286afd..d341e52 100644 --- a/README.md +++ b/README.md @@ -45,20 +45,20 @@ docker run \ You may set the following environment variables to customize the container's behaviour: -| Name | Value | Default | -|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|-----------------| -| CLIENT_DOMAIN_WHITELIST | A space separated list of domains you wish to allow to use your SMTP server. The default allows any client to try and authenticate. | No Default | -| CONFIG_DELAY | The time to wait for cisagov/postfix-docker to finish configuring postfix. | 30 | -| CONTACT_EMAIL | Let's Encrypt Contact Email. This is required by Let's Encrypt. | No Default | -| DKIM_DELAY | The time to wait for opendkim to generate a dkim value. | 30 | -| DNS_PROPAGATION_DELAY | The time for Let's Encrypt to wait for DNS changes. | 30 | -| PRIMARY_DOMAIN | The domain postfix is running for. | No Default | -| RELAY_SERVER | The relay server to use for outgoing mail. (If omitted, then no relay server is used.) | No Default | -| RELAY_SERVER_CREDENTIALS | The username/password pair to use for the relay server. (In "username:password" format.) | No Default | -| RELAY_SERVER_PORT | The port used by the SMTP relay server. | No Default | -| RENEW_INTERVAL_IN_DAYS | The interval (in days) to attempt to renew the certificates. | 7 | -| TEST_MODE | Set to "0" after you have tested certificate generation. | 1 | -| USER_LIST | A newline separated list of user/password pairs:
"username1 password1\nusername2 password2\n"
(Alphanumerical characters only.) | "admin admin\n" | +| Name | Value | Default | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| CLIENT_DOMAIN_WHITELIST | A space separated list of domains you wish to allow to use your SMTP server. The default allows any client to try and authenticate. | No Default | +| CONFIG_DELAY | The time to wait for cisagov/postfix-docker to finish configuring postfix. | 30 | +| CONTACT_EMAIL | Let's Encrypt Contact Email. This is required by Let's Encrypt. | No Default | +| DKIM_DELAY | The time to wait for opendkim to generate a dkim value. | 30 | +| DNS_PROPAGATION_DELAY | The time for Let's Encrypt to wait for DNS changes. | 30 | +| PRIMARY_DOMAIN | The domain postfix is running for. | No Default | +| RELAY_SERVER | The relay server to use for outgoing mail. (If omitted, then no relay server is used.) | No Default | +| RELAY_SERVER_CREDENTIALS | The username/password pair to use for the relay server. (In "username:password" format.) | No Default | +| RELAY_SERVER_PORT | The port used by the SMTP relay server. | No Default | +| RENEW_INTERVAL_IN_DAYS | The interval (in days) to attempt to renew the certificates. | 7 | +| TEST_MODE | Set to "0" after you have tested certificate generation. | 1 | +| USER_LIST | A newline separated list of user/password pairs:
"username1 password1\nusername2 password2\n"
(Use alphanumerical characters, but letters in username must be lowercase.) | "admin admin\n" | ### DNS Providers