Skip to content

Commit

Permalink
docs(README): add detail to user list variable
Browse files Browse the repository at this point in the history
  • Loading branch information
@niall-byrne
niall-byrne committed Nov 25, 2023
1 parent 29f464d commit 373b6d3
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:<br />"username1 password1\nusername2 password2\n"<br />(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:<br />"username1 password1\nusername2 password2\n"<br />(Use alphanumerical characters, but letters in username must be lowercase.) | "admin admin\n" |

### DNS Providers

Expand Down

0 comments on commit 373b6d3

Please sign in to comment.