scripts: remove `DMS_DEBUG` (#2523)

* remove DMS_DEBUG from tests
* remove DMS_DEBUG from doc and scripts
* updated issue template
* re-add description about removal of DMS_DEBUG

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -54,7 +54,7 @@ body:
     attributes:
       label:  What happened and when does this occur?
       description: Tell us what happened. Use [fenced code blocks](https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#fenced-code-blocks) when pasting lots of text!
-      placeholder: Although `DMS_DEBUG=1` is set, I see no debug output.
+      placeholder: Although `LOG_LEVEL=debug` is set, I see no debug output.
       render: Markdown
     validations:
       required: true
@@ -127,13 +127,13 @@ body:
     attributes:
       label: docker-compose.yml
       description: Show us your docker-compose.yml file or your equivalent "docker run" command.
-      render: yaml
+      render: yml
   - type: textarea
     id: relevant-log-output
     attributes:
       label: Relevant log output
-      description: Show us relevant log output here. You can enable debug output by setting the environment variable `DMS_DEBUG` to `1`.
+      description: Show us relevant log output here. You can enable debug output by setting the environment variable `LOG_LEVEL` to `debug` or `trace`.
-      render: shell
+      render: bash
   - type: textarea
     id: other-relevant-information
     attributes:
@@ -153,8 +153,6 @@ body:
         - label: I am inexperienced with docker
         - label: I am inexperienced with mail servers
         - label: I am uncomfortable with the CLI
-    validations:
-      required: false
   - type: checkboxes
     id: terms-code-of-conduct
     attributes:

README.md

@@ -257,7 +257,6 @@ services:
       - ENABLE_POSTGREY=1
       - ENABLE_SASLAUTHD=0
       - ONE_DIR=1
-      - DMS_DEBUG=0
     cap_add:
       - NET_ADMIN
       - SYS_PTRACE
@@ -295,7 +294,6 @@ services:
       - ENABLE_FAIL2BAN=1
       - ENABLE_POSTGREY=1
       - ONE_DIR=1
-      - DMS_DEBUG=0
       - ENABLE_LDAP=1
       - LDAP_SERVER_HOST=ldap # your ldap container/IP/ServerName
       - LDAP_SEARCH_BASE=ou=people,dc=localhost,dc=localdomain

docs/content/config/advanced/auth-ldap.md

@@ -241,7 +241,6 @@ The changes on the configurations necessary to work with Active Directory (**onl
           # <<< SASL LDAP Authentication
 
           - ONE_DIR=1
-          - DMS_DEBUG=0
           - SSL_TYPE=letsencrypt
           - PERMIT_DOCKER=host
 
@@ -305,7 +304,6 @@ The changes on the configurations necessary to work with Active Directory (**onl
           # <<< Kopano Integration
 
           - ONE_DIR=1
-          - DMS_DEBUG=0
           - SSL_TYPE=letsencrypt
           - PERMIT_DOCKER=host
 

docs/content/config/advanced/kubernetes.md

@@ -20,7 +20,6 @@ We assume basic knowledge about K8s from the reader. If you're not familiar with
 
 We want to provide the basic configuration in the form of environment variables with a `ConfigMap`. Note that this is just an example configuration; tune the `ConfigMap` to your needs.
 
-
 ```yaml
 ---
 apiVersion: v1
@@ -40,7 +39,6 @@ data:
   UPDATE_CHECK_INTERVAL: 10d
   POSTFIX_INET_PROTOCOLS: ipv4
   ONE_DIR: '1'
-  DMS_DEBUG: '0'
   ENABLE_CLAMAV: '1'
   ENABLE_POSTGREY: '0'
   ENABLE_FAIL2BAN: '1'

docs/content/config/environment.md

@@ -15,10 +15,7 @@ title: Environment Variables
 
 ##### DMS_DEBUG
 
-This environment variable is deprecated. Use `LOG_LEVEL` instead.
+**This environment variable was removed in `v11.0.0`!** Use `LOG_LEVEL` instead.
-
-- **0** => Debug disabled
-- 1     => Enables debug on startup
 
 ##### LOG_LEVEL
 

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`][docs-environment-dmsdebug] environment variable.
+You may find it useful to set [`LOG_LEVEL`][docs-environment-log-level] environment variable.
 
 ## Invalid Username or Password
 
@@ -62,4 +62,4 @@ 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/)
 
-[docs-environment-dmsdebug]: ../environment.md#dms_debug
+[docs-environment-log-level]: ../environment.md#log_level

docs/content/contributing/issues-and-pull-requests.md

@@ -10,7 +10,7 @@ This project is Open Source. That means that you can contribute on enhancements,
 
     **Before opening an issue**, read the [`README`][github-file-readme] carefully, study the [documentation][docs], the Postfix/Dovecot documentation and your search engine you trust. The issue tracker is not meant to be used for unrelated questions! 
 
-When opening an issue, please provide details use case to let the community reproduce your problem. Please start `docker-mailserver` with ENV `DMS_DEBUG=1` and paste the output into the issue.
+When opening an issue, please provide details use case to let the community reproduce your problem. Please start `docker-mailserver` with the environment variable `LOG_LEVEL` set to `debug` or `trace` and paste the output into the issue.
 
 !!! attention
 

docs/content/examples/tutorials/basic-installation.md

@@ -52,7 +52,6 @@ In this setup `docker-mailserver` is not intended to receive email externally, s
               # Beware creating an Open Relay: https://docker-mailserver.github.io/docker-mailserver/edge/config/environment/#permit_docker
               - PERMIT_DOCKER=network
               # All env below are default settings:
-              - DMS_DEBUG=0
               - ONE_DIR=1
               - ENABLE_POSTGREY=0
               - ENABLE_CLAMAV=0

mailserver.env

@@ -13,9 +13,7 @@
 # => 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.
 OVERRIDE_HOSTNAME=
 
-# (deprecated: use LOG_LEVEL instead)
+# REMOVED in version v11.0.0! Use LOG_LEVEL instead.
-# 0 => Debug disabled
-# 1 => Enables debug on startup
 DMS_DEBUG=0
 
 # Set the log level for DMS.

target/scripts/start-mailserver.sh

@@ -53,7 +53,6 @@ VARS[REPORT_SENDER]="${REPORT_SENDER:=mailserver-report@${HOSTNAME}}"
 VARS[AMAVIS_LOGLEVEL]="${AMAVIS_LOGLEVEL:=0}"
 VARS[CLAMAV_MESSAGE_SIZE_LIMIT]="${CLAMAV_MESSAGE_SIZE_LIMIT:=25M}" # 25 MB
 VARS[DEFAULT_RELAY_HOST]="${DEFAULT_RELAY_HOST:=}"
-VARS[DMS_DEBUG]="${DMS_DEBUG:=0}"
 VARS[DOVECOT_INET_PROTOCOLS]="${DOVECOT_INET_PROTOCOLS:=all}"
 VARS[DOVECOT_MAILBOX_FORMAT]="${DOVECOT_MAILBOX_FORMAT:=maildir}"
 VARS[DOVECOT_TLS]="${DOVECOT_TLS:=no}"

test/default_relay_host.bats

@@ -9,7 +9,6 @@ function setup() {
 		-e DEFAULT_RELAY_HOST=default.relay.host.invalid:25 \
 		--cap-add=SYS_PTRACE \
 		-e PERMIT_DOCKER=host \
-		-e DMS_DEBUG=0 \
 		-h mail.my-domain.com -t "${NAME}"
     wait_for_finished_setup_in_container mail_with_default_relay
 }

test/helper-functions.bats

@@ -8,7 +8,6 @@ function setup_file() {
         -v "${PRIVATE_CONFIG}":/tmp/docker-mailserver \
         -v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
         -e ENABLE_FETCHMAIL=1 \
-        -e DMS_DEBUG=0 \
         -h mail.my-domain.com -t "${NAME}"
     wait_for_finished_setup_in_container mail_helper_functions
 }

test/mail_changedetector.bats

@@ -11,7 +11,6 @@ function setup_file() {
   docker run -d --name mail_changedetector_one \
   -v "${PRIVATE_CONFIG}":/tmp/docker-mailserver \
   -v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
-  -e DMS_DEBUG=1 \
   -e LOG_LEVEL=trace \
   -h mail.my-domain.com -t "${NAME}"
   wait_for_finished_setup_in_container mail_changedetector_one
@@ -19,7 +18,6 @@ function setup_file() {
   docker run -d --name mail_changedetector_two \
   -v "${PRIVATE_CONFIG}":/tmp/docker-mailserver \
   -v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
-  -e DMS_DEBUG=1 \
   -e LOG_LEVEL=trace \
   -h mail.my-domain.com -t "${NAME}"
   wait_for_finished_setup_in_container mail_changedetector_two

test/mail_disabled_clamav_spamassassin.bats

@@ -8,7 +8,6 @@ setup_file() {
 		  -v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
 		  -e ENABLE_CLAMAV=0 \
 		  -e ENABLE_SPAMASSASSIN=0 \
-		  -e DMS_DEBUG=0 \
 		  -e AMAVIS_LOGLEVEL=2 \
 		  -h mail.my-domain.com -t "${NAME}"
     # TODO: find a better way to know when we have waited long enough

test/mail_fetchmail.bats

@@ -8,7 +8,6 @@ function setup_file() {
 		-v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
 		-e ENABLE_FETCHMAIL=1 \
 		--cap-add=NET_ADMIN \
-		-e DMS_DEBUG=0 \
 		-h mail.my-domain.com -t "${NAME}"
     wait_for_finished_setup_in_container mail_fetchmail
 }

test/mail_fetchmail_parallel.bats

@@ -9,7 +9,6 @@ function setup_file() {
 		-e ENABLE_FETCHMAIL=1 \
 		-e FETCHMAIL_PARALLEL=1 \
 		--cap-add=NET_ADMIN \
-		-e DMS_DEBUG=0 \
 		-h mail.my-domain.com -t "${NAME}"
     wait_for_finished_setup_in_container mail_fetchmail_parallel
 }

test/mail_hostname.bats

@@ -8,7 +8,6 @@ function setup_file() {
 		-v "${PRIVATE_CONFIG}":/tmp/docker-mailserver \
 		-v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
 		-e PERMIT_DOCKER=network \
-		-e DMS_DEBUG=0 \
 		-e ENABLE_SRS=1 \
 		-e OVERRIDE_HOSTNAME=mail.my-domain.com \
 		-h unknown.domain.tld \
@@ -20,7 +19,6 @@ function setup_file() {
 		-v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
 		-e PERMIT_DOCKER=network \
 		-e ENABLE_SRS=1 \
-		-e DMS_DEBUG=0 \
 		--hostname domain.com \
     --domainname domain.com \
 		-t "${NAME}"
@@ -30,7 +28,6 @@ function setup_file() {
     -v "${PRIVATE_CONFIG_THREE}":/tmp/docker-mailserver \
     -v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
     -e PERMIT_DOCKER=network \
-    -e DMS_DEBUG=0 \
     -e ENABLE_SRS=1 \
     -e SRS_DOMAINNAME='srs.my-domain.com' \
     --domainname 'my-domain.com' \
@@ -42,7 +39,6 @@ function setup_file() {
     -v "${PRIVATE_CONFIG_FOUR}":/tmp/docker-mailserver \
     -v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
     -e PERMIT_DOCKER=network \
-    -e DMS_DEBUG=0 \
     -e ENABLE_SRS=1 \
     --domainname 'my-domain.com' \
     --hostname 'mail' \

test/mail_lmtp_ip.bats

@@ -8,7 +8,6 @@ setup_file() {
     -v "${PRIVATE_CONFIG}":/tmp/docker-mailserver \
     -v "${PRIVATE_ETC}":/etc/dovecot \
     -v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
-    -e DMS_DEBUG=0 \
     -e ENABLE_POSTFIX_VIRTUAL_TRANSPORT=1 \
     -e POSTFIX_DAGENT=lmtp:127.0.0.1:24 \
     -e PERMIT_DOCKER=container \

test/mail_pop3.bats

@@ -6,7 +6,6 @@ function setup_file() {
     docker run -d --name mail_pop3 \
     -v "${PRIVATE_CONFIG}":/tmp/docker-mailserver \
     -v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
-    -e DMS_DEBUG=0 \
     -e ENABLE_POP3=1 \
     -e PERMIT_DOCKER=container \
     -h mail.my-domain.com -t "${NAME}"

test/mail_privacy.bats

@@ -10,7 +10,6 @@ function setup_file() {
     -e ENABLE_MANAGESIEVE=1 \
     --cap-add=SYS_PTRACE \
     -e PERMIT_DOCKER=host \
-    -e DMS_DEBUG=0 \
     -h mail.my-domain.com \
     -e SSL_TYPE='snakeoil' \
     --tty \

test/mail_quotas_disabled.bats

@@ -11,7 +11,6 @@ function setup_file() {
     docker run -d --name mail_no_quotas \
               -v "${PRIVATE_CONFIG}":/tmp/docker-mailserver \
               -v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
-              -e DMS_DEBUG=0 \
               -e ENABLE_QUOTAS=0 \
               -h mail.my-domain.com -t "${NAME}"
 

test/mail_smtponly.bats

@@ -8,7 +8,6 @@ function setup_file() {
               -v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
               -e SMTP_ONLY=1 \
               -e PERMIT_DOCKER=network \
-              -e DMS_DEBUG=0 \
               -e OVERRIDE_HOSTNAME=mail.my-domain.com \
               -t "${NAME}"
 

test/mail_special_use_folders.bats

@@ -11,7 +11,6 @@ setup_file() {
                 -e ENABLE_SPAMASSASSIN=0 \
                 --cap-add=SYS_PTRACE \
                 -e PERMIT_DOCKER=host \
-                -e DMS_DEBUG=0 \
                 -h mail.my-domain.com -t "${NAME}"
     wait_for_smtp_port_in_container mail_special_use_folders
 }

test/mail_ssl_letsencrypt.bats

@@ -105,11 +105,9 @@ function teardown() {
     cp "${LOCAL_BASE_PATH}/ecdsa.acme.json" "${TEST_TMP_CONFIG}/letsencrypt/acme.json"
 
     # TODO: Provision wildcard certs via Traefik to inspect if `example.test` non-wildcard is also added to the cert.
-    # `DMS_DEBUG=1` required for catching logged `inf` output.
     # shellcheck disable=SC2034
     local TEST_DOCKER_ARGS=(
       --volume "${TEST_TMP_CONFIG}/letsencrypt/acme.json:/etc/letsencrypt/acme.json:ro"
-      --env DMS_DEBUG=1
       --env LOG_LEVEL='trace'
       --env PERMIT_DOCKER='container'
       --env SSL_DOMAIN='*.example.test'

test/mail_ssl_manual.bats

@@ -21,7 +21,6 @@ function setup_file() {
     docker run -d --name mail_manual_ssl \
         --volume "${PRIVATE_CONFIG}/:/tmp/docker-mailserver/" \
         --volume "$(pwd)/test/test-files/ssl/${DOMAIN_SSL_MANUAL}/with_ca/ecdsa/:/config/ssl/:ro" \
-        --env DMS_DEBUG=1 \
         --env LOG_LEVEL='trace' \
         --env SSL_TYPE='manual' \
         --env TLS_LEVEL='modern' \

test/mail_tls_dhparams.bats

@@ -101,7 +101,6 @@ function common_container_setup() {
     docker run -d --name mail_dhparams \
         -v "${PRIVATE_CONFIG}:/tmp/docker-mailserver" \
         -v "$(pwd)/test/test-files:/tmp/docker-mailserver-test:ro" \
-        -e DMS_DEBUG=0 \
         -e ONE_DIR="${DMS_ONE_DIR}" \
         -h mail.my-domain.com \
         --tty \

test/mail_undef_spam_subject.bats

@@ -30,7 +30,6 @@ function setup() {
                           -e ENABLE_MANAGESIEVE=1 \
                           --cap-add=SYS_PTRACE \
                           -e PERMIT_DOCKER=host \
-                          -e DMS_DEBUG=0 \
                           -h mail.my-domain.com -t "${NAME}")
     wait_for_finished_setup_in_container mail_undef_spam_subject
     wait_for_finished_setup_in_container "${CONTAINER}"

test/mail_with_imap.bats

@@ -7,7 +7,6 @@ setup_file() {
     docker run -d --name mail_with_imap \
     -v "${PRIVATE_CONFIG}":/tmp/docker-mailserver \
     -v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
-    -e DMS_DEBUG=0 \
     -e ENABLE_SASLAUTHD=1 \
     -e POSTMASTER_ADDRESS=postmaster@localhost.localdomain \
     -e SASLAUTHD_MECH_OPTIONS=127.0.0.1 \

test/mail_with_ldap.bats

@@ -29,7 +29,6 @@ function setup_file() {
   docker run -d --name mail_with_ldap \
     -v "${PRIVATE_CONFIG}:/tmp/docker-mailserver" \
     -v "$(pwd)/test/test-files:/tmp/docker-mailserver-test:ro" \
-    -e DMS_DEBUG=0 \
     -e DOVECOT_PASS_FILTER="(&(objectClass=PostfixBookMailAccount)(uniqueIdentifier=%n))" \
     -e DOVECOT_TLS=no \
     -e DOVECOT_USER_FILTER="(&(objectClass=PostfixBookMailAccount)(uniqueIdentifier=%n))" \

test/mail_with_mdbox.bats

@@ -12,7 +12,6 @@ setup_file() {
                 -e DOVECOT_MAILBOX_FORMAT=mdbox \
                 --cap-add=SYS_PTRACE \
                 -e PERMIT_DOCKER=host \
-                -e DMS_DEBUG=0 \
                 -h mail.my-domain.com -t "${NAME}"
     wait_for_smtp_port_in_container mail_with_mdbox_format
 }

test/mail_with_postgrey.bats

@@ -6,7 +6,6 @@ function setup_file() {
     docker run -d --name mail_with_postgrey \
               -v "${PRIVATE_CONFIG}":/tmp/docker-mailserver \
               -v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
-              -e DMS_DEBUG=0 \
               -e ENABLE_DNSBL=1 \
               -e ENABLE_POSTGREY=1 \
               -e PERMIT_DOCKER=container \

test/mail_with_postgrey_disabled_by_default.bats

@@ -6,7 +6,6 @@ function setup() {
     CONTAINER=$(docker run -d \
                           -v "${PRIVATE_CONFIG}":/tmp/docker-mailserver \
                           -v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
-                          -e DMS_DEBUG=0 \
                           -h mail.my-domain.com -t "${NAME}")
     # using postfix availability as start indicator, this might be insufficient for postgrey
     wait_for_smtp_port_in_container "${CONTAINER}"

test/mail_with_relays.bats

@@ -15,7 +15,6 @@ function setup_file() {
             -e RELAY_PASSWORD=smtp_password \
             --cap-add=SYS_PTRACE \
             -e PERMIT_DOCKER=host \
-            -e DMS_DEBUG=0 \
             -h mail.my-domain.com -t "${NAME}"
         wait_for_finished_setup_in_container mail_with_relays
 }

test/mail_with_sdbox.bats

@@ -12,7 +12,6 @@ setup_file() {
                 -e DOVECOT_MAILBOX_FORMAT=sdbox \
                 --cap-add=SYS_PTRACE \
                 -e PERMIT_DOCKER=host \
-                -e DMS_DEBUG=0 \
                 -h mail.my-domain.com -t "${NAME}"
     wait_for_smtp_port_in_container mail_with_sdbox_format
 }

test/open_dkim.bats

@@ -19,7 +19,6 @@ function setup_file
 		-v "${PWD}/test/test-files":/tmp/docker-mailserver-test:ro \
 		-e DEFAULT_RELAY_HOST=default.relay.host.invalid:25 \
 		-e PERMIT_DOCKER=host \
-		-e DMS_DEBUG=0 \
 		-e LOG_LEVEL='trace' \
 		-h mail.my-domain.com \
     -t "${IMAGE_NAME}"

test/permit_docker.bats

@@ -14,7 +14,6 @@ setup_file() {
 					-v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
 					-e SMTP_ONLY=1 \
 					-e PERMIT_DOCKER=connected-networks \
-					-e DMS_DEBUG=0 \
 					-e OVERRIDE_HOSTNAME=mail.my-domain.com \
 					--network "${NON_DEFAULT_DOCKER_MAIL_NETWORK_NAME}" \
 					-t "${NAME}"
@@ -26,7 +25,6 @@ setup_file() {
 				-v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
 				-e SMTP_ONLY=1 \
 				-e PERMIT_DOCKER=connected-networks \
-				-e DMS_DEBUG=0 \
 				-e OVERRIDE_HOSTNAME=mail.my-domain.com \
 				--network "${NON_DEFAULT_DOCKER_MAIL_NETWORK_NAME}2" \
 				-t "${NAME}"
@@ -40,7 +38,6 @@ setup_file() {
 				-v "$(pwd)/test/test-files":/tmp/docker-mailserver-test:ro \
 				-e SMTP_ONLY=1 \
 				-e PERMIT_DOCKER=none \
-				-e DMS_DEBUG=0 \
 				-e OVERRIDE_HOSTNAME=mail.my-domain.com \
 				-t "${NAME}"
 

test/security_tls_cipherlists.bats

@@ -103,7 +103,6 @@ function collect_cipherlist_data() {
     run docker run -d --name tls_test_cipherlists \
         --volume "${PRIVATE_CONFIG}/:/tmp/docker-mailserver/" \
         --volume "${TLS_CONFIG_VOLUME}" \
-        --env DMS_DEBUG=0 \
         --env ENABLE_POP3=1 \
         --env SSL_TYPE="manual" \
         --env SSL_CERT_PATH="/config/ssl/cert.${KEY_TYPE}.pem" \

test/tests.bats

@@ -15,7 +15,6 @@ setup_file() {
     -v "$(pwd)/test/onedir":/var/mail-state \
     -e AMAVIS_LOGLEVEL=2 \
     -e CLAMAV_MESSAGE_SIZE_LIMIT=30M \
-    -e DMS_DEBUG=0 \
     -e ENABLE_CLAMAV=1 \
     -e ENABLE_MANAGESIEVE=1 \
     -e ENABLE_QUOTAS=1 \