Job offer: Upgrade DMS from v6.2.0 and configuration check need *CHANGED #4279

robertmonka · 2024-12-03T17:36:32Z

robertmonka
Dec 3, 2024

Hi,

I am looking for someone experienced with Docker Mailserver configuration. I need help upgrading a working server from version v6.2.0 The server is not very large, but maintaining data continuity is essential.
This would be a paid job. Is anyone here available to assist? I would be happy to discuss the details.

polarathene · 2024-12-03T20:43:17Z

polarathene
Dec 3, 2024
Maintainer

Are you really on v1.3?

I only joined the project late 2020 when migration from the original project author to an organization occurred (releases v8 and above since Jan 2021), while the original image tvial/docker-mailserver has no tag for v1.3, there is v1 and v2 (Dec 2016) tags.

It would seem the version you have does not actually exist officially? How old is your deployment?

From v8 we have a CHANGELOG to track breaking changes which should help from then onwards. However if you really have a version of DMS before Jan 2021 it's going to be important for you to establish your actual customizations from non-defaults.

The server is not very large, but maintaining data continuity is essential.

How many user accounts / mailboxes do you have? Aliases? If these are not much you should be able to re-create them manually, otherwise writing a script to adapt to any format changes should be viable. Your deployment presumably has the postfix-virtual.cf and postfix-accounts.cf configs, these changed a bit.

Are you using volume bind mounts, or named data volumes? Assuming your deployment has the same locations we use for persisting data via volumes:

/var/mail is the most important one to carry over your mail, it may need similar adjustments to layout due to breaking changes (like in v13).
/var/mail-state may not be important provided your mail server isn't too busy that the mail queue has items to preserve for the migration. Most of the content stored here should be disposable for the most part, but with a backup copy should you need to try keep any of the data to migrate that can still be an option. The plan is to move away from Amavis + SpamAssassin though in favor of rspamd, thus I don't know if there is much value in trying to keep any SPAM vs HAM learning.
/tmp/docker-mailserver should be a bind mount volume with all your configs, you would need to share these. Besides /var/mail it's the other more important volume for data persistence.
/var/log/mail shouldn't be that relevant to migrate. Keep the logs of your existing deployment as backup if you like, but should be fine to continue with fresh logs going forward.

If you use a .env file for ENV custom settings, or docker-compose.yml / compose.yaml with ENV specified in that, these will have had some breaking changes to accommodate for.

If the server you are running DMS on has not been kept updated, you'll want to address that. Our debugging / troubleshooting docs page details compatibility expectations. If you're really still running on a docker host from about 8 years ago that's absolutely something that should be updated, along with kernel and cgroups to v2.

TLS cipher suite compatibility has changed, if you have any old client device/software that is likewise not received updates/upgrades, it may have compatibility issues if it cannot use expected TLS 1.2 or TLS 1.3 cipher suites.

I can advise here in public as time permits, but I'm presently quite busy elsewhere.

While I can take on paid work, it's not what I would consider affordable as I charge considerably more to deviate to and prioritize new work.

3 replies

robertmonka Dec 3, 2024
Author

I've checked it again.
1.3 is local version of Docerfile

I found changelog where on the top is:

Changelog

6.2.0+

see https://github.com/tomav/docker-mailserver/releases

robertmonka Dec 3, 2024
Author

All users, aliases, and domains are stored in LDAP.
There are about 50 objects.
Everything is backed up.
The system (except for mail) is up to date.

polarathene Dec 3, 2024
Maintainer

see https://github.com/tomav/docker-mailserver/releases

That just redirects to the org repo now 😅

From the DockerHub tag history of that image, I can see that 6.2 was published Sep 2019.

LDAP changes

All users, aliases, and domains are stored in LDAP.

Ok, so good news is LDAP shouldn't have changed as much, bad news is we don't really have much maintainer experience with it, beyond a little bit I have.

v13 had some breaking changes to accommodate for:

docker-mailserver/CHANGELOG.md

Lines 318 to 322 in 10882f9

    
           ### Breaking 
        
           - **LDAP:** 
        
             - ENV `LDAP_SERVER_HOST`, `DOVECOT_URIS`, and `SASLAUTHD_LDAP_SERVER` will now log an error if the LDAP URI scheme is missing. Previously there was an implicit fallback to `ldap://` ([#3522](https://github.com/docker-mailserver/docker-mailserver/pull/3522)) 
        
             - `ENABLE_LDAP=1` is no longer supported, please use `ACCOUNT_PROVISIONER=LDAP` ([#3507](https://github.com/docker-mailserver/docker-mailserver/pull/3507))

v10 changed some LDAP ENV configuration:

docker-mailserver/CHANGELOG.md

Line 955 in 10882f9

    
           - **[ldap]** Removed `SASLAUTHD_LDAP_SSL`. Instead provide a protocol in `SASLAUTHD_LDAP_SERVER` and adjust `SASLAUTHD_LDAP_` default values ([#1989](https://github.com/docker-mailserver/docker-mailserver/pull/1989)).

v8 only states "major LDAP improvements" without much context as to what changed.

Changelog overview

Thus from the looks of it you should really only need to change ENABLE_LDAP=1 to ACCOUNT_PROVISIONER=LDAP.

If you have anything config related to SASLAUTHD, unless you have a good reason to use that you should not need any configuration related to that (so drop anything for that feature LDAP support does not depend upon it) and can rely on the default SASL provider (Dovecot).

Without knowing details of other explicit config changes you may have made, nothing else stands out from the breaking changes sections of our major releases in the changelog I linked.

We have not yet switched to rspamd, and my breaking LDAP changes have not landed yet either. Thus you should be able to upgrade to v14 with minimal worries if you don't have much other customizations I think.

Oh and make sure you refer to our compose.yaml example our repo. You should have the DMS FQDN set via the hostname setting, if you have any domainname setting remove that, it should all be in the single hostname setting. Likewise you should not have any HOSTNAME / DOMAINNAME ENV set.

Migration instructions

Thus with a backup copy of your data for safe keeping, you can setup another instance of DMS.

Switch your docker-mailserver.yml to compose.yaml, and ensure your docker host is running a Docker Compose release from at least 2023, it should be Compose v2 (docker-compose up is now docker compose up), ideally a 6.x series kernel but 5.x should be alright.
If your DMS could be reached by IPv6, please look at our IPv6 docs page for info on ensuring correct container configuration as most Docker releases by default will result in a security issue.
Add your DMS v6.2 /var/mail and /tmp/docker-mailserver volumes.
Preferably avoid an .env file if you have minimal config changes, just add them into the compose.yaml instead.
- Make sure ENABLE_LDAP=1 is changed to ACCOUNT_PROVISIONER=LDAP.
- Remove any SASLAUTHD ENV you may have configured as you likely don't need it.

You may want to test this directly before public DNS records would direct existing traffic to it. You have a few options for this:

A: Temporarily create DNS records and acquire a certificate for a separate FQDN.
1. That should work fine for IMAP, but not SMTP where MX and SPF records associated to your existing accounts will still resolve to the active DMS install.
2. You could use the same DNS records and certificate as your existing deployment, but publish non-standard ports if deploying on the same server. This way you just need to adjust the ports on your mail client accordingly.
B: A better approach is to run a local DNS resolver, so that you can substitute the existing DNS records only for your client interactions.
- This can allow you to test SMTP as well in a completely isolated container network.
- It is a bit more complicated for all DNS records, otherwise you can get away with a line in /etc/hosts AFAIK.

Verifying successful migration

Taking the A2 approach might be a good route for you to verify through your mail client that you can login and access all the mail in the DMS v14 instance via IMAP, confirming /var/mail + LDAP is working correctly. Next verify SMTP:

Any mail sent to submission ports 587 or 465 (or rather the alternative public ports you publish) should deliver internally for any mail domains DMS recognizes as managed by itself, otherwise they'll send out from port 25 (since it's on the same server and other config that should all function successfully too).
Finally to test mail delivery to port 25, your mail client or an alternative like swaks (CLI command) would need to set the published port explicitly to send mail to and that should deliver successfully too.
If everything seems in working order after that, you should be able to bring down the DMS v6.2 instance and adjust the DMS v14 published ports to the expected 25/587/465/etc.

That will at least ensure your important config and data migrated successfully. I may be forgetting something to consider but it should (along with your backups) provide more confidence in a migration being successful.

robertmonka · 2024-12-15T21:02:05Z

robertmonka
Dec 15, 2024
Author

I am looking for someone experienced to support that migration.

0 replies

robertmonka · 2024-12-21T21:24:48Z

robertmonka
Dec 21, 2024
Author

Before and after migration attempt

Docker Compose (old configuration)

services:
  mail:
    image: localhost/docker-mailserver:1.3
    build:
      context: .
    hostname: mail.example.com
    domainname: example.com
    container_name: mail-container
    restart: always
    dns: 192.168.1.2
    networks:
      openldap_internal:
      dns_internal:
      monitoring_internal:
        ipv4_address: 192.168.2.1
      internal:
        ipv4_address: 192.168.3.1
        aliases:
          - mail
          - smtp
          - third.example.com
    ports:
      - "25:25"
      - "110:110"
      - "143:143"
      - "465:465"
      - "587:587"
      - "993:993"
      - "995:995"
    volumes:
      - maildata:/var/mail
      - maillogs:/var/log/mail
      - ./config/:/tmp/docker-mailserver/
      - ./cron/sa-learn:/etc/cron.d/sa-learn
      - mailcert:/etc/letsencrypt
      - "/etc/timezone:/etc/timezone:ro"
      - "/etc/localtime:/etc/localtime:ro"
    env_file:
      - .env
      - env-mailserver
    cap_add:
      - NET_ADMIN
      - SYS_PTRACE

  letsencrypt:
    build:
      context: ./certbot
    image: localhost/letsencrypt:latest
    container_name: certbot
    restart: always
    volumes:
      - type: bind
        source: /c/srv/docker/volumes/mail/cert/
        target: /etc/letsencrypt
    networks:
      internal:
        ipv4_address: 192.168.3.2

  roundcube:
    image: localhost/roundcubemail:latest-apache
    container_name: roundcube
    restart: always
    volumes:
      - roundcube:/var/www/html
      - roundcube_db:/var/roundcube/db
      - "/etc/timezone:/etc/timezone:ro"
      - "/etc/localtime:/etc/localtime:ro"
      - ./config_roundcube/:/var/roundcube/config/
    environment:
      - ROUNDCUBEMAIL_DB_TYPE=sqlite
      - ROUNDCUBEMAIL_DEFAULT_HOST=ssl://third.example.com
      - ROUNDCUBEMAIL_DEFAULT_PORT=993
      - ROUNDCUBEMAIL_SMTP_SERVER=tls://third.example.com
      - ROUNDCUBEMAIL_SMTP_PORT=587
      - ROUNDCUBEMAIL_PLUGINS=archive,zipdownload,managesieve,markasjunk,password
    networks:
      internal:
        ipv4_address: 192.168.3.3
      openldap_internal:
      wireguard_internal:
        ipv4_address: 192.168.4.1
      traefik_internal:
        ipv4_address: 192.168.5.1

volumes:
  maildata:
    driver: local-persist
    driver_opts:
      mountpoint: /c/srv/docker/volumes/mail/data
  maillogs:
    driver: local-persist
    driver_opts:
      mountpoint: /c/srv/docker/volumes/mail/logs
  mailcert:
    driver: local-persist
    driver_opts:
      mountpoint: /c/srv/docker/volumes/mail/cert
  roundcube:
    driver: local-persist
    driver_opts:
      mountpoint: /c/srv/docker/volumes/mail/roundcube/www
  roundcube_db:
    driver: local-persist
    driver_opts:
      mountpoint: /c/srv/docker/volumes/mail/roundcube/db

networks:
  internal:
    ipam:
      config:
        - subnet: 192.168.3.0/24
  openldap_internal:
    external: true
  dns_internal:
    external: true
  traefik_internal:
    external: true
  wireguard_internal:
    external: true
  monitoring_internal:
    external: true

env file (old configuration)

# -----------------------------------------------------------------------------------------------------------------------------
# --------------------- General Settings --------------------------------------------------------------------------------------
# -----------------------------------------------------------------------------------------------------------------------------

# 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.
OVERRIDE_HOSTNAME=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

# 0 => Debug disabled
# 1 => Enables debug on startup
DMS_DEBUG=0

# 0 => mail state in default directories
# 1 => consolidate all states into a single directory (`/var/mail-state`) to allow persistence using docker volumes
ONE_DIR=1

# empty => postmaster@domain.com
# => Specify the postmaster address
POSTMASTER_ADDRESS=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

# 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://github.com/tomav/docker-mailserver/issues/1405#issuecomment-590106498
# empty => localhost only
# host => Add docker host (ipv4 only)
# network => Add all docker containers (ipv4 only)
# connected-networks => Add all connected docker networks (ipv4 only)
PERMIT_DOCKER=host

# empty => modern
# modern => Enables TLSv1.2 and modern ciphers only. (default)
# intermediate => Enables TLSv1, TLSv1.1 and TLSv1.2 and broad compatibility ciphers.
# old => NOT implemented. If you really need it, then customize the TLS ciphers overriding postfix and dovecot settings
#        (https://github.com/tomav/docker-mailserver/wiki/)
TLS_LEVEL=
#TLS_LEVEL=intermediate

# Configures the handling of creating mails with forged sender addresses.
#
# empty => (not recommended, but default for backwards compatibility reasons)
#           Mail address spoofing allowed. Any logged in user may create email messages with a forged sender address.
#           See also https://en.wikipedia.org/wiki/Email_spoofing
# 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.
SPOOF_PROTECTION=1

# 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
ENABLE_SRS=0

# 1 => Enables POP3 service
# empty => disables POP3
#ENABLE_POP3=
ENABLE_POP3=1
#ENABLE_CLAMAV=0
ENABLE_CLAMAV=1

# If you enable Fail2Ban, don't forget to add the following lines to your `docker-compose.yml`:
#    cap_add:
#      - NET_ADMIN
# Otherwise, `iptables` won't be able to ban IPs.
ENABLE_FAIL2BAN=1

# 1 => Enables Managesieve on port 4190
# empty => disables Managesieve
ENABLE_MANAGESIEVE=1

# **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.
POSTSCREEN_ACTION=enforce

# empty => all daemons start
# 1 => only launch postfix smtp
SMTP_ONLY=

# Please read [the SSL page in the wiki](https://github.com/tomav/docker-mailserver/wiki/Configure-SSL) for more information.
#
# empty => SSL disabled
# letsencrypt => Enables Let's Encrypt certificates
# custom => Enables custom certificates
# manual => Let's you manually specify locations of your SSL certificates for non-standard cases
# self-signed => Enables self-signed certificates
SSL_TYPE=letsencrypt

# Set how many days a virusmail will stay on the server before being deleted
# empty => 7 days
VIRUSMAILS_DELETE_DELAY=

# This Option is activating the Usage of POSTFIX_DAGENT to specify a lmtp client different from default dovecot socket.
# empty => disabled
# 1 => enabled
ENABLE_POSTFIX_VIRTUAL_TRANSPORT=

# 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_DAGENT=

# Set the mailbox size limit for all users. If set to zero, the size will be unlimited (default).
#
# empty => 0
POSTFIX_MAILBOX_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)
POSTFIX_MESSAGE_SIZE_LIMIT=30720000

# Enables regular pflogsumm mail reports.
# 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.
#
# not set => No report
# daily_cron => Daily report for the previous day
# logrotate => Full report based on the mail log when it is rotated
PFLOGSUMM_TRIGGER=daily_cron

# Recipient address for pflogsumm reports.
#
# not set => Use REPORT_RECIPIENT or POSTMASTER_ADDRESS
# => Specify the recipient address(es)
PFLOGSUMM_RECIPIENT=

# From address for pflogsumm reports.
#
# not set => Use REPORT_SENDER or POSTMASTER_ADDRESS
# => Specify the sender address
PFLOGSUMM_SENDER=

# Interval for logwatch report.
#
# none => No report is generated
# daily => Send a daily report
# weekly => Send a report every week
LOGWATCH_INTERVAL=daily

# Recipient address for logwatch reports if they are enabled.
#
# not set => Use REPORT_RECIPIENT or POSTMASTER_ADDRESS
# => Specify the recipient address(es)
LOGWATCH_RECIPIENT=

# Enables a report being sent (created by pflogsumm) on a regular basis. (deprecated)
# **0** => Report emails are disabled
# 1 => Using POSTMASTER_ADDRESS as the recipient
# => Specify the recipient address
REPORT_RECIPIENT=0

# Change the sending address for mail report (deprecated)
# **empty** => mailserver-report@hostname
# => Specify the report sender (From) address
REPORT_SENDER=

# Changes the interval in which 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 actually controls logrotate inside the container and rotates the log depending on this setting. The main log output is still available in its entirety 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/)
REPORT_INTERVAL=daily

# Choose TCP/IP protocols to use
# **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
POSTFIX_INET_PROTOCOLS=ipv4

# -----------------------------------------------------------------------------------------------------------------------------
# --------------------- Spamassassin section ----------------------------------------------------------------------------------
# -----------------------------------------------------------------------------------------------------------------------------

#ENABLE_SPAMASSASSIN=0
ENABLE_SPAMASSASSIN=1

#If Enabled, SPAM goes to your inbox with added SPAM header, you can then move it to a specific SPAM folder with SIEVE rules
#SPAMASSASSIN_SPAM_TO_INBOX=0
SPAMASSASSIN_SPAM_TO_INBOX=1

# add spam info headers if at, or above that level:
SA_TAG=2.0

# add 'spam detected' headers at that level
SA_TAG2=6.31

# triggers spam evasive actions
SA_KILL=6.31

# add tag to subject if spam detected
SA_SPAM_SUBJECT=***SPAM*****

# -----------------------------------------------------------------------------------------------------------------------------
# --------------------- Fetchmail section -------------------------------------------------------------------------------------
# -----------------------------------------------------------------------------------------------------------------------------

ENABLE_FETCHMAIL=0

# The interval to fetch mail in seconds
FETCHMAIL_POLL=300

# -----------------------------------------------------------------------------------------------------------------------------
# --------------------- LDAP section ------------------------------------------------------------------------------------------
# -----------------------------------------------------------------------------------------------------------------------------

# A second container for the ldap service is necessary (i.e. https://github.com/osixia/docker-openldap)
# For preparing the ldap server to use in combination with this container this article may be helpful: http://acidx.net/wordpress/2014/06/installing-a-mailserver-with-postfix-dovecot-sasl-ldap-roundcube/

# empty => LDAP authentification is disabled
# 1 => LDAP authentification is enabled
ENABLE_LDAP=1

# empty => no
# yes => LDAP over TLS enabled for Postfix
LDAP_START_TLS=

# If you going to use the mailserver in combination with docker-compose you can set the service name here
# empty => mail.domain.com
# Specify the dns-name/ip-address where the ldap-server
LDAP_SERVER_HOST=openldap

# empty => ou=people,dc=domain,dc=com
# => e.g. LDAP_SEARCH_BASE=dc=mydomain,dc=local
LDAP_SEARCH_BASE=ou=people,dc=third,dc=hostarm,dc=com

# empty => cn=admin,dc=domain,dc=com
# => take a look at examples of SASL_LDAP_BIND_DN
LDAP_BIND_DN=cn=admin,dc=third,dc=hostarm,dc=com

# empty** => admin
# => Specify the password to bind against ldap
LDAP_BIND_PW=xxxxxxxxxxxxxxxxxxxx

# e.g. `"(&(mail=%s)(mailEnabled=TRUE))"`
# => Specify how ldap should be asked for users
LDAP_QUERY_FILTER_USER=(&(mail=%s)(mailEnabled=TRUE))

# e.g. `"(&(mailGroupMember=%s)(mailEnabled=TRUE))"`
# => Specify how ldap should be asked for groups
LDAP_QUERY_FILTER_GROUP=(&(mailGroupMember=%s)(mailEnabled=TRUE))

# e.g. `"(&(mailAlias=%s)(mailEnabled=TRUE))"`
# => Specify how ldap should be asked for aliases
#LDAP_QUERY_FILTER_ALIAS=(|(&(mailAlias=%s)(objectClass=PostfixBookMailForward))(&(mailAlias=%s)(objectClass=PostfixBookMailAccount)(mailEnabled=TRUE)))
LDAP_QUERY_FILTER_ALIAS=(&(mailAlias=%s)(mailEnabled=TRUE))

# e.g. `"(&(|(mail=*@%s)(mailalias=*@%s)(mailGroupMember=*@%s))(mailEnabled=TRUE))"`
# => Specify how ldap should be asked for domains
#LDAP_QUERY_FILTER_DOMAIN=(|(&(mail=*@%s)(objectClass=PostfixBookMailAccount)(mailEnabled=TRUE))(&(mailGroupMember=*@%s)(objectClass=PostfixBookMailAccount)(mailEnabled=TRUE))(&(mailalias=*@%s)(objectClass=PostfixBookMailForward)))
LDAP_QUERY_FILTER_DOMAIN=(&(|(mail=*@%s)(mailalias=*@%s)(mailGroupMember=*@%s))(mailEnabled=TRUE))

# -----------------------------------------------------------------------------------------------------------------------------
# ---------------- Dovecot section --------------------------------------------------------------------------------------------
# -----------------------------------------------------------------------------------------------------------------------------

# empty => no
# yes => LDAP over TLS enabled for Dovecot
#DOVECOT_TLS=
DOVECOT_TLS=

# e.g. `"(&(objectClass=PostfixBookMailAccount)(uniqueIdentifier=%n))"`
#DOVECOT_USER_FILTER=(&(objectClass=PostfixBookMailAccount)(uniqueIdentifier=%n))
DOVECOT_USER_FILTER=(&(objectClass=PostfixBookMailAccount)(mail=%u))

# e.g. `"(&(objectClass=PostfixBookMailAccount)(uniqueIdentifier=%n))"`
#DOVECOT_PASS_FILTER=(&(objectClass=PostfixBookMailAccount)(uniqueIdentifier=%n))
DOVECOT_PASS_FILTER=(&(objectClass=PostfixBookMailAccount)(mail=%u))

# Define the mailbox format to be used
# default is maildir, supported values are: sdbox, mdbox, maildir
DOVECOT_MAILBOX_FORMAT=maildir

# -----------------------------------------------------------------------------------------------------------------------------
# ---------------- Postgrey section -------------------------------------------------------------------------------------------
# -----------------------------------------------------------------------------------------------------------------------------

#ENABLE_POSTGREY=0
ENABLE_POSTGREY=1
# greylist for N seconds
POSTGREY_DELAY=300
# delete entries older than N days since the last time that they have been seen
POSTGREY_MAX_AGE=35
# response when a mail is greylisted
POSTGREY_TEXT=Delayed by postgrey
# whitelist host after N successful deliveries (N=0 to disable whitelisting)
POSTGREY_AUTO_WHITELIST_CLIENTS=5

# -----------------------------------------------------------------------------------------------------------------------------
# ---------------- SASL section -----------------------------------------------------------------------------------------------
# -----------------------------------------------------------------------------------------------------------------------------

ENABLE_SASLAUTHD=1

# 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_MECHANISMS=ldap

# 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_MECH_OPTIONS=

# empty => localhost
SASLAUTHD_LDAP_SERVER=openldap

# empty or 0 => `ldap://` will be used
# 1 => `ldaps://` will be used
SASLAUTHD_LDAP_SSL=

# empty => anonymous bind
# specify an object with priviliges 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_BIND_DN=cn=admin,dc=third,dc=hostarm,dc=com

# empty => anonymous bind
SASLAUTHD_LDAP_PASSWORD=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

# empty => Reverting to SASLAUTHD_MECHANISMS pam
# specify the search base
SASLAUTHD_LDAP_SEARCH_BASE=ou=people,dc=third,dc=hostarm,dc=com

# 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_FILTER=(&(mail=%U@%r)(mailEnabled=TRUE))

# empty => no
# yes => LDAP over TLS enabled for SASL
# Must not be used together with SASLAUTHD_LDAP_SSL=1_
SASLAUTHD_LDAP_START_TLS=

# empty => no
# yes => Require and verify server certificate
SASLAUTHD_LDAP_TLS_CHECK_PEER=

# empty => No sasl_passwd will be created
# string => `/etc/postfix/sasl_passwd` will be created with the string as password
SASL_PASSWD=

# -----------------------------------------------------------------------------------------------------------------------------
# ---------------- SRS section --------------------------------------------------------------------------------------------
# -----------------------------------------------------------------------------------------------------------------------------

# envelope_sender => Rewrite only envelope sender address (default)
# header_sender => Rewrite only header sender (not recommended)
# envelope_sender,header_sender => Rewrite both senders
# 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.
SRS_SENDER_CLASSES=envelope_sender

# empty => Envelope sender will be rewritten for all domains
# provide comma separated list of domains to exclude from rewriting
SRS_EXCLUDE_DOMAINS=

# empty => generated when the image is built
# 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
SRS_SECRET=

# -----------------------------------------------------------------------------------------------------------------------------
# ---------------- Default relay host section ---------------------------------------------------------------------------------
# -----------------------------------------------------------------------------------------------------------------------------

# Setup relaying all mail through a default relay host
#
# empty => don't configure default relay host
# default host and optional port to relay all mail through
DEFAULT_RELAY_HOST=

# -----------------------------------------------------------------------------------------------------------------------------
# ---------------- Multi-domain relay section ---------------------------------------------------------------------------------
# -----------------------------------------------------------------------------------------------------------------------------

# Setup relaying for multiple domains based on the domain name of the sender
# optionally uses usernames and passwords in postfix-sasl-password.cf and relay host mappings in postfix-relaymap.cf
#
# empty => don't configure relay host
# default host to relay mail through
RELAY_HOST=

# empty => 25
# default port to relay mail
RELAY_PORT=25

# empty => no default
# default relay username (if no specific entry exists in postfix-sasl-password.cf)
RELAY_USER=

# empty => no default
# password for default relay user
RELAY_PASSWORD=

Docker Compose (new, seems to work well)

services:
  mailserver:
    image: ghcr.io/docker-mailserver/docker-mailserver:latest
    hostname: ${MAIL_HOSTNAME}
    domainname: ${MAIL_DOMAINNAME}
    container_name: mailserver
    env_file:
      - mailserver.env
      - .env
    dns: 192.168.1.2
    networks:
      openldap_internal:
      dns_internal:
      monitoring_internal:
        ipv4_address: 192.168.10.8
      internal:
        ipv4_address: 192.168.20.2
        aliases:
          - mail
          - smtp
          - example.mailserver.com
    ports:
      - "25:25"
      - "143:143"
      - "465:465"
      - "587:587"
      - "993:993"
    volumes:
      - /c/srv/docker/volumes/mail/data:/var/mail
      - /c/srv/docker/volumes/mail/logs:/var/log/mail
      - ./config/:/tmp/docker-mailserver/
      - ./cron/sa-learn:/etc/cron.d/sa-learn
      - /c/srv/docker/volumes/mail/cert:/etc/letsencrypt
      - "/etc/localtime:/etc/localtime:ro"
    restart: always
    stop_grace_period: 1m
    cap_add:
      - NET_ADMIN
    healthcheck:
      test: "ss --listening --tcp | grep -P 'LISTEN.+:smtp' || exit 1"
      timeout: 3s
      retries: 0

  letsencrypt:
    build:
      context: ./certbot
    image: custom/letsencrypt:latest
    container_name: certbot
    restart: always
    volumes:
      - type: bind
        source: /c/srv/docker/volumes/mail/cert/
        target: /etc/letsencrypt
    networks:
      internal:
        ipv4_address: 192.168.20.3

  roundcube:
    image: roundcube/roundcubemail:latest-apache
    container_name: roundcube
    restart: always
    volumes:
      - /c/srv/docker/volumes/mail/roundcube/www:/var/www/html
      - /c/srv/docker/volumes/mail/roundcube/db:/var/roundcube/db
      - "/etc/timezone:/etc/timezone:ro"
      - "/etc/localtime:/etc/localtime:ro"
      - ./config_roundcube/:/var/roundcube/config/
    environment:
      - ROUNDCUBEMAIL_DB_TYPE=sqlite
      - ROUNDCUBEMAIL_DEFAULT_HOST=ssl://mail.example.com
      - ROUNDCUBEMAIL_DEFAULT_PORT=993
      - ROUNDCUBEMAIL_SMTP_SERVER=tls://mail.example.com
      - ROUNDCUBEMAIL_SMTP_PORT=587
      - ROUNDCUBEMAIL_PLUGINS=archive,zipdownload,managesieve,markasjunk,password
    networks:
      internal:
        ipv4_address: 192.168.20.4
      openldap_internal:
      wireguard_internal:
        ipv4_address: 192.168.30.14
      traefik_internal:
        ipv4_address: 192.168.40.6

networks:
  internal:
    ipam:
      config:
        - subnet: 192.168.20.0/24
  openldap_internal:
    external: true
  dns_internal:
    external: true
  traefik_internal:
    external: true
  wireguard_internal:
    external: true
  monitoring_internal:
    external: true

```services:
  mailserver:
    image: ghcr.io/docker-mailserver/docker-mailserver:latest
    hostname: ${MAIL_HOSTNAME}
    domainname: ${MAIL_DOMAINNAME}
    container_name: mailserver
    env_file:
      - mailserver.env
      - .env
    dns: 192.168.1.2
    networks:
      openldap_internal:
      dns_internal:
      monitoring_internal:
        ipv4_address: 192.168.10.8
      internal:
        ipv4_address: 192.168.20.2
        aliases:
          - mail
          - smtp
          - example.mailserver.com
    ports:
      - "25:25"
      - "143:143"
      - "465:465"
      - "587:587"
      - "993:993"
    volumes:
      - /c/srv/docker/volumes/mail/data:/var/mail
      - /c/srv/docker/volumes/mail/logs:/var/log/mail
      - ./config/:/tmp/docker-mailserver/
      - ./cron/sa-learn:/etc/cron.d/sa-learn
      - /c/srv/docker/volumes/mail/cert:/etc/letsencrypt
      - "/etc/localtime:/etc/localtime:ro"
    restart: always
    stop_grace_period: 1m
    cap_add:
      - NET_ADMIN
    healthcheck:
      test: "ss --listening --tcp | grep -P 'LISTEN.+:smtp' || exit 1"
      timeout: 3s
      retries: 0

  letsencrypt:
    build:
      context: ./certbot
    image: custom/letsencrypt:latest
    container_name: certbot
    restart: always
    volumes:
      - type: bind
        source: /c/srv/docker/volumes/mail/cert/
        target: /etc/letsencrypt
    networks:
      internal:
        ipv4_address: 192.168.20.3

  roundcube:
    image: roundcube/roundcubemail:latest-apache
    container_name: roundcube
    restart: always
    volumes:
      - /c/srv/docker/volumes/mail/roundcube/www:/var/www/html
      - /c/srv/docker/volumes/mail/roundcube/db:/var/roundcube/db
      - "/etc/timezone:/etc/timezone:ro"
      - "/etc/localtime:/etc/localtime:ro"
      - ./config_roundcube/:/var/roundcube/config/
    environment:
      - ROUNDCUBEMAIL_DB_TYPE=sqlite
      - ROUNDCUBEMAIL_DEFAULT_HOST=ssl://mail.example.com
      - ROUNDCUBEMAIL_DEFAULT_PORT=993
      - ROUNDCUBEMAIL_SMTP_SERVER=tls://mail.example.com
      - ROUNDCUBEMAIL_SMTP_PORT=587
      - ROUNDCUBEMAIL_PLUGINS=archive,zipdownload,managesieve,markasjunk,password
    networks:
      internal:
        ipv4_address: 192.168.20.4
      openldap_internal:
      wireguard_internal:
        ipv4_address: 192.168.30.14
      traefik_internal:
        ipv4_address: 192.168.40.6

networks:
  internal:
    ipam:
      config:
        - subnet: 192.168.20.0/24
  openldap_internal:
    external: true
  dns_internal:
    external: true
  traefik_internal:
    external: true
  wireguard_internal:
    external: true
  monitoring_internal:
    external: true

env file (new, seems to have problem with old data)

# -----------------------------------------------
# --- Mailserver Environment Variables ----------
# -----------------------------------------------

# DOCUMENTATION FOR THESE VARIABLES IS FOUND UNDER
# https://docker-mailserver.github.io/docker-mailserver/latest/config/environment/

# -----------------------------------------------
# --- General Section ---------------------------
# -----------------------------------------------

OVERRIDE_HOSTNAME=example.com
DMS_DEBUG=0
LOG_LEVEL=debug
SUPERVISOR_LOGLEVEL=
DMS_VMAIL_UID=
DMS_VMAIL_GID=
ACCOUNT_PROVISIONER=LDAP
POSTMASTER_ADDRESS=postmaster@example.com
ENABLE_UPDATE_CHECK=1
UPDATE_CHECK_INTERVAL=1d
PERMIT_DOCKER=host
TZ=Europe/Warsaw
NETWORK_INTERFACE=
TLS_LEVEL=
SPOOF_PROTECTION=1
ENABLE_SRS=0
ENABLE_OPENDKIM=1
ENABLE_OPENDMARC=1
ENABLE_POLICYD_SPF=1
ENABLE_POP3=1
ENABLE_IMAP=1
ENABLE_CLAMAV=1
SPAM_SUBJECT=SPAM
ENABLE_RSPAMD=0
ENABLE_RSPAMD_REDIS=
RSPAMD_LEARN=1
RSPAMD_CHECK_AUTHENTICATED=0
RSPAMD_GREYLISTING=0
RSPAMD_HFILTER=1
RSPAMD_HFILTER_HOSTNAME_UNKNOWN_SCORE=6
RSPAMD_NEURAL=0
ENABLE_AMAVIS=1
AMAVIS_LOGLEVEL=0
ENABLE_DNSBL=0
ENABLE_FAIL2BAN=1
FAIL2BAN_BLOCKTYPE=drop
ENABLE_MANAGESIEVE=1
POSTSCREEN_ACTION=enforce
SMTP_ONLY=
SSL_TYPE=letsencrypt
SSL_CERT_PATH=
SSL_KEY_PATH=
SSL_ALT_CERT_PATH=
SSL_ALT_KEY_PATH=
VIRUSMAILS_DELETE_DELAY=
POSTFIX_DAGENT=
POSTFIX_MAILBOX_SIZE_LIMIT=
ENABLE_QUOTAS=1
POSTFIX_MESSAGE_SIZE_LIMIT=30720000
CLAMAV_MESSAGE_SIZE_LIMIT=
PFLOGSUMM_TRIGGER=daily_cron
PFLOGSUMM_RECIPIENT=
PFLOGSUMM_SENDER=
LOGWATCH_INTERVAL=daily
LOGWATCH_RECIPIENT=
LOGWATCH_SENDER=
REPORT_RECIPIENT=
REPORT_SENDER=
LOGROTATE_INTERVAL=weekly
LOGROTATE_COUNT=4
POSTFIX_REJECT_UNKNOWN_CLIENT_HOSTNAME=0
POSTFIX_INET_PROTOCOLS=all
ENABLE_MTA_STS=0
DOVECOT_INET_PROTOCOLS=all

# -----------------------------------------------
# --- SpamAssassin Section ----------------------
# -----------------------------------------------

ENABLE_SPAMASSASSIN=1
ENABLE_SPAMASSASSIN_KAM=1
SPAMASSASSIN_SPAM_TO_INBOX=1
MOVE_SPAM_TO_JUNK=1
MARK_SPAM_AS_READ=0
SA_TAG=2.0
SA_TAG2=6.31
SA_KILL=10.0

# -----------------------------------------------
# --- Fetchmail Section -------------------------
# -----------------------------------------------

ENABLE_FETCHMAIL=0
FETCHMAIL_POLL=300
FETCHMAIL_PARALLEL=0
ENABLE_GETMAIL=0
GETMAIL_POLL=5

# -----------------------------------------------
# --- OAUTH2 Section ----------------------------
# -----------------------------------------------

ENABLE_OAUTH2=0
OAUTH2_INTROSPECTION_URL=

# -----------------------------------------------
# --- LDAP Section ------------------------------
# -----------------------------------------------

LDAP_START_TLS=
LDAP_SERVER_HOST=ldap://ldap.example.com
LDAP_SEARCH_BASE=ou=users,dc=example,dc=com
LDAP_BIND_DN=cn=admin,dc=example,dc=com
LDAP_BIND_PW=REDACTED
LDAP_QUERY_FILTER_USER=(&(mail=%s)(mailEnabled=TRUE))
LDAP_QUERY_FILTER_GROUP=(&(mailGroupMember=%s)(mailEnabled=TRUE))
LDAP_QUERY_FILTER_ALIAS=(&(mailAlias=%s)(mailEnabled=TRUE))
LDAP_QUERY_FILTER_DOMAIN=(&(|(mail=*@%s)(mailalias=*@%s)(mailGroupMember=*@%s))(mailEnabled=TRUE))

# -----------------------------------------------
# --- Dovecot Section ---------------------------
# -----------------------------------------------

DOVECOT_TLS=no
DOVECOT_USER_FILTER=(&(objectClass=PostfixBookMailAccount)(mail=%u))
DOVECOT_PASS_FILTER=(&(objectClass=PostfixBookMailAccount)(mail=%u))
DOVECOT_MAILBOX_FORMAT=maildir
DOVECOT_AUTH_BIND=yes

# -----------------------------------------------
# --- Postgrey Section --------------------------
# -----------------------------------------------

ENABLE_POSTGREY=0
POSTGREY_DELAY=300
POSTGREY_MAX_AGE=35
POSTGREY_TEXT="Delayed by Postgrey"
POSTGREY_AUTO_WHITELIST_CLIENTS=5

# -----------------------------------------------
# --- SASL Section ------------------------------
# -----------------------------------------------

ENABLE_SASLAUTHD=1
SASLAUTHD_MECHANISMS=ldap
SASLAUTHD_MECH_OPTIONS=
SASLAUTHD_LDAP_SERVER=ldap://ldap.example.com
SASLAUTHD_LDAP_BIND_DN=cn=admin,dc=example,dc=com
SASLAUTHD_LDAP_PASSWORD=REDACTED
SASLAUTHD_LDAP_SEARCH_BASE=ou=users,dc=example,dc=com
SASLAUTHD_LDAP_FILTER=(&(mail=%U@%r)(mailEnabled=TRUE))
SASLAUTHD_LDAP_START_TLS=
SASLAUTHD_LDAP_TLS_CHECK_PEER=
SASLAUTHD_LDAP_TLS_CACERT_FILE=
SASLAUTHD_LDAP_TLS_CACERT_DIR=
SASLAUTHD_LDAP_PASSWORD_ATTR=
SASLAUTHD_LDAP_AUTH_METHOD=
SASLAUTHD_LDAP_MECH=

# -----------------------------------------------
# --- SRS Section -------------------------------
# -----------------------------------------------

SRS_SENDER_CLASSES=envelope_sender
SRS_EXCLUDE_DOMAINS=
SRS_SECRET=

# -----------------------------------------------
# --- Default Relay Host Section ----------------
# -----------------------------------------------

DEFAULT_RELAY_HOST=

# -----------------------------------------------
# --- Multi-Domain Relay Section ----------------
# -----------------------------------------------

RELAY_HOST=
RELAY_PORT=25

# -----------------------------------------------
# --- Relay Host Credentials Section ------------
# -----------------------------------------------

RELAY_USER=
RELAY_PASSWORD=

7 replies

polarathene Dec 23, 2024
Maintainer

I'm not 100% sure on how to resolve your LDAP login issue.

I am fairly confident I've encountered it in the past and I do know that we have a test that ensures it's working, but it's not documented as well as I'd like it to be. The LDAP support was added long ago by the community, it needs some rework.

I would focus on getting the Dovecot IMAP login to work for now, trying with both some-user and some-user@example.com, AFAIK Dovecot should receive your login (full address ideally for the default query) and match mail=some-user@example.com attribute for the LDAP account you have configured.

If you're only providing the login name instead of a full email address, then dovecot may not have the information to get the @example.com part and just search for mail=some-user.

Original response

I thought with ENABLE_SASLAUTHD=0 maybe you needed to set DOVECOT_URIS to the equivalent of LDAP_SERVER_HOST=ldap://ldap.example.com, but it seems to be handled implicitly:

docker-mailserver/target/scripts/startup/setup.d/ldap.sh

Lines 38 to 41 in 02415b0

    
           DOVECOT_LDAP_MAPPING['DOVECOT_BASE']="${DOVECOT_BASE:="${LDAP_SEARCH_BASE}"}" 
        
           DOVECOT_LDAP_MAPPING['DOVECOT_DN']="${DOVECOT_DN:="${LDAP_BIND_DN}"}" 
        
           DOVECOT_LDAP_MAPPING['DOVECOT_DNPASS']="${DOVECOT_DNPASS:="${LDAP_BIND_PW}"}" 
        
           DOVECOT_LDAP_MAPPING['DOVECOT_URIS']="${DOVECOT_URIS:="${LDAP_SERVER_HOST}"}"

dovecot: auth: ldap([REDACTED_USER],[REDACTED_IP],[REDACTED_TOKEN]): unknown user (SHA1 of given password: [REDACTED_HASH])
dovecot: auth: Error: ldap([REDACTED_USER],[REDACTED_IP],[REDACTED_TOKEN]): user not found from userdb
dovecot: imap(1856): Error: auth-master: login: request [REDACTED_ID]: Login auth request failed: Authenticated user not found from userdb, auth lookup id=[REDACTED_ID] (auth connected 2 msecs ago, request took 1 msecs, client-pid=1840 client-id=1)
dovecot: imap-login: Disconnected: Internal login failure (pid=1840 id=1): user=<[REDACTED_USER]>, method=PLAIN, rip=[REDACTED_IP], lip=[REDACTED_IP], mpid=1856, TLS, session=[REDACTED_TOKEN]

The error is probably due to the way the user login name is provided is not being queried successfully to LDAP, so there's a mismatch.

This is probably related to to my advice to disable SASLAUTHD, it's been a while but I recall a subtle "bug" between the two SASL providers config.

I seem to have documented that here:

docker-mailserver/test/tests/serial/mail_with_ldap.bats

Lines 85 to 90 in 02415b0

    
           # Dovecot is configured to lookup a user account by their login name (`userID` in this case, but it could be any attribute like `mail`). 
        
           # Dovecot syntax token `%n` is the local-part of the full email address supplied as the login name. There must be a unique match on `userID` (which there will be as each account is configured via LDIF to use it in their DN) 
        
           # NOTE: We already have a constraint on the LDAP tree to search (`LDAP_SEARCH_BASE`), if all objects in that subtree use `PostfixBookMailAccount` class then there is no benefit in the extra constraint. 
        
           # TODO: For tests, that additional constraint is meaningless. We can detail it in our docs instead and just use `userID=%n`. 
        
           local DOVECOT_QUERY_PASS='(&(userID=%n)(objectClass=PostfixBookMailAccount))' 
        
           local DOVECOT_QUERY_USER='(&(userID=%n)(objectClass=PostfixBookMailAccount))'

docker-mailserver/test/tests/serial/mail_with_ldap.bats

Lines 74 to 83 in 02415b0

    
           # When using SASLAuthd for login auth (only valid to Postfix in DMS), 
        
           # Postfix will pass on the login username and SASLAuthd will use it's backend to do a lookup. 
        
           # The current default is `uniqueIdentifier=%u`, but `%u` is inaccurate currently with LDAP backend 
        
           # as SASLAuthd will ignore the domain-part received (if any) and forward only the local-part as the query. 
        
           # TODO: Fix this by having supervisor start the service with `-r` option like it does `rimap` backend. 
        
           # NOTE: `%u` (full login with realm/domain-part) is presently equivalent to `%U` (local-part) only, 
        
           # As the `userID` is not a mail address, we ensure any domain-part is ignored, as a login name is not 
        
           # required to match the mail accounts actual `mail` attribute (nor the local-part), they are distinct. 
        
           # TODO: Docs should better cover this difference, as it does confuse some users of DMS (and past contributors to our tests..). 
        
           local SASLAUTHD_QUERY='(&(userID=%U)(mailEnabled=TRUE))'

This is the default user query config (Postfix):

docker-mailserver/target/postfix/ldap-users.cf

Lines 4 to 5 in 02415b0

    
           query_filter     = (&(mail=%s)(mailEnabled=TRUE)) 
        
           result_attribute = mail

and here's the equivalent for Dovecot:

docker-mailserver/target/dovecot/dovecot-ldap.conf.ext

Lines 8 to 11 in 02415b0

    
           pass_attrs          = uniqueIdentifier=user,userPassword=password 
        
           pass_filter         = (&(objectClass=PostfixBookMailAccount)(uniqueIdentifier=%n)) 
        
           user_attrs          = mailHomeDirectory=home,mailUidNumber=uid,mailGidNumber=gid,mailStorageDirectory=mail 
        
           user_filter         = (&(objectClass=PostfixBookMailAccount)(uniqueIdentifier=%n))

Presently DMS doesn't provide a convenient ENV to adjust result_attribute = mail for Dovecot, but your issue seems to be specific to Dovecot and the input you've provided that it processes with it's own %u token.

DOVECOT_USER_FILTER=(&(objectClass=PostfixBookMailAccount)(mail=%u))
DOVECOT_PASS_FILTER=(&(objectClass=PostfixBookMailAccount)(mail=%u))

# compared to saslauthd requesting full address?:
# (but as mentioned SASLAUTHD strips the `@domain` part at some point)
SASLAUTHD_LDAP_FILTER=(&(mail=%U@%r)(mailEnabled=TRUE))

My commentary from the mail_with_ldap.bats file notes that %n would be the local-part alone. If your login is only some-user instead of some-user@example.com, try logging in with the full e-mail address, or adjusting the query to for one of those Dovecot filters to match an LDAP attribute of the user that is unique.

I haven't worked with LDAP for some time, but I have provided more details with our test suite that does have a working login example. You should be able to use this information to adjust your configuration somewhere and get a successful login.

Test suite reference

Perhaps it will help to reference the LDAP setup we have in our test suite?

We use this bitnami image for OpenLDAP:

docker-mailserver/test/tests/serial/mail_with_ldap.bats

Lines 23 to 33 in 02415b0

    
           # Setup local openldap service: 
        
           docker run --rm -d --name "${CONTAINER2_NAME}" \ 
        
             --env LDAP_ADMIN_PASSWORD=admin \ 
        
             --env LDAP_ROOT='dc=example,dc=test' \ 
        
             --env LDAP_PORT_NUMBER=389 \ 
        
             --env LDAP_SKIP_DEFAULT_TREE=yes \ 
        
             --volume "${REPOSITORY_ROOT}/test/config/ldap/openldap/ldifs/:/ldifs/:ro" \ 
        
             --volume "${REPOSITORY_ROOT}/test/config/ldap/openldap/schemas/:/schemas/:ro" \ 
        
             --hostname "${FQDN_LDAP}" \ 
        
             --network "${DMS_TEST_NETWORK}" \ 
        
             bitnami/openldap:latest

It uses this postfix-book.ldif schema and the following LDIF files to create some users:

Top-level definition (root object tree)
User A
User B
User C

Three Postfix config files are provided (probably not relevant for Dovecot logins via IMAP):

For the LDAP query filters, again probably only the Dovecot ones matter for getting IMAP login verified as working first. The test suite defines the following (with some helpful commentary):

docker-mailserver/test/tests/serial/mail_with_ldap.bats

Lines 41 to 90 in 02415b0

    
           # LDAP filter queries explained. 
        
           # NOTE: All LDAP configs for Postfix (with the exception of `ldap-senders.cf`), return the `mail` attribute value of matched results. 
        
           # This is through the config key `result_attribute`, which the ENV substitution feature can only replace across all configs, not selectively like `query_filter`. 
        
           # NOTE: The queries below rely specifically upon attributes and classes defined by the schema `postfix-book.ldif`. These are not compatible with all LDAP setups. 
        
           # `mailAlias`` is supported by both classes provided from the schema `postfix-book.ldif`, but `mailEnabled` is only available to `PostfixBookMailAccount` class: 
        
           local QUERY_ALIAS='(&(mailAlias=%s) (| (objectClass=PostfixBookMailForward) (&(objectClass=PostfixBookMailAccount)(mailEnabled=TRUE)) ))' 
        
           # Postfix does domain lookups with the domain of the recipient to check if DMS manages the mail domain. 
        
           # For this lookup `%s` only represents the domain, not a full email address. Hence the match pattern using a wildcard prefix `*@`. 
        
           # For a breakdown, see QUERY_SENDERS comment. 
        
           # NOTE: Although `result_attribute = mail` will return each accounts full email address, Postfix will only compare to domain-part. 
        
           local QUERY_DOMAIN='(| (& (|(mail=*@%s) (mailAlias=*@%s) (mailGroupMember=*@%s)) (&(objectClass=PostfixBookMailAccount)(mailEnabled=TRUE)) ) (&(mailAlias=*@%s)(objectClass=PostfixBookMailForward)) )' 
        
           # Simple queries for a single attribute that additionally requires `mailEnabled=TRUE` from the `PostfixBookMailAccount` class: 
        
           # NOTE: `mail` attribute is not unique to `PostfixBookMailAccount`. The `mailEnabled` attribute is to further control valid mail accounts. 
        
           # TODO: For tests, since `mailEnabled` is not relevant (always configured as TRUE currently), 
        
           # a simpler query like `mail=%s` or `mailGroupMember=%s` would be sufficient. The additional constraints could be covered in our docs instead. 
        
           local QUERY_GROUP='(&(mailGroupMember=%s) (&(objectClass=PostfixBookMailAccount)(mailEnabled=TRUE)) )' 
        
           local QUERY_USER='(&(mail=%s) (&(objectClass=PostfixBookMailAccount)(mailEnabled=TRUE)) )' 
        
           # Given the sender address `%s` from Postfix, query LDAP for accounts that meet the search filter, 
        
           # the `result_attribute` is `mail` + `uid` (`userID`) attributes for login names that are authorized to use that sender address. 
        
           # One of the result values returned must match the login name of the user trying to send mail with that sender address. 
        
           # 
        
           # Filter: Search for accounts that meet any of the following conditions: 
        
           # - Has any attribute (`mail`, `mailAlias`, `mailGroupMember`) with a value of `%s`, AND is of class `PostfixBookMailAccount` with `mailEnabled=TRUE` attribute set. 
        
           # - Has attribute `mailAlias` with value of `%s` AND is of class PostfixBookMailForward 
        
           # - Has the attribute `userID` with value `some.user.id` 
        
           local QUERY_SENDERS='(| (& (|(mail=%s) (mailAlias=%s) (mailGroupMember=%s)) (&(objectClass=PostfixBookMailAccount)(mailEnabled=TRUE)) ) (&(mailAlias=%s)(objectClass=PostfixBookMailForward)) (userID=some.user.id))' 
        
           # NOTE: The remaining queries below have been left as they were instead of rewritten, `mailEnabled` has no associated class requirement, nor does the class requirement ensure `mailEnabled=TRUE`. 
        
           # When using SASLAuthd for login auth (only valid to Postfix in DMS), 
        
           # Postfix will pass on the login username and SASLAuthd will use it's backend to do a lookup. 
        
           # The current default is `uniqueIdentifier=%u`, but `%u` is inaccurate currently with LDAP backend 
        
           # as SASLAuthd will ignore the domain-part received (if any) and forward only the local-part as the query. 
        
           # TODO: Fix this by having supervisor start the service with `-r` option like it does `rimap` backend. 
        
           # NOTE: `%u` (full login with realm/domain-part) is presently equivalent to `%U` (local-part) only, 
        
           # As the `userID` is not a mail address, we ensure any domain-part is ignored, as a login name is not 
        
           # required to match the mail accounts actual `mail` attribute (nor the local-part), they are distinct. 
        
           # TODO: Docs should better cover this difference, as it does confuse some users of DMS (and past contributors to our tests..). 
        
           local SASLAUTHD_QUERY='(&(userID=%U)(mailEnabled=TRUE))' 
        
           # Dovecot is configured to lookup a user account by their login name (`userID` in this case, but it could be any attribute like `mail`). 
        
           # Dovecot syntax token `%n` is the local-part of the full email address supplied as the login name. There must be a unique match on `userID` (which there will be as each account is configured via LDIF to use it in their DN) 
        
           # NOTE: We already have a constraint on the LDAP tree to search (`LDAP_SEARCH_BASE`), if all objects in that subtree use `PostfixBookMailAccount` class then there is no benefit in the extra constraint. 
        
           # TODO: For tests, that additional constraint is meaningless. We can detail it in our docs instead and just use `userID=%n`. 
        
           local DOVECOT_QUERY_PASS='(&(userID=%n)(objectClass=PostfixBookMailAccount))' 
        
           local DOVECOT_QUERY_USER='(&(userID=%n)(objectClass=PostfixBookMailAccount))'

Here we have the DMS ENV settings for LDAP and some other settings for the test:

docker-mailserver/test/tests/serial/mail_with_ldap.bats

Lines 92 to 135 in 02415b0

    
           local ENV_LDAP_CONFIG=( 
        
             --env ACCOUNT_PROVISIONER=LDAP 
        
             # Common LDAP ENV: 
        
             # NOTE: `scripts/startup/setup.d/ldap.sh:_setup_ldap()` uses `_replace_by_env_in_file()` to configure settings (stripping `DOVECOT_` / `LDAP_` prefixes): 
        
             --env LDAP_SERVER_HOST="ldap://${FQDN_LDAP}" 
        
             --env LDAP_SEARCH_BASE='ou=users,dc=example,dc=test' 
        
             --env LDAP_START_TLS=no 
        
             # Credentials needed for read access to LDAP_SEARCH_BASE: 
        
             --env LDAP_BIND_DN='cn=admin,dc=example,dc=test' 
        
             --env LDAP_BIND_PW='admin' 
        
             # Postfix SASL auth provider (SASLAuthd instead of default Dovecot provider): 
        
             --env ENABLE_SASLAUTHD=1 
        
             --env SASLAUTHD_MECHANISMS=ldap 
        
             --env SASLAUTHD_LDAP_FILTER="${SASLAUTHD_QUERY}" 
        
             # ENV to configure LDAP configs for Dovecot + Postfix: 
        
             # Dovecot: 
        
             --env DOVECOT_PASS_FILTER="${DOVECOT_QUERY_PASS}" 
        
             --env DOVECOT_USER_FILTER="${DOVECOT_QUERY_USER}" 
        
             --env DOVECOT_TLS=no 
        
             # Postfix: 
        
             --env LDAP_QUERY_FILTER_ALIAS="${QUERY_ALIAS}" 
        
             --env LDAP_QUERY_FILTER_DOMAIN="${QUERY_DOMAIN}" 
        
             --env LDAP_QUERY_FILTER_GROUP="${QUERY_GROUP}" 
        
             --env LDAP_QUERY_FILTER_SENDERS="${QUERY_SENDERS}" 
        
             --env LDAP_QUERY_FILTER_USER="${QUERY_USER}" 
        
           ) 
        
           # Extra ENV needed to support specific test-cases: 
        
           local ENV_SUPPORT=( 
        
             # Required for openssl commands to be successul: 
        
             # NOTE: snakeoil cert is created (for `docker-mailserver.invalid`) via Debian post-install script for Postfix package. 
        
             # TODO: Use proper TLS cert 
        
             --env SSL_TYPE='snakeoil' 
        
             # TODO; All below are questionable value to LDAP tests? 
        
             --env POSTMASTER_ADDRESS="postmaster@${FQDN_LOCALHOST_A}" # TODO: Only required because LDAP accounts use unrelated domain part. FQDN_LOCALHOST_A / ldif files can be adjusted to FQDN_MAIL 
        
             --env PFLOGSUMM_TRIGGER=logrotate 
        
             --env REPORT_RECIPIENT=1 # TODO: Invalid value, should be a recipient address (if not default postmaster), remove? 
        
             --env SPOOF_PROTECTION=1 
        
           )

I know that is quite a lot to go over, but the test itself has no problem with logins.

robertmonka Dec 23, 2024
Author

I found problem with dovecot ldap configuration /etc/dovecot/dovecot-ldap.conf.ext

It was

base = ou=people,dc=third,dc=xxxxxxxx,dc=com
default_pass_scheme = SSHA
dn = cn=admin,dc=third,dc=xxxxxxxx,dc=com
dnpass = xxxxxxxxxxxx
uris = ldap://openldap
tls = no
ldap_version        = 3
pass_attrs          = uniqueIdentifier=user,userPassword=password
pass_filter = (&(objectClass=PostfixBookMailAccount)(mail=%u))
user_attrs          = mailHomeDirectory=home,mailUidNumber=uid,mailGidNumber=gid,mailStorageDirectory=mail
user_filter = (&(objectClass=PostfixBookMailAccount)(mail=%u))
auth_bind = yes

to

base = ou=people,dc=third,dc=xxxxxxxx,dc=com
default_pass_scheme = SSHA
dn = cn=admin,dc=third,dc=xxxxxxxx,dc=com
dnpass = xxxxxxxxxxxx
uris = ldap://openldap
tls = no
ldap_version        = 3
pass_attrs          = mail=user,userPassword=password
pass_filter = (&(objectClass=PostfixBookMailAccount)(mail=%u))
user_attrs          = mailHomeDirectory=home,mailUidNumber=uid,mailGidNumber=gid,mailStorageDirectory=mail
user_filter = (&(objectClass=PostfixBookMailAccount)(mail=%u))
auth_bind = yes

changed:
pass_attrs = mail=user,userPassword=password

How to change it in mailserver.env file?

polarathene Dec 23, 2024
Maintainer

changed: pass_attrs = mail=user,userPassword=password

How to change it in mailserver.env file?

It seems we don't have an explicit entry in the scripts for that field, but it is handled here:

docker-mailserver/target/scripts/startup/setup.d/ldap.sh

Lines 43 to 50 in 259f203

    
           # Default DOVECOT_PASS_FILTER to the same value as DOVECOT_USER_FILTER 
        
           DOVECOT_LDAP_MAPPING['DOVECOT_PASS_FILTER']="${DOVECOT_PASS_FILTER:="${DOVECOT_USER_FILTER}"}" 
        
           for VAR in "${!DOVECOT_LDAP_MAPPING[@]}"; do 
        
             export "${VAR}=${DOVECOT_LDAP_MAPPING[${VAR}]}" 
        
           done 
        
           _replace_by_env_in_file 'DOVECOT_' '/etc/dovecot/dovecot-ldap.conf.ext'

Our LDAP docs do reference the equivalent ENV though:

docker-mailserver/docs/content/config/account-management/provisioner/ldap.md

Lines 52 to 92 in 259f203

    
           ### `DOVECOT_*_FILTER` & `DOVECOT_*_ATTRS` 
        
           These variables specify the LDAP filters that dovecot uses to determine if a user can log in to their IMAP account, and which mailbox is responsible to receive email for a specific postfix user. 
        
           This is split into the following two lookups, both using `%u` as the placeholder for the full login name ([see dovecot documentation for a full list of placeholders](https://doc.dovecot.org/configuration_manual/config_file/config_variables/)). Usually you only need to set `DOVECOT_USER_FILTER`, in which case it will be used for both filters. 
        
           - `DOVECOT_USER_FILTER` is used to get the account details (uid, gid, home directory, quota, ...) of a user. 
        
           - `DOVECOT_PASS_FILTER` is used to get the password information of the user, and is in pretty much all cases identical to `DOVECOT_USER_FILTER` (which is the default behavior if left away). 
        
           If your directory doesn't have the [postfix-book schema](https://github.com/variablenix/ldap-mail-schema/blob/master/postfix-book.schema) installed, then you must change the internal attribute handling for dovecot. For this you have to change the `pass_attr` and the `user_attr` mapping, as shown in the example below: 
        
           ```yaml 
        
           - DOVECOT_PASS_ATTRS=<YOUR_USER_IDENTIFIER_ATTRIBUTE>=user,<YOUR_USER_PASSWORD_ATTRIBUTE>=password 
        
           - DOVECOT_USER_ATTRS=<YOUR_USER_HOME_DIRECTORY_ATTRIBUTE>=home,<YOUR_USER_MAILSTORE_ATTRIBUTE>=mail,<YOUR_USER_MAIL_UID_ATTRIBUTE>=uid,<YOUR_USER_MAIL_GID_ATTRIBUTE>=gid 
        
           ``` 
        
           !!! note 
        
               For `DOVECOT_*_ATTRS`, you can replace `ldapAttr=dovecotAttr` with `=dovecotAttr=%{ldap:ldapAttr}` for more flexibility, like for example `=home=/var/mail/%{ldap:uid}` or just `=uid=5000`. 
        
               A list of dovecot attributes can be found [in the dovecot documentation](https://doc.dovecot.org/configuration_manual/authentication/user_databases_userdb/#authentication-user-database). 
        
           ???+ example "Defaults" 
        
               ```yaml 
        
               - DOVECOT_USER_ATTRS=mailHomeDirectory=home,mailUidNumber=uid,mailGidNumber=gid,mailStorageDirectory=mail 
        
               - DOVECOT_PASS_ATTRS=uniqueIdentifier=user,userPassword=password 
        
               - DOVECOT_USER_FILTER=(&(objectClass=PostfixBookMailAccount)(uniqueIdentifier=%n)) 
        
               ``` 
        
           ???+ example 
        
               Setup for a directory that has the [qmail-schema](https://github.com/amery/qmail/blob/master/qmail.schema) installed and uses `uid`: 
        
               ```yaml 
        
               - DOVECOT_PASS_ATTRS=uid=user,userPassword=password 
        
               - DOVECOT_USER_ATTRS=homeDirectory=home,qmailUID=uid,qmailGID=gid,mailMessageStore=mail 
        
               - DOVECOT_USER_FILTER=(&(objectClass=qmailUser)(uid=%u)(accountStatus=active)) 
        
               ``` 
        
           The LDAP server configuration for dovecot will be taken mostly from postfix, other options can be found in [the environment section in the docs][docs-environment].

docker-mailserver/docs/content/config/environment.md

Lines 860 to 871 in 259f203

    
           ##### 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)

This should work:

DOVECOT_PASS_ATTRS=mail=user,userPassword=password

robertmonka Dec 23, 2024
Author

Works! Thank you.

I will now try resolve next problem :-).

robertmonka Dec 26, 2024
Author

All rest "problems" are resolved with the documentation.
Thanks again @polarathene.

Now server is updated, reconfigured and working!

Docker Mailserver

Job offer: Upgrade DMS from v6.2.0 and configuration check need *CHANGED #4279

Uh oh!

Uh oh!

robertmonka Dec 3, 2024

Replies: 3 comments · 10 replies

Uh oh!

polarathene Dec 3, 2024 Maintainer

Uh oh!

robertmonka Dec 3, 2024 Author

Changelog

6.2.0+

Uh oh!

robertmonka Dec 3, 2024 Author

Uh oh!

polarathene Dec 3, 2024 Maintainer

LDAP changes

Changelog overview

Migration instructions

Verifying successful migration

Uh oh!

robertmonka Dec 15, 2024 Author

Uh oh!

Uh oh!

robertmonka Dec 21, 2024 Author

Uh oh!

polarathene Dec 23, 2024 Maintainer

Original response

Test suite reference

Uh oh!

Uh oh!

robertmonka Dec 23, 2024 Author

Uh oh!

polarathene Dec 23, 2024 Maintainer

Uh oh!

robertmonka Dec 23, 2024 Author

Uh oh!

robertmonka Dec 26, 2024 Author

robertmonka
Dec 3, 2024

Replies: 3 comments 10 replies

polarathene
Dec 3, 2024
Maintainer

robertmonka Dec 3, 2024
Author

robertmonka Dec 3, 2024
Author

polarathene Dec 3, 2024
Maintainer

robertmonka
Dec 15, 2024
Author

robertmonka
Dec 21, 2024
Author

polarathene Dec 23, 2024
Maintainer

robertmonka Dec 23, 2024
Author

polarathene Dec 23, 2024
Maintainer

robertmonka Dec 23, 2024
Author

robertmonka Dec 26, 2024
Author