chore(docs): outsourcing environment vars to the documentation (#1948)

Co-authored-by: Frederic Werner <20406381+wernerfred@users.noreply.github.com> Co-authored-by: Casper <casperklein@users.noreply.github.com> Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2025-07-22 19:54:31 +02:00 · 2021-05-11 12:15:34 +02:00 · 2021-05-11 12:15:34 +02:00 · 5449efd8d4
commit 5449efd8d4
parent 29d630f695
18 changed files with 188 additions and 147 deletions
--- a/docs/content/config/advanced/auth-ldap.md
+++ b/docs/content/config/advanced/auth-ldap.md
@ -12,7 +12,7 @@ Getting started with ldap and this mailserver we need to take 3 parts in account

 ## Variables to Control Provisioning by the Container

-Have a look at the [`ENVIRONMENT.md`][github-file-env] for information on the default values.
+Have a look at [the ENV page][docs-environment] for information on the default values.

 !!! example "postfix"

@ -125,4 +125,4 @@ The following example illustrates this for a directory that has the qmail-schema
 - DOVECOT_USER_FILTER=(&(objectClass=qmailUser)(uid=%u)(accountStatus=active))
 ```

-[github-file-env]: https://github.com/docker-mailserver/docker-mailserver/blob/master/ENVIRONMENT.md
+[docs-environment]: ../environment.md
--- a/docs/content/config/environment.md
+++ b/docs/content/config/environment.md
@ -0,0 +1,709 @@
+---
+title: Environment Variables
+---
+
+!!! info
+
+    Values in **bold** are the default values. If an option doesn't work as documented here, check if you are running the latest image. The current `master` branch corresponds to the image `mailserver/docker-mailserver:edge`.
+
+#### General
+
+##### OVERRIDE_HOSTNAME
+
+- empty => uses the `hostname` command to get the mail server's canonical hostname.
+- => Specify a fully-qualified domainname to serve mail for.  This is used for many of the config features so if you can't set your hostname (e.g. you're in a container platform that doesn't let you) specify it in this environment variable.
+
+##### DMS_DEBUG
+
+- **0** => Debug disabled
+- 1     => Enables debug on startup
+
+##### SUPERVISOR_LOGLEVEL
+
+Here you can adjust the [log-level for Supervisor](http://supervisord.org/logging.html#activity-log-levels). Possible values are
+
+- critical => Only show critical messages
+- error    => Only show erroneous output
+- **warn** => Show warnings
+- info     => Normal informational output
+- debug    => Also show debug messages
+
+The log-level will show everything in its class and above.
+
+
+##### ONE_DIR
+
+- **0** => state in default directories.
+- 1 => consolidate all states into a single directory (`/var/mail-state`) to allow persistence using docker volumes.
+
+##### PERMIT_DOCKER
+
+Set different options for mynetworks option (can be overwrite in postfix-main.cf) **WARNING**: Adding the docker network's gateway to the list of trusted hosts, e.g. using the `network` or `connected-networks` option, can create an [**open relay**](https://en.wikipedia.org/wiki/Open_mail_relay), for instance if IPv6 is enabled on the host machine but not in Docker.
+
+- **empty** => localhost only.
+- host => Add docker host (ipv4 only).
+- network => Add the docker default bridge network (172.16.0.0/12); **WARNING**: `docker-compose` might use others (e.g. 192.168.0.0/16) use `PERMIT_DOCKER=connected-networks` in this case.
+- connected-networks => Add all connected docker networks (ipv4 only).
+
+Note: you probably want to [set `POSTFIX_INET_PROTOCOLS=ipv4`](#postfix_inet_protocols) to make it work fine with Docker.
+
+##### ENABLE_AMAVIS
+
+Amavis content filter (used for ClamAV & SpamAssassin)
+
+- 0     => Amavis is disabled
+- **1** => Amavis is enabled
+
+##### AMAVIS_LOGLEVEL
+
+[This page](https://lists.amavis.org/pipermail/amavis-users/2011-March/000158.html) provides information on Amavis' logging statistics.
+
+- -1/-2/-3 => Only show errors
+- **0**    => Show warnings
+- 1/2      => Show default informational output
+- 3/4/5    => log debug information (very verbose)
+
+##### ENABLE_CLAMAV
+
+- **0** => Clamav is disabled
+- 1 => Clamav is enabled
+
+##### ENABLE_POP3
+
+- **empty** => POP3 service disabled
+- 1 => Enables POP3 service
+
+##### ENABLE_FAIL2BAN
+
+- **0** => fail2ban service disabled
+- 1 => Enables fail2ban service
+
+If you enable Fail2Ban, don't forget to add the following lines to your `docker-compose.yml`:
+
+``` BASH
+cap_add:
+  - NET_ADMIN
+```
+
+Otherwise, `iptables` won't be able to ban IPs.
+
+##### FAIL2BAN_BLOCKTYPE
+
+- **drop**   => drop packet (send NO reply)
+- reject => reject packet (send ICMP unreachable)
+FAIL2BAN_BLOCKTYPE=drop
+
+##### SMTP_ONLY
+
+- **empty** => all daemons start
+- 1 => only launch postfix smtp
+
+##### SSL_TYPE
+
+- **empty** => SSL disabled.
+- letsencrypt => Enables Let's Encrypt certificates.
+- custom => Enables custom certificates.
+- manual => Let you manually specify locations of your SSL certificates for non-standard cases
+  - Requires: `SSL_CERT_PATH` and `SSL_KEY_PATH` ENV vars to be set to the location of the files within the container.
+  - Optional: `SSL_ALT_CERT_PATH` and `SSL_ALT_KEY_PATH` allow providing a 2nd certificate as a fallback for dual (aka hybrid) certificate support. Useful for ECDSA with an RSA fallback. Presently only `manual` mode supports this feature.
+- self-signed => Enables self-signed certificates.
+
+Please read [the SSL page in the documentation](https://docker-mailserver.github.io/docker-mailserver/edge/config/security/ssl) for more information.
+
+##### TLS_LEVEL
+
+- **empty** => modern
+- modern => Enables TLSv1.2 and modern ciphers only. (default)
+- intermediate => Enables TLSv1, TLSv1.1 and TLSv1.2 and broad compatibility ciphers.
+
+##### SPOOF_PROTECTION
+
+Configures the handling of creating mails with forged sender addresses.
+
+- **empty** => Mail address spoofing allowed. Any logged in user may create email messages with a forged sender address. See also [Wikipedia](https://en.wikipedia.org/wiki/Email_spoofing)(not recommended, but default for backwards compatibility reasons)
+- 1 => (recommended) Mail spoofing denied. Each user may only send with his own or his alias addresses. Addresses with [extension delimiters](http://www.postfix.org/postconf.5.html#recipient_delimiter) are not able to send messages.
+
+##### ENABLE_SRS
+
+Enables the Sender Rewriting Scheme. SRS is needed if your mail server acts as forwarder. See [postsrsd](https://github.com/roehling/postsrsd/blob/master/README.md#sender-rewriting-scheme-crash-course) for further explanation.
+
+- **0** => Disabled
+- 1 => Enabled
+
+##### NETWORK_INTERFACE
+
+In case your network interface differs from `eth0`, e.g. when you are using HostNetworking in Kubernetes, you can set this to whatever interface you want. This interface will then be used.
+
+- **empty** => `eth0`
+
+##### VIRUSMAILS_DELETE_DELAY
+
+Set how many days a virusmail will stay on the server before being deleted
+
+- **empty** => 7 days
+
+##### ENABLE_POSTFIX_VIRTUAL_TRANSPORT
+
+This Option is activating the Usage of POSTFIX_DAGENT to specify a ltmp client different from default dovecot socket.
+
+- **empty** => disabled
+- 1 => enabled
+
+##### POSTFIX_DAGENT
+
+Enabled by ENABLE_POSTFIX_VIRTUAL_TRANSPORT. Specify the final delivery of postfix
+
+- **empty**: fail
+- `lmtp:unix:private/dovecot-lmtp` (use socket)
+- `lmtps:inet:<host>:<port>` (secure lmtp with starttls, take a look at <https://sys4.de/en/blog/2014/11/17/sicheres-lmtp-mit-starttls-in-dovecot/>)
+- `lmtp:<kopano-host>:2003` (use kopano as mailstore)
+- etc.
+
+##### POSTFIX\_MAILBOX\_SIZE\_LIMIT
+
+Set the mailbox size limit for all users. If set to zero, the size will be unlimited (default).
+
+- **empty** => 0 (no limit)
+
+##### ENABLE_QUOTAS
+
+- **1** => Dovecot quota is enabled
+- 0 => Dovecot quota is disabled
+
+See [mailbox quota](https://docker-mailserver.github.io/docker-mailserver/edge/config/user-management/accounts/#notes).
+
+##### POSTFIX\_MESSAGE\_SIZE\_LIMIT
+
+Set the message size limit for all users. If set to zero, the size will be unlimited (not recommended!)
+
+- **empty** => 10240000 (~10 MB)
+
+##### ENABLE_MANAGESIEVE
+
+- **empty** => Managesieve service disabled
+- 1 => Enables Managesieve on port 4190
+
+##### OVERRIDE_HOSTNAME
+
+- **empty** => uses the `hostname` command to get the mail server's canonical hostname
+- => Specify a fully-qualified domainname to serve mail for.  This is used for many of the config features so if you can't set your hostname (e.g. you're in a container platform that doesn't let you) specify it in this environment variable.
+
+##### POSTMASTER_ADDRESS
+
+- **empty** => postmaster@domain.com
+- => Specify the postmaster address
+
+##### POSTSCREEN_ACTION
+
+- **enforce** => Allow other tests to complete. Reject attempts to deliver mail with a 550 SMTP reply, and log the helo/sender/recipient information. Repeat this test the next time the client connects.
+- drop => Drop the connection immediately with a 521 SMTP reply. Repeat this test the next time the client connects.
+- ignore => Ignore the failure of this test. Allow other tests to complete. Repeat this test the next time the client connects. This option is useful for testing and collecting statistics without blocking mail.
+
+##### DOVECOT_MAILBOX_FORMAT
+
+- **maildir** => uses very common Maildir format, one file contains one message
+- sdbox => (experimental) uses Dovecot high-performance mailbox format, one file contains one message
+- mdbox ==> (experimental) uses Dovecot high-performance mailbox format, multiple messages per file and multiple files per box
+
+This option has been added in November 2019. Using other format than Maildir is considered as experimental in docker-mailserver and should only be used for testing purpose. For more details, please refer to [Dovecot Documentation](https://wiki2.dovecot.org/MailboxFormat).
+
+##### POSTFIX_INET_PROTOCOLS
+
+- **all** => All possible protocols.
+- ipv4 => Use only IPv4 traffic. Most likely you want this behind Docker.
+- ipv6 => Use only IPv6 traffic.
+
+Note: More details in <http://www.postfix.org/postconf.5.html#inet_protocols>
+
+#### Reports
+
+##### PFLOGSUMM_TRIGGER
+
+Enables regular pflogsumm mail reports.
+
+- **not set** => No report
+- daily_cron => Daily report for the previous day
+- logrotate => Full report based on the mail log when it is rotated
+
+This is a new option. The old REPORT options are still supported for backwards compatibility.
+If this is not set and reports are enabled with the old options, logrotate will be used.
+
+##### PFLOGSUMM_RECIPIENT
+
+Recipient address for pflogsumm reports.
+
+- **not set** => Use REPORT_RECIPIENT or POSTMASTER_ADDRESS
+- => Specify the recipient address(es)
+
+##### PFLOGSUMM_SENDER
+
+From address for pflogsumm reports.
+
+- **not set** => Use REPORT_SENDER or POSTMASTER_ADDRESS
+- => Specify the sender address
+
+##### LOGWATCH_INTERVAL
+
+Interval for logwatch report.
+
+- **none** => No report is generated
+- daily => Send a daily report
+- weekly => Send a report every week
+
+##### LOGWATCH_RECIPIENT
+
+Recipient address for logwatch reports if they are enabled.
+
+- **not set** => Use REPORT_RECIPIENT or POSTMASTER_ADDRESS
+- => Specify the recipient address(es)
+
+##### REPORT_RECIPIENT (deprecated)
+
+Enables a report being sent (created by pflogsumm) on a regular basis.
+
+- **0** => Report emails are disabled unless enabled by other options
+- 1 => Using POSTMASTER_ADDRESS as the recipient
+- => Specify the recipient address
+
+##### REPORT_SENDER (deprecated)
+
+Change the sending address for mail report
+
+- **empty** => mailserver-report@hostname
+- => Specify the report sender (From) address
+
+##### REPORT_INTERVAL (deprecated)
+
+Changes the interval in which logs are rotated and a report is being sent (deprecated).
+
+- **daily** => Send a daily report
+- weekly => Send a report every week
+- monthly => Send a report every month
+
+Note: This variable used to control logrotate inside the container and sent the pflogsumm report when the logs were rotated.
+It is still supported for backwards compatibility, but the new option LOGROTATE_INTERVAL has been added that only rotates
+the logs.
+
+##### LOGROTATE_INTERVAL
+
+Defines the interval in which the mail log is being rotated.
+
+- **daily** => Rotate daily.
+- weekly => Rotate weekly.
+- monthly => Rotate monthly.
+
+Note that only the log inside the container is affected.
+The full log output is still available via `docker logs mail` (or your respective container name).
+If you want to control logrotation for the docker generated logfile see: [Docker Logging Drivers](https://docs.docker.com/config/containers/logging/configure/).
+
+Also note that by default the logs are lost when the container is recycled. To keep the logs, mount a volume.
+
+Finally the logrotate interval **may** affect the period for generated reports. That is the case when the reports are triggered by log rotation.
+
+#### SpamAssassin
+
+##### ENABLE_SPAMASSASSIN
+
+- **0** => SpamAssassin is disabled
+- 1 => SpamAssassin is enabled
+
+**/!\\ Spam delivery:** when SpamAssassin is enabled, messages marked as spam WILL NOT BE DELIVERED.
+Use `SPAMASSASSIN_SPAM_TO_INBOX=1` for receiving spam messages.
+
+##### SPAMASSASSIN_SPAM_TO_INBOX
+
+- **0** => Spam messages will be bounced (_rejected_) without any notification (_dangerous_).
+- 1 => Spam messages will be delivered to the inbox and tagged as spam using `SA_SPAM_SUBJECT`.
+
+##### MOVE_SPAM_TO_JUNK
+
+- **1** => Spam messages will be delivered in the `Junk` folder.
+- 0 => Spam messages will be delivered in the mailbox.
+
+Note: this setting needs `SPAMASSASSIN_SPAM_TO_INBOX=1`
+
+##### SA_TAG
+
+- **2.0** => add spam info headers if at, or above that level
+
+Note: this SpamAssassin setting needs `ENABLE_SPAMASSASSIN=1`
+
+##### SA_TAG2
+
+- **6.31** => add 'spam detected' headers at that level
+
+Note: this SpamAssassin setting needs `ENABLE_SPAMASSASSIN=1`
+
+##### SA_KILL
+
+- **6.31** => triggers spam evasive actions
+
+Note: this SpamAssassin setting needs `ENABLE_SPAMASSASSIN=1`. By default, the mailserver is configured to quarantine spam emails. If emails are quarantined, they are compressed and stored in a location dependent on the ONE_DIR setting above. If `ONE_DIR=1` the location is /var/mail-state/lib-amavis/virusmails/. If `ONE_DIR=0` it is /var/lib/amavis/virusmails/. These paths are inside the docker container. To inhibit this behaviour and deliver spam emails, set this to a very high value e.g. 100.0.
+
+##### SA_SPAM_SUBJECT
+
+- **\*\*\*SPAM\*\*\*** => add tag to subject if spam detected
+
+Note: this SpamAssassin setting needs `ENABLE_SPAMASSASSIN=1`. Add the SpamAssassin score to the subject line by inserting the keyword \_SCORE\_: **\*\*\*SPAM(\_SCORE\_)\*\*\***.
+
+##### SA_SHORTCIRCUIT_BAYES_SPAM
+
+- **1** => will activate SpamAssassin short circuiting for bayes spam detection.
+
+This will uncomment the respective line in ```/etc/spamassasin/local.cf```
+
+Note: activate this only if you are confident in your bayes database for identifying spam.
+
+##### SA_SHORTCIRCUIT_BAYES_HAM
+
+- **1** => will activate SpamAssassin short circuiting for bayes ham detection
+
+This will uncomment the respective line in ```/etc/spamassasin/local.cf```
+
+Note: activate this only if you are confident in your bayes database for identifying ham.
+
+#### Fetchmail
+
+##### ENABLE_FETCHMAIL
+
+- **0** => `fetchmail` disabled
+- 1 => `fetchmail` enabled
+
+##### FETCHMAIL_POLL
+
+- **300** => `fetchmail` The number of seconds for the interval
+
+##### FETCHMAIL_PARALLEL
+
+  **0** => `fetchmail` runs with a single config file `/etc/fetchmailrc`
+  **1** => `/etc/fetchmailrc` is split per poll entry. For every poll entry a seperate fetchmail instance is started  to allow having multiple imap idle configurations defined.
+
+Note: The defaults of your fetchmailrc file need to be at the top of the file. Otherwise it won't be added correctly to all separate `fetchmail` instances.
+
+#### LDAP
+
+##### ENABLE_LDAP
+
+- **empty** => LDAP authentification is disabled
+- 1 => LDAP authentification is enabled
+- NOTE:
+  - A second container for the ldap service is necessary (e.g. [docker-openldap](https://github.com/osixia/docker-openldap))
+  - For preparing the ldap server to use in combination with this container [this](http://acidx.net/wordpress/2014/06/installing-a-mailserver-with-postfix-dovecot-sasl-ldap-roundcube/) article may be helpful
+
+##### LDAP_START_TLS
+
+- **empty** => no
+- yes => LDAP over TLS enabled for Postfix
+
+##### LDAP_SERVER_HOST
+
+- **empty** => mail.domain.com
+- => Specify the dns-name/ip-address where the ldap-server is listening, or an URI like `ldaps://mail.domain.com`
+- NOTE: If you going to use the mailserver in combination with docker-compose you can set the service name here
+
+##### LDAP_SEARCH_BASE
+
+- **empty** => ou=people,dc=domain,dc=com
+- => e.g. LDAP_SEARCH_BASE=dc=mydomain,dc=local
+
+##### LDAP_BIND_DN
+
+- **empty** => cn=admin,dc=domain,dc=com
+- => take a look at examples of SASL_LDAP_BIND_DN
+
+##### LDAP_BIND_PW
+
+- **empty** => admin
+- => Specify the password to bind against ldap
+
+##### LDAP_QUERY_FILTER_USER
+
+- e.g. `(&(mail=%s)(mailEnabled=TRUE))`
+- => Specify how ldap should be asked for users
+
+##### LDAP_QUERY_FILTER_GROUP
+
+- e.g. `(&(mailGroupMember=%s)(mailEnabled=TRUE))`
+- => Specify how ldap should be asked for groups
+
+##### LDAP_QUERY_FILTER_ALIAS
+
+- e.g. `(&(mailAlias=%s)(mailEnabled=TRUE))`
+- => Specify how ldap should be asked for aliases
+
+##### LDAP_QUERY_FILTER_DOMAIN
+
+- e.g. `(&(|(mail=*@%s)(mailalias=*@%s)(mailGroupMember=*@%s))(mailEnabled=TRUE))`
+- => Specify how ldap should be asked for domains
+
+##### LDAP_QUERY_FILTER_SENDERS
+
+- **empty**  => use user/alias/group maps directly, equivalent to `(|($LDAP_QUERY_FILTER_USER)($LDAP_QUERY_FILTER_ALIAS)($LDAP_QUERY_FILTER_GROUP))`
+- => Override how ldap should be asked if a sender address is allowed for a user
+
+##### DOVECOT_TLS
+
+- **empty** => no
+- yes => LDAP over TLS enabled for Dovecot
+
+#### Dovecot
+
+The following variables overwrite the default values for ```/etc/dovecot/dovecot-ldap.conf.ext```.
+
+##### DOVECOT_BASE
+
+- **empty** =>  same as `LDAP_SEARCH_BASE`
+- => Tell Dovecot to search only below this base entry. (e.g. `ou=people,dc=domain,dc=com`)
+
+##### DOVECOT_DEFAULT_PASS_SCHEME
+
+- **empty** =>  `SSHA`
+- => Select one crypt scheme for password hashing from this list of [password schemes](https://doc.dovecot.org/configuration_manual/authentication/password_schemes/).
+
+##### DOVECOT_DN
+
+- **empty** => same as `LDAP_BIND_DN`
+- => Bind dn for LDAP connection. (e.g. `cn=admin,dc=domain,dc=com`)
+
+##### DOVECOT_DNPASS
+
+- **empty** => same as `LDAP_BIND_PW`
+- => Password for LDAP dn sepecifified in `DOVECOT_DN`.
+
+##### DOVECOT_URIS
+
+- **empty** => same as `LDAP_SERVER_HOST`
+- => Specify a space separated list of LDAP uris.
+- Note: If the protocol is missing, `ldap://` will be used.
+- Note: This deprecates `DOVECOT_HOSTS` (as it didn't allow to use LDAPS), which is currently still supported for backwards compatibility.
+
+##### DOVECOT_LDAP_VERSION
+
+- **empty** => 3
+- 2 => LDAP version 2 is used
+- 3 => LDAP version 3 is used
+
+##### DOVECOT_AUTH_BIND
+
+- **empty** => no
+- yes => Enable [LDAP authentication binds](https://wiki.dovecot.org/AuthDatabase/LDAP/AuthBinds)
+
+##### DOVECOT_USER_FILTER
+
+- e.g. `(&(objectClass=PostfixBookMailAccount)(uniqueIdentifier=%n))`
+
+##### DOVECOT_USER_ATTRS
+
+- e.g. `homeDirectory=home,qmailUID=uid,qmailGID=gid,mailMessageStore=mail`
+- => Specify the directory to dovecot attribute mapping that fits your directory structure.
+- Note: This is necessary for directories that do not use the Postfix Book Schema.
+- Note: The left-hand value is the directory attribute, the right hand value is the dovecot variable.
+- More details on the [Dovecot Wiki](https://wiki.dovecot.org/AuthDatabase/LDAP/Userdb)
+
+##### DOVECOT_PASS_FILTER
+
+- e.g. `(&(objectClass=PostfixBookMailAccount)(uniqueIdentifier=%n))`
+- **empty** => same as `DOVECOT_USER_FILTER`
+
+##### DOVECOT_PASS_ATTRS
+
+- e.g. `uid=user,userPassword=password`
+- => Specify the directory to dovecot variable mapping that fits your directory structure.
+- Note: This is necessary for directories that do not use the Postfix Book Schema.
+- Note: The left-hand value is the directory attribute, the right hand value is the dovecot variable.
+- More details on the [Dovecot Wiki](https://wiki.dovecot.org/AuthDatabase/LDAP/PasswordLookups)
+
+#### Postgrey
+
+##### ENABLE_POSTGREY
+
+- **0** => `postgrey` is disabled
+- 1 => `postgrey` is enabled
+
+##### POSTGREY_DELAY
+
+- **300** => greylist for N seconds
+
+Note: This postgrey setting needs `ENABLE_POSTGREY=1`
+
+##### POSTGREY_MAX_AGE
+
+- **35** => delete entries older than N days since the last time that they have been seen
+
+Note: This postgrey setting needs `ENABLE_POSTGREY=1`
+
+##### POSTGREY_AUTO_WHITELIST_CLIENTS
+
+- **5** => whitelist host after N successful deliveries (N=0 to disable whitelisting)
+
+Note: This postgrey setting needs `ENABLE_POSTGREY=1`
+
+##### POSTGREY_TEXT
+
+- **Delayed by Postgrey** => response when a mail is greylisted
+
+Note: This postgrey setting needs `ENABLE_POSTGREY=1`
+
+#### SASL Auth
+
+##### ENABLE_SASLAUTHD
+
+- **0** => `saslauthd` is disabled
+- 1 => `saslauthd` is enabled
+
+##### SASLAUTHD_MECHANISMS
+
+- empty => pam
+- `ldap` => authenticate against ldap server
+- `shadow` => authenticate against local user db
+- `mysql` => authenticate against mysql db
+- `rimap` => authenticate against imap server
+- NOTE: can be a list of mechanisms like pam ldap shadow
+
+##### SASLAUTHD_MECH_OPTIONS
+
+- empty => None
+- e.g. with SASLAUTHD_MECHANISMS rimap you need to specify the ip-address/servername of the imap server  ==> xxx.xxx.xxx.xxx
+
+##### SASLAUTHD_LDAP_SERVER
+
+- empty => localhost
+
+##### SASLAUTHD_LDAP_SSL
+
+- empty or 0 => `ldap://` will be used
+- 1 => `ldaps://` will be used
+
+##### SASLAUTHD_LDAP_START_TLS
+
+- **empty** => `no`
+- `yes` => Enable `ldap_start_tls` option
+
+##### SASLAUTHD_LDAP_TLS_CHECK_PEER
+
+- **empty** => `no`
+- `yes` => Enable `ldap_tls_check_peer` option
+
+##### SASLAUTHD_LDAP_TLS_CACERT_DIR
+
+Path to directory with CA (Certificate Authority) certificates.
+
+- **empty** => Nothing is added to the configuration
+- Any value => Fills the `ldap_tls_cacert_dir` option
+
+##### SASLAUTHD_LDAP_TLS_CACERT_FILE
+
+File containing CA (Certificate Authority) certificate(s).
+
+- **empty** => Nothing is added to the configuration
+- Any value => Fills the `ldap_tls_cacert_file` option
+
+##### SASLAUTHD_LDAP_BIND_DN
+
+- empty => anonymous bind
+- specify an object with privileges to search the directory tree
+- e.g. active directory: SASLAUTHD_LDAP_BIND_DN=cn=Administrator,cn=Users,dc=mydomain,dc=net
+- e.g. openldap: SASLAUTHD_LDAP_BIND_DN=cn=admin,dc=mydomain,dc=net
+
+##### SASLAUTHD_LDAP_PASSWORD
+
+- empty => anonymous bind
+
+##### SASLAUTHD_LDAP_SEARCH_BASE
+
+- empty => Reverting to SASLAUTHD_MECHANISMS pam
+- specify the search base
+
+##### SASLAUTHD_LDAP_FILTER
+
+- empty => default filter `(&(uniqueIdentifier=%u)(mailEnabled=TRUE))`
+- e.g. for active directory: `(&(sAMAccountName=%U)(objectClass=person))`
+- e.g. for openldap: `(&(uid=%U)(objectClass=person))`
+
+##### SASLAUTHD_LDAP_PASSWORD_ATTR
+
+Specify what password attribute to use for password verification.
+
+- **empty** => Nothing is added to the configuration but the documentation says it is `userPassword` by default.
+- Any value => Fills the `ldap_password_attr` option
+
+##### SASL_PASSWD
+
+- **empty** => No sasl_passwd will be created
+- string => `/etc/postfix/sasl_passwd` will be created with the string as password
+
+##### SASLAUTHD_LDAP_AUTH_METHOD
+
+- **empty** => `bind` will be used as a default value
+- `fastbind` => The fastbind method is used
+- `custom` => The custom method uses userPassword attribute to verify the password
+
+##### SASLAUTHD_LDAP_MECH
+
+Specify the authentication mechanism for SASL bind.
+
+- **empty** => Nothing is added to the configuration
+- Any value => Fills the `ldap_mech` option
+
+#### SRS (Sender Rewriting Scheme)
+
+##### SRS_SENDER_CLASSES
+
+An email has an "envelope" sender (indicating the sending server) and a
+"header" sender (indicating who sent it). More strict SPF policies may require
+you to replace both instead of just the envelope sender.
+
+[More info](https://www.mybluelinux.com/what-is-email-envelope-and-email-header/).
+
+- **envelope_sender** => Rewrite only envelope sender address
+- header_sender => Rewrite only header sender (not recommended)
+- envelope_sender,header_sender => Rewrite both senders
+
+##### SRS_EXCLUDE_DOMAINS
+
+- **empty** => Envelope sender will be rewritten for all domains
+- provide comma separated list of domains to exclude from rewriting
+
+##### SRS_SECRET
+
+- **empty** => generated when the container is started for the first time
+- provide a secret to use in base64
+- you may specify multiple keys, comma separated. the first one is used for signing and the remaining will be used for verification. this is how you rotate and expire keys
+- if you have a cluster/swarm make sure the same keys are on all nodes
+- example command to generate a key: `dd if=/dev/urandom bs=24 count=1 2>/dev/null | base64`
+
+##### SRS_DOMAINNAME
+
+- **empty** => Derived from OVERRIDE_HOSTNAME, DOMAINNAME, or the container's hostname
+- Set this if auto-detection fails, isn't what you want, or you wish to have a separate container handle DSNs
+
+#### Default Relay Host
+
+##### DEFAULT_RELAY_HOST
+
+- **empty** => don't set default relayhost setting in main.cf
+- default host and port to relay all mail through.
+    Format: `[example.com]:587` (don't forget the brackets if you need this to
+    be compatible with `$RELAY_USER` and `$RELAY_PASSWORD`, explained below).
+
+#### Multi-domain Relay Hosts
+
+##### RELAY_HOST
+
+- **empty** => don't configure relay host
+- default host to relay mail through
+
+##### RELAY_PORT
+
+- **empty** => 25
+- default port to relay mail through
+
+##### RELAY_USER
+
+- **empty** => no default
+- default relay username (if no specific entry exists in postfix-sasl-password.cf)
+
+##### RELAY_PASSWORD
+
+- **empty** => no default
+- password for default relay user
--- a/docs/content/config/security/ssl.md
+++ b/docs/content/config/security/ssl.md
@ -195,9 +195,9 @@ The second part of the setup is the actual mail container. So, in another folder
    services:
      mailserver:
        image: mailserver/docker-mailserver:latest
-        hostname: ${HOSTNAME}
-        domainname: ${DOMAINNAME}
-        container_name: ${CONTAINER_NAME}
+        hostname: <HOSTNAME> # <-- change this
+        domainname: <DOMAINNAME> # <-- change this
+        container_name: mailserver
        ports:
          - "25:25"
          - "143:143"
--- a/docs/content/config/setup.sh.md
+++ b/docs/content/config/setup.sh.md
@ -21,70 +21,113 @@ chmod a+x ./setup.sh

 Run `./setup.sh help` and you'll get some usage information:

-```bash
-setup.sh Bootstrapping Script
+```TXT
+SETUP(1)

-Usage: ./setup.sh [-i IMAGE_NAME] [-c CONTAINER_NAME] <subcommand> <subcommand> [args]
+NAME
+    setup.sh - docker-mailserver administration script

-OPTIONS:
+SYNOPSIS
+    ./setup.sh [ OPTIONS... ] COMMAND [ help | ARGUMENTS... ]

-  -i IMAGE_NAME     The name of the docker-mailserver image
-                    The default value is
-                    'docker.io/mailserver/docker-mailserver:latest'
+    COMMAND := { email | alias | quota | config | relay | debug } SUBCOMMAND

-  -c CONTAINER_NAME The name of the running container.
+DESCRIPTION
+    This is the main administration script that you use for all interactions with your
+    mail server. Setup, configuration and much more is done with this script.

-  -p PATH           Config folder path (default: /home/georg/github/docker-mailserver/config)
+    Please note that the script executes most of the commands inside the container itself.
+    If the image was not found, this script will pull the :latest tag of
+    mailserver/docker-mailserver. This tag refers to the latest release,
+    see the tagging convention in the README under
+    https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md

-  -h                Show this help dialogue
+    You will be able to see detailed information about the script you are invoking and
+    its arguments by appending help after your command. Currently, this
+    does not work with all scripts.

-  -z                Allow container access to the bind mount content
-                    that is shared among multiple containers
-                    on a SELinux-enabled host.
+VERSION
+    The current version of this script is backwards compatible with versions of
+    docker-mailserver after 8.0.1. In case that there is not a more recent release,
+    this script is currently only working with the :edge tag.

-  -Z                Allow container access to the bind mount content
-                    that is private and unshared with other containers
-                    on a SELinux-enabled host.
+    You can download the script for your release by substituting TAG from the
+    following URL, where TAG looks like 'vX.X.X':
+    https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/TAG/setup.sh

-SUBCOMMANDS:
+OPTIONS
+    Config path, container or image adjustments
+        -i IMAGE_NAME
+            Provides the name of the docker-mailserver image. The default value is
+            docker.io/mailserver/docker-mailserver:latest

-  email:
+        -c CONTAINER_NAME
+            Provides the name of the running container.

-    ./setup.sh email add <email> [<password>]
-    ./setup.sh email update <email> [<password>]
-    ./setup.sh email del <email>
-    ./setup.sh email restrict <add|del|list> <send|receive> [<email>]
-    ./setup.sh email list
+        -p PATH
+            Provides the config folder path. The default is
+            /home/maxwell/Dokumente/github/docker-mailserver/config/

-  alias:
-    ./setup.sh alias add <email> <recipient>
-    ./setup.sh alias del <email> <recipient>
-    ./setup.sh alias list
+    SELinux
+        -z
+            Allows container access to the bind mount content that is shared among
+            multiple containers on a SELinux-enabled host.

-  quota:
-    ./setup.sh quota set <email> [<quota>]
-    ./setup.sh quota del <email>
+        -Z
+            Allows container access to the bind mount content that is private and
+            unshared with other containers on a SELinux-enabled host.

-  config:
+[SUB]COMMANDS
+    COMMAND email :=
+        ./setup.sh email add <EMAIL ADDRESS> [<PASSWORD>]
+        ./setup.sh email update <EMAIL ADDRESS> [<PASSWORD>]
+        ./setup.sh email del [ OPTIONS... ] <EMAIL ADDRESS> [ <EMAIL ADDRESS>... ]
+        ./setup.sh email restrict <add|del|list> <send|receive> [<EMAIL ADDRESS>]
+        ./setup.sh email list

-    ./setup.sh config dkim <keysize> (default: 4096) <domain.tld> (optional - for LDAP setups)
-    ./setup.sh config ssl <fqdn>
+    COMMAND alias :=
+        ./setup.sh alias add <EMAIL ADDRESS> <RECIPIENT>
+        ./setup.sh alias del <EMAIL ADDRESS> <RECIPIENT>
+        ./setup.sh alias list

-  relay:
+    COMMAND quota :=
+        ./setup.sh quota set <EMAIL ADDRESS> [<QUOTA>]
+        ./setup.sh quota del <EMAIL ADDRESS>

-    ./setup.sh relay add-domain <domain> <host> [<port>]
-    ./setup.sh relay add-auth <domain> <username> [<password>]
-    ./setup.sh relay exclude-domain <domain>
+    COMMAND config :=
+        ./setup.sh config dkim [ ARGUMENTS... ]
+        ./setup.sh config ssl <FQDN> (ATTENTION: This is deprecated and will be removed soon.)

-  debug:
+    COMMAND relay :=
+        ./setup.sh relay add-domain <DOMAIN> <HOST> [<PORT>]
+        ./setup.sh relay add-auth <DOMAIN> <USERNAME> [<PASSWORD>]
+        ./setup.sh relay exclude-domain <DOMAIN>

-    ./setup.sh debug fetchmail
-    ./setup.sh debug fail2ban [<unban> <ip-address>]
-    ./setup.sh debug show-mail-logs
-    ./setup.sh debug inspect
-    ./setup.sh debug login <commands>
+    COMMAND debug :=
+        ./setup.sh debug fetchmail
+        ./setup.sh debug fail2ban [unban <IP>]
+        ./setup.sh debug show-mail-logs
+        ./setup.sh debug inspect
+        ./setup.sh debug login <COMMANDS>
+
+EXAMPLES
+    ./setup.sh email add test@domain.tld
+        Add the email account test@domain.tld. You will be prompted
+        to input a password afterwards since no password was supplied.
+
+    ./setup.sh config dkim keysize 2048 domain 'whoami.com,whoareyou.org'
+        Creates keys of length 2048 but in an LDAP setup where domains are not known to
+        Postfix by default, so you need to provide them yourself in a comma-separated list.
+
+    ./setup.sh config dkim help
+        This will provide you with a detailed explanation on how to use the 
+        config dkim command, showing what arguments can be passed and what they do.
+
+EXIT STATUS
+    Exit status is 0 if the command was successful. If there was an unexpected error, an error
+    message is shown describing the error. In case of an error, the script will exit with exit
+    status 1.

-  help: Show this help dialogue
 ```

 [github-file-setupsh]: https://github.com/docker-mailserver/docker-mailserver/blob/master/setup.sh
--- a/docs/content/config/troubleshooting/debugging.md
+++ b/docs/content/config/troubleshooting/debugging.md
@ -7,7 +7,7 @@ title: 'Troubleshooting | Debugging'

 ## Enable Verbose Debugging Output

-You may find it useful to enable the [`DMS_DEBUG`][github-file-env-dmsdebug] environment variable.
+You may find it useful to enable the [`DMS_DEBUG`][docs-environment-dmsdebug] environment variable.

 ## Invalid Username or Password

@ -58,7 +58,8 @@ fail2ban-client stop postfix
 Some hosting provides have a stealth block on port 25. Make sure to check with your hosting provider that traffic on port 25 is allowed

 Common hosting providers known to have this issue:
+
 - [Azure](https://docs.microsoft.com/en-us/azure/virtual-network/troubleshoot-outbound-smtp-connectivity)
 - [AWS EC2](https://aws.amazon.com/premiumsupport/knowledge-center/ec2-port-25-throttle/)

-[github-file-env-dmsdebug]: https://github.com/docker-mailserver/docker-mailserver/blob/master/ENVIRONMENT.md#dms_debug
+[docs-environment-dmsdebug]: ../environment.md#dms_debug
--- a/docs/content/contributing/coding-style.md
+++ b/docs/content/contributing/coding-style.md
@ -2,7 +2,7 @@
 title: 'Contributing | Coding Style'
 ---

-##Bash and Shell
+## Bash and Shell

 When refactoring, writing or altering scripts, that is Shell and bash scripts, in any way, adhere to these rules:

@ -40,7 +40,7 @@ fi

 ### Variables & Braces

-!!! attention 
+!!! attention

    Variables are always uppercase. We always use braces.

@ -51,7 +51,7 @@ If you forgot this and want to change it later, you can use [this link][regex].
 local VAR="good"
 local NEW="${VAR}"

-# bad -> TravisCI will fail
+# bad -> CI will fail
 var="bad"
 new=$var
 ```
--- a/docs/content/contributing/issues-and-pull-requests.md
+++ b/docs/content/contributing/issues-and-pull-requests.md
@ -37,7 +37,7 @@ The development workflow is the following:
 3. Add integration tests if necessary
 4. Get the linters with `make install_linters` and install `jq` with the package manager of your OS
 5. Use `make clean all` to build image locally and run tests (note that tests work on Linux **only**)
-6. Document your improvements if necessary (e.g. if you introduced new environment variables, write the description in [`ENVIRONMENT.md`][github-file-env])
+6. Document your improvements if necessary (e.g. if you introduced new environment variables, describe those in the [ENV documentation][docs-environment])
 7. [Commit][commit] and [sign your commit][gpg], push and create a pull-request to merge into `master`. Please **use the pull-request template** to provide a minimum of contextual information and make sure to meet the requirements of the checklist. 
   1. Pull requests are automatically tested against the CI and will be reviewed when tests pass
   2. When your changes are validated, your branch is merged
@ -45,6 +45,6 @@ The development workflow is the following:

 [docs]: https://docker-mailserver.github.io/docker-mailserver/edge
 [github-file-readme]: https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md
-[github-file-env]: https://github.com/docker-mailserver/docker-mailserver/blob/master/ENVIRONMENT.md
+[docs-environment]: ../config/environment.md
 [commit]: https://help.github.com/articles/closing-issues-via-commit-messages/
 [gpg]: https://docs.github.com/en/github/authenticating-to-github/generating-a-new-gpg-key
--- a/docs/content/examples/tutorials/basic-installation.md
+++ b/docs/content/examples/tutorials/basic-installation.md
@ -60,7 +60,7 @@ We are going to use this docker based mailserver:

    For more details about the environment variables that can be used, and their meaning and possible values, check also these:

-    - [Environtment Variables][github-file-env]
+    - [Environment Variables][docs-environment]
    - [`mailserver.env` file][github-file-dotenv]

    Make sure to set the proper `domainname` that you will use for the emails. We forward only SMTP ports (not POP3 and IMAP) because we are not interested in accessing the mailserver directly (from a client).  We also use these settings:
@ -157,6 +157,6 @@ We are going to use this docker based mailserver:
    - **SMTP username**: `info@example.org`
    - **SMTP password**: `passwd123`

-[github-file-env]: https://github.com/docker-mailserver/docker-mailserver/blob/master/ENVIRONMENT.md
+[docs-environment]: ../../config/environment.md
 [github-file-dotenv]: https://github.com/docker-mailserver/docker-mailserver/blob/master/mailserver.env
 [github-issue-1405-comment]: https://github.com/docker-mailserver/docker-mailserver/issues/1405#issuecomment-590106498
--- a/docs/content/index.md
+++ b/docs/content/index.md
@ -12,7 +12,7 @@ This documentation provides you with advanced configuration, detailed examples,

 1. The script [`setup.sh`][github-file-setupsh] is supplied with this project. It supports you in **configuring and administrating** your server. Information on how to get it and how to use it is available [on a dedicated page][docs-setupsh].
 2. Be aware that advanced tasks may still require tweaking environment variables, reading through documentation and sometimes inspecting your running container for debugging purposes. After all, a mail server is a complex arrangement of various programs.
-3. A list of all configuration options is provided in [`ENVIRONMENT.md`][github-file-env]. The [`README.md`][github-file-readme] is a good starting point to understand what this image is capable of.
+3. A list of all configuration options is documented on [the ENV page][docs-environment]. The [`README.md`][github-file-readme] is a good starting point to understand what this image is capable of.
 4. A list of all optional and automatically created configuration files and directories is available [on the dedicated page][docs-optionalconfig].

 !!! tip
@ -30,6 +30,6 @@ We are always happy to welcome new contributors. For guidelines and entrypoints
 [docs-optionalconfig]: ./config/advanced/optional-config.md
 [docs-setupsh]: ./config/setup.sh.md
 [docs-userpatches]: ./config/advanced/override-defaults/user-patches.md
+[docs-environment]: ./config/environment.md
 [github-file-readme]: https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md
-[github-file-env]: https://github.com/docker-mailserver/docker-mailserver/blob/master/ENVIRONMENT.md
 [github-file-setupsh]: https://github.com/docker-mailserver/docker-mailserver/blob/master/setup.sh