github-com-docker-mailserver/docker-mailserver
1
0
Fork 0
mirror of https://github.com/docker-mailserver/docker-mailserver.git synced 2024-01-19 02:48:50 +00:00
Code Issues Projects Releases Wiki Activity
docker-mailserver/CHANGELOG.md

40 KiB
Raw Blame History

Changelog

v11.1.0

In this release the relay-host support saw significant internal refactoring in preparation for a future breaking change. Similar extensive restructuring through the codebase also occurred, where each PR provides more details. Care was taken to avoid breakage, but there may be some risk affecting unsupported third-party customizations which our test suite is unaware of.

Features

Fixes

  • Using Port 465 to authenticate with a relay-host no longer breaks the Amavis transport for Postfix (#2607)
  • When mounting /var/mail-state, disabled services will no longer copy over data redundantly (#2608)
  • Amavis is now aware of new domains detected during Change Detection, no longer skipping virus and spam filtering (#2616)
  • setup.sh -c <container name> no longer ignores <container name> when more than 1 docker-mailserver container is running (#2622)

Improvements

  • The Change Detector service will now only process relevant changes (#2615), in addition to now monitoring postfix-sasl-password.cf, postfix-relaymap.cf, and postfix-regexp.cf (#2623)
  • For LDAP users that only need to support a single mail domain, setup config dkim should now detect the domain implicitly (#2620)
  • The container capability SYS_PTRACE is no longer necessary (#2624)
  • Added an example for configuring a basic container healthcheck command (#2625)
  • Postfix main.cf setting compatibility_level was set to 2 during our startup scripts. This is now part of our default shipped main.cf config (#2597)
  • The Postfix main.cf override/extension support via postfix-main.cf has been improved to support multi-line values, instead of the previous single-line only support (#2598)

Deprecation Notice

  • SASL_PASSWD ENV An old ENV SASL_PASSWD has been around for supporting relay-host authentication, but since superceded by the postfix-sasl-password.cf config file. It will be removed in a future major release as detailed here.

  • Platform Support - ARMv7 This is a very old platform, superceded by ARMv8 and newer with broad product availability around 2016 onwards. Support was introduced primarily for users the older generations of Raspberry Pi. ARM64 is the modern target for ARM devices.

    If you require ARMv7 support, please let us know.

v11.0.0

Major Changes

  1. Internal logging has been refactored. The environment variable DMS_DEBUG has been replaced by LOG_LEVEL to better control the verbosity of logs we output. The new logger is more structured and follows standard log conventions. LOG_LEVEL can be set to: error, warn, info (default), debug and trace.
  2. iptables has been replaced by nftables. The Fail2Ban configuration was adjusted accordingly. If you use iptables yourself (e.g. in user-patches.sh), make sure to update the scripts.
  3. PERMIT_DOCKER has a new default value of none. This change better secures Podman; to keep the old behaviour (adding the container IP address to Postfix's mynetworks), use PERMIT_DOCKER=container.

Minor Changes

  1. Many minor improvements were made (cleanup & refactoring). Please refer to the section below to get an overview over all improvements. Moreover, there was a lot of cleanup in the scripts and in the tests. The documentation was adjusted accordingly.
  2. New environment variables were added:
    1. CLAMAV_MESSAGE_SIZE_LIMIT
    2. TZ
  3. SpamAssassin KAM was added with ENABLE_SPAMASSASSIN_KAM.
  4. The fail2ban command was reworked and can now ban IP addresses as well.
  5. There were a few small fixes, especially when it comes to bugs in scripts and service restart loops (no functionality changes, only fixes of existing functionality). When building an image from the Dockerfile - Installation of Postfix on modern Linux distributions should now always succeed.
  6. Some default values for environment values changed: these are mostly non-critical, please refer to #2428 and #2487.

Merged Pull Requests

  • [improvement] tests: remove legacy functions / tests by @casperklein in #2434
  • [improvement] PERMIT_DOCKER=none as new default value by @casperklein in #2424
  • [improvement] Adjust environment variables to more sensible defaults by @georglauterbach in #2428
  • [fix] macOS linting support by @NorseGaud in #2448
  • [improvement] Rename config examples directory by @casperklein in #2438
  • [docs] FAQ - Update naked/bare domain section by @sportshead in #2446
  • [improvement] Remove obsolete setup.sh debug inspect command from usage description by @casperklein in #2454
  • [feature] Introduce CLAMAV_MESSAGE_SIZE_LIMIT env by @casperklein in #2453
  • [fix] remove SA reload for KAM by @georglauterbach in #2456
  • [docs] Enhance logrotate description by @casperklein in #2469
  • [improvement] Remove macOS specific code / support + shellcheck should avoid python, regardless of permissions by @NorseGaud in #2466
  • [docs] Update fail2ban.md by @casperklein in #2484
  • [fix] Makefile: Remove backup/restore of obsolete config directory by @casperklein in #2479
  • [improvement] scripts: small refactorings by @georglauterbach in #2485
  • [fix] Building on Ubuntu 21.10 failing to install postfix by @NorseGaud in #2468
  • [improvement] Use FQDN as REPORT_SENDER default value by @casperklein in #2487
  • [improvement] Improve test, get rid of sleep by @casperklein in #2492
  • [feature] scripts: new log by @georglauterbach in #2493
  • [fix] Restart supervisord early by @casperklein in #2494
  • [improvement] scripts: renamed function _errex -> _exit_with_error by @georglauterbach in #2497
  • [improvement] Remove invalid URL from SPF message by @casperklein in #2503
  • [improvement] scripts: refactored scripts located under target/bin/ by @georglauterbach in #2500
  • [improvement] scripts: refactoring & miscellaneous small changes by @georglauterbach in #2499
  • [improvement] scripts: refactored daemon-stack.sh by @georglauterbach in #2496
  • [fix] add compatibility for Bash 4 to setup.sh by @georglauterbach in #2519
  • [fix] tests: disabled "quota exceeded" test by @georglauterbach in #2511
  • [fix] typo in setup-stack.sh by @eltociear in #2521
  • [improvement] scripts: introduce _log to sedfile by @georglauterbach in #2507
  • [feature] create .github/FUNDING.yml by @georglauterbach in #2512
  • [improvement] scripts: refactored check-for-changes.sh by @georglauterbach in #2498
  • [improvement] scripts: remove DMS_DEBUG by @georglauterbach in #2523
  • [feature] firewall: replace iptables with nftables by @georglauterbach in #2505
  • [improvement] log: adjust level and message(s) slightly for four messages by @georglauterbach in #2532
  • [improvement] log: introduce proper log level fallback and env getter function by @georglauterbach in #2506
  • [feature] scripts: added TZ environment variable to set timezone by @georglauterbach in #2530
  • [improvement] setup: added grace period for account creation by @georglauterbach in #2531
  • [improvement] refactor: letsencrypt implicit location discovery by @polarathene in #2525
  • [improvement] setup.sh/setup: show usage when no argument is given by @casperklein in #2540
  • [improvement] Dockerfile: Remove not needed ENVs and add comment by @casperklein in #2541
  • [improvement] chore: (setup-stack.sh) Fix a small typo by @polarathene in #2552
  • [feature] Add ban feature to fail2ban script by @casperklein in #2538
  • [fix] Fix changedetector restart loop by @casperklein in #2548
  • [improvement] chore: Drop setup.sh DATABASE fallback ENV by @polarathene in #2556

v10.5.0

Critical Changes

  1. This release fixes a critical issue for LDAP users, installing a needed package on Debian 11 on build-time. Moreover, a race-condition was eliminated (#2341).
  2. A resource leak in check-for-changes.sh was fixed (#2401)

Other Minor Changes

  1. SPAMASSASSIN_SPAM_TO_INBOX's default changed to 1. (#2361)
  2. Changedetector functionality was added to SSL_TYPE=manual-setups. (#2404)
  3. Four new environment variables were introduced: LOGWATCH_SENDER, ENABLE_DNSBL, DOVECOT_INET_PROTOCOLS and ENABLE_SPAMASSASSIN_KAM. (#2362, #2342, #2358, #2418)
  4. There are plenty of bug fixes and documentation enhancements with this release.

Merged Pull Requests

  • [fix] added libldap-common to packages in Dockerfile in #2341
  • [fix] Prevent race condition on supervisorctl reload in #2343
  • [docs] Update links to dovecot docs in #2351
  • [fix] tests(fix): Align with upstream testssl field name change in #2353
  • [improvement] Make TLS tests more reliable in #2354
  • [feature] Introduce ENABLE_DNSBL env in #2342
  • [feature] Introduce DOVECOT_INET_PROTOCOLS env in #2358
  • [fix] Fix harmless startup errors in #2357
  • [improvement] Add tests for sedfile wrapper in #2363
  • [feature] add env var LOGWATCH_SENDER in #2362
  • [fix] Fixed non-number-argument in listmailuser in #2382
  • [fix] docs: Fail2Ban - Fix links for rootless podman in #2384
  • [fix] docs(kubernetes): fix image name in example in #2385
  • [fix] SSL documentation contains a small bug #2381 by @Twist235 in #2383
  • [fix] get rid of subshell + exec in helper-functions.sh in #2401
  • [docs] Rootless Podman security update by @p-fruck in #2393
  • [fix] fix: double occurence of /etc/postfix/regexp in #2397
  • [improvement] consistently make 1 the default value for SPAMASSASSIN_SPAM_TO_INBOX in #2361
  • [docs] added sieve example for subaddress sorting in #2410
  • [feature] Add changedetector functionality for ${SSL_TYPE} == manual in #2404
  • [docs] docs(deps): bump mkdocs-material to v8.2.1 in #2422
  • [feature] Add SpamAssassin KAM in #2418
  • [improvement] refactoring: split helper functions into smaller scripts in #2420
  • [fix] fix: do not add accounts that already exists to account files in #2419

v10.4.0

This release upgrades our base image from Debian 10 to Debian 11.
There is also an important regression fixed for SSL_TYPE=letsencrypt users.

  • [fix] A regression with check-for-changes.sh introduced in v10.3.0 affected SSL_TYPE=letsencrypt, preventing detection of cert renewals to restart services (unless using acme.json) #2326
  • [improvement] Base image upgraded from Debian 10 Buster to Debian 11 Bullseye #2116
    • Postfix upgraded from 3.4 to 3.5. Dovecot upgraded from 2.3.4 to 2.3.13. Python 2 is no longer included in the image, Python 3 remains (more information).
    • yescrypt is now supported upstream as a password hash algorithm, docker-mailserver continues to use SHA512-CRYPT (more information).
  • [chore] Dovecot statistics service disabled #2292

v10.3.0

WARNING: This release had a small regression affecting the detection of changes for certificates provisioned in /etc/letsencrypt with the config ENV SSL_TYPE=letsencrypt, unless you use Traefik's acme.json. If you rely on this functionality to restart Postfix and Dovecot when updating your cert files, this will not work and it is advised to upgrade to v10.4.0 or newer prior to renewal of your certificates.

  • [fix] The Dovecot userdb will now additionally create "dummy" accounts for basic alias maps (alias maps to a single real account managed by Dovecot, relaying to external providers aren't affected) when ENABLE_QUOTAS=1 (default) as a workaround for Postfix quota-status plugin querying Dovecot with inbound mail for a user, which Postfix uses to reject mail if quota has been exceeded (to avoid risk of blacklisting from spammers abusing backscatter) #2248
    • NOTE: If using aliases that map to another alias or multiple addresses, this remains a risk.
  • [fix] setup email list command will no longer attempt to query Dovecot quota status when ENABLE_QUOTAS is disabled #2264
  • [fix] SSL_DOMAIN ENV should now work much more reliably #2274, #2278, #2279
  • [fix] DKIM - Removed refile: (regex type) from KeyTable entry in opendkim.conf, fixes validation error output from opendkim-testkey #2249
  • [fix] DMARC - Removed quotes around the hostname value in opendmarc.conf. This avoids an authentication failure where an OpenDKIM header was previously ignored #2291
  • [fix] When using ONE_DIR=1 (default), the spool-postfix folder now has the correct permissions carried over. This resolves some failures notably with sieve filters #2273
  • [improvement] Warnings are now logged for ClamAV and SpamAssassin if they are enabled but Amavis is disabled (which is required for them to work correctly) #2251
  • [improvement] user-patches.sh is now invoked via bash to assist Kubernetes deployments with ConfigMap #2295

Internal

These changes are primarily internal and are only likely relevant to users that maintain their own modifications related to the changed files.

  • [chore] Redundant config from Postfix master.cf has been removed, it should not affect any users as our images have not included any of the related processes #2272
  • [refactor] check-for-changes.sh was carrying some duplicate code from setup-stack.sh that was falling out of sync, they now share common code #2260
  • [refactor] acme.json extraction was refactored into a CLI utility and updated to Python 3 (required for future upgrade to Debian 11 Bullseye base image) #2274
  • [refactor] As part of the Traefik acme.json and SSL_DOMAIN work, logic for SSL_TYPE=letsencrypt was also revised #2278
  • [improvement] Some minor tweaks to how we derive the internal HOSTNAME and DOMAINNAME from user configured hostname and domainname settings #2280

v10.2.0

  • You no longer need to maintain a copy of setup.sh matching your version release from v10.2 of docker-mailserver onwards. Version specific functionality of setup.sh has moved into the container itself, while setup.sh remains as a convenient wrapper to: docker exec -it <container name> setup <command>.
  • ONE_DIR now defaults to enabled (1).
  • For anyone relying on internal location of certificates (internal copy of mounted files at startup), the Postfix and Dovecot location of /etc/postfix/ssl has changed to /etc/dms/tls. This may affect any third-party user-patches.sh scripts that depended on this path to update certs.
  • The Let's Encrypt section of our SSL / TLS docs has been brought up to date.

Bigger scripts-related improvements

  • [scripts] update setup.sh to now use a running container first if one exists #2134
  • [scripts] included setup.sh functionality inside the container to be version independent again #2174
  • [scripts] HOSTNAME and DOMAINNAME setup improved #2175
  • [scripts] delmailuser can now delete mailboxed without TLD #2172
  • [scripts] properly exit on failure (#2199 in conjunction with #2196)
  • [scripts] make setup.sh completely non-interactive for Podman users #2201

Security

Some internal refactoring and fixes happened this release cycle in #2196:

  • [improve] The Postfix and Dovecot location of /etc/postfix/ssl has changed to /etc/dms/tls
  • [improve] An invalid SSL_TYPE or a valid value with an invalid configuration will now panic, exiting the container and emitting a fatal error to the logs
  • [fix] An unconfigured/empty SSL_TYPE ENV now correctly disables SSL support for Dovecot and general Postfix configurations. A reminder that this is unsupported officially, and is only intended for tests and troubleshooting. Use only a valid SSL_TYPE (letsencrypt and manual are recommended) for production deployments
  • [fix] TLS_LEVEL=intermediate now modifies the system (container) openssl.cnf config to set the minimum protocol to TLS 1.0 (from 1.2) and cipher-suite support to DEFAULT@SECLEVEL=1 (from 2). This change is required for Dovecot in upcoming Debian Bullseye upgrade, to be compatible with the TLS_LEVEL=intermediate cipher-suite profile. It may affect other software within the container that relies on this openssl config, should you extend the Docker image #2193
  • [fix] Provide DH parameters (default: RFC 7919 group ffdhe406.pem) at build-time, instead of during startup. Custom DH parameters regardless of ONE_DIR are now only detected when mounted to /tmp/docker-mailserver/dhparams.pem #2192
  • [docs] Revise the Let's Encrypt section of our SSL / TLS docs #2209

Miscellaneous small additions and changes

  • [ci] improved caching #2197
  • [ci] refactored spam tests and introduced common container setup template #2198
  • [fix] update Fail2Ban wrapper to propagate errors to user #2170
  • [fix] Dockerfile sed's are now checked #2158
  • [general] Updated default value of ONE_DIR to 1 #2148
  • [docs] updated Kubernetes documentation #2111
  • [docs] introduced dedicated Podman documentation #2179
  • [docs] miscellaneous documentation improvements
  • [misc] introduced GitHub issue forms for issue templates #2160
  • [misc] Removed the internal mkcert.sh script for Dovecot as it is no longer needed #2196

v10.1.2

This is bug fix release. It reverts a regression introduced with #2104.

v10.1.1

This release mainly improves on v10.1.0 with small bugfixes/improvements and dependency updates

  • [feat] Add logwatch maillog.conf file to support /var/log/mail/ (#2112)
  • [docs] CONTRIBUTORS.md now also shows every code contributor from the past (#2143)
  • [improve] Avoid chmod +x when not needed (#2127)
  • [improve] check-for-changes: performance improvements (#2104)
  • [dependency] Update various dependencies through docs and base image
  • [security] This release contains also security fixes for OpenSSL

v10.1.0

This release mainly improves on v10.0.0 with many bugfixes.

v10.0.0

This release improves on 9.1.0 in many aspect, including general fixes, Fail2Ban, LDAP and documentation. This release contains breaking changes.

  • [general] Fixed many prose errors (spelling, grammar, indentation).
  • [general] Documentation is better integrated into the development process and it's visibility within the project increased (#1878).
  • [general] Added stop_grace_period: to example Compose file and supervisord (#1896 #1945)
  • [general] ./setup.sh email list was enhanced, now showing information neatly (#1898)
  • [general] Added update check and notification (#1976, #1951)
  • [general] Moved environment variables to the documentation and improvements (#1948, #1947, #1931)
  • [security] Major Fail2Ban improvements (cleanup, update and breaking changes, see below)
  • [fix] ./setup.sh email del ... now works properly
  • [code] Added color variables to setup.sh and improved the script as a whole (#1879, #1886)
  • [ldap] Added LDAP_QUERY_FILTER_SENDERS (#1902)
  • [ldap] Use dovecots LDAP uris connect option instead of hosts (#1901)
  • [ldap] Complete rework of LDAP documentation (#1921)
  • [docs] PRs that contain changes to docs will now be commented with a preview link (#1988)

Breaking Changes

  • [security] Fail2Ban adjustments:
    • Fail2ban v0.11.2 is now used (#1965).
    • The previous F2B config (from an old Debian release) has been replaced with the latest default config for F2B shipped by Debian 10.
    • The new default blocktype is now DROP, not REJECT (#1914).
    • A ban now applies to all ports (iptables-allports), not just the ones that were "attacked" (#1914).
    • Fail2ban 0.11 is totally compatible to 0.10, but the database got some new tables and fields (auto-converted during the first start), so once updated to DMS 10.0.0, you have to remove the database mailstate:/lib-fail2ban/fail2ban.sqlite3 if you would need to downgrade to DMS 9.1.0 for some reason.
  • [ldap] Removed SASLAUTHD_LDAP_SSL. Instead provide a protocol in SASLAUTHD_LDAP_SERVER and adjust SASLAUTHD_LDAP_ default values (#1989).
  • [general] Removed stable release tag (#1975):
    • Scheduled builds are now based off edge.
    • Instead of stable, please use the latest version tag available (or the latest tag).
    • The stable image tag will be removed from DockerHub in the near future.
  • [setup] Removed ./setup config ssl command (deprecated since v9). SSL_TYPE=self-signed remains supported however. (dc8f49de, #2021)

v9.1.0

This release marks the breakpoint where the wiki was transferred to a reworked documentation

v9.0.1

A small update on the notification function which was made more stable as well as minor fixes.

  • [fix] _notify cannot fail anymore - non-zero returns lead to unintended behavior in the past when DMS_DEBUG was not set or 0
  • [refactor] check-for-changes.sh now uses _notify

v9.0.0

  • [feat] Support extra user_attributes in accounts configuration (#1792)
  • [feat] Add possibility to use a custom dkim selector (#1811)
  • [feat] TLS: Dual (aka hybrid) certificate support! (eg ECDSA certificate with an RSA fallback for broader compatibility) (#1801).
    • This feature is presently only for SSL_TYPE=manual, all you need to do is provide your fallback certificate to the SSL_ALT_CERT_PATH and SSL_ALT_KEY_PATH ENV vars, just like your primary certificate would be setup for manual mode.
  • [security] TLS: You can now use ECDSA certificates! (#1802)
    • Warning: ECDSA may not be supported by legacy systems (most pre-2014). You can provide an RSA certificate as a fallback.
  • [fix] TLS: For some docker-compose setups when restarting the docker-mailserver container, internal config state may have been persisted despite making changes that should reconfigure TLS (eg changing SSL_TYPE or replacing the certificate file) (#1801).
  • [refactor] Split start-mailserver.sh (#1820)
  • [fix] Linting now uses local path to remove the sudo dependency (#1831).

Breaking Changes

  • [security] TLS: TLS_LEVEL=modern has changed the server-side preference order to 128-bit before 256-bit encryption (#1802).
    • NOTE: This is still very secure but may result in misleading lower scores/grades from security audit websites.
  • [security] TLS: TLS_LEVEL=modern removed support for AES-CBC cipher suites and follows best practices by supporting only AEAD cipher suites (#1802).
    • NOTE: As TLS 1.2 is the minimum required for modern already, AEAD cipher suites should already be supported and preferred.
  • [security] TLS: TLS_LEVEL=intermediate has removed support for cipher suites using RSA for key exchange (only available with an RSA certificate) (#1802).
    • NOTE: This only affects Dovecot which supported 5 extra cipher suites using AES-CBC and AES-GCM. Your users MUA clients should be unaffected, preferring ECDHE or DHE for key exchange.
  • [refactor] Complete refactoring of opendkim script (#1812).
    • NOTE: Use ./setup.sh config dkim help to see the new syntax.

v8.0.1

This release is a hotfix for #1781.

  • [spam] bl.spamcop.net was removed from the list of spam lists since the domain expired and became unusable

v8.0.0

The transfer of the old repository to the new organization has completed. This release marks the new starting point for docker-mailserver in the docker-mailserver organization. Various improvements were made, small bugs fixed and the complete CI was transferred.

  • [general] transferred the whole repository to docker-mailserver/docker-mailserver
  • [general] adjusted README.md and split off ENVIRONMENT.md
  • [ci] usage of the GitHub Container Registry
  • [ci] switched from TravisCI to GitHub Actions for CI/CD
    • now building images for amd64 and arm/v7 and arm/64
    • integrated stale issues action to automatically close stale issues
    • adjusted issue templates
  • [build] completely refactored and improved the Dockerfile
  • [build] improved the Makefile
  • [image improvement] added a proper init process
  • [image improvement] improved logging significantly
  • [image improvement] major LDAP improvements
  • [bugfixes] miscellaneous bug fixes and improvements

Breaking changes of release 8.0.0

  • [image improvement] log-level now defaults to warn
  • [image improvement] DKIM default key size now 4096
  • [general] the :latest tag is now the latest release and :edge represents the latest push on master
  • [general] URL changed from tomav/... to docker-mailserver/...

v7.2.0

  • [scripts] refactored target/bin/
  • [scripts] redesigned environment variable use
  • [general] added Code of Conduct
  • [general] added missing Dovecot descriptions
  • [tests] enhanced and refactored all tests

v7.1.0

  • [scripts] use of default variables has changed slightly (consult environment variables)
  • [scripts] Added coherent coding style and linting
  • [scripts] Added option to use non-default network interface
  • [general] new contributing guidelines were added
  • [general] SELinux is now supported