.all-contributorsrc

@@ -0,0 +1,26 @@
+{
+  "files": [
+    "CONTRIBUTORS.md"
+  ],
+  "imageSize": 100,
+  "commit": false,
+  "contributors": [
+    {
+      "login": "matrixes",
+      "name": "matrixes",
+      "avatar_url": "https://avatars.githubusercontent.com/u/46491408?v=4",
+      "profile": "https://github.com/matrixes",
+      "contributions": [
+        "blog"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7,
+  "badgeTemplate": "",
+  "projectName": "docker-mailserver",
+  "projectOwner": "docker-mailserver",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "skipCi": false,
+  "commitConvention": "none"
+}

.dockerignore

@@ -1,2 +1,3 @@
 *
 !target
+!VERSION

.editorconfig

@@ -8,7 +8,6 @@ root = true
 [*]
 charset = utf-8
 end_of_line = lf
-indent_size = 2
 indent_style = space
 insert_final_newline = true
 trim_trailing_whitespace = true
@@ -17,9 +16,21 @@ trim_trailing_whitespace = true
 # --- Specific ----------------------------------
 # -----------------------------------------------
 
-[{Makefile,.gitmodules}]
+[*.{yaml,yml,sh,bats}]
+indent_size = 2
+
+[Makefile]
 indent_style = tab
 indent_size = 4
 
 [*.md]
 trim_trailing_whitespace = false
+
+# -----------------------------------------------
+# --- Git Submodules ----------------------------
+# -----------------------------------------------
+
+[{test/bats/**,test/test_helper/**,target/docker-configomat/**}]
+indent_style = none
+indent_size = none
+end_of_line = none

.gitattributes

@@ -1,158 +0,0 @@
-# Normalize line endings of all non-binary files to LF upon check-in (`git add` / `git commit`):
-* text=auto
-
-#################################################
-###  General  ###################################
-#################################################
-
-## GENERIC
-### CI + docs/mkdocs.yml
-*.yml               text
-### Documentation (Project, Tests, Docs site)
-*.md                text
-### TLS certs (test/files/) + DHE params (target/shared/)
-*.pem               text
-*.pem.sha512sum     text
-
-#################################################
-###  Project  ###################################
-#################################################
-
-## BUILD:
-.dockerignore       text
-Dockerfile          text eol=lf
-Makefile
-
-## EXAMPLE (RUNTIME):
-*.env               text
-*.yaml              text
-
-## PROJECT
-.editorconfig       text export-ignore
-.gitattributes      text export-ignore
-.gitignore          text export-ignore
-.gitkeep            text export-ignore
-.gitmodules         text export-ignore
-LICENSE             text
-
-## SOURCE CODE
-*.sh                text eol=lf
-### acme.json extractor (target/bin/)
-*.py                text eol=lf
-### Only contain scripts (glob for extensionless)
-target/bin/**       text eol=lf
-
-#################################################
-###  Config  ####################################
-#################################################
-
-## CONFIG
-### Contains all text files (glob for extensionless)
-target/amavis/**    text
-target/fetchmail/** text
-target/getmail/**   text
-target/opendkim/**  text
-target/opendmarc/** text
-target/postgrey/**  text
-target/postsrsd/**  text
-### Generic target/ + test/config/
-*.cf                text
-*.conf              text
-### Dovecot
-*.ext               text
-*.sieve             text
-### Dovecot + Rspamd
-*.inc               text
-### Fail2Ban + Postgrey (test/config/)
-*.local             text
-### Postfix
-*.pcre              text
-
-#################################################
-###  Tests  #####################################
-#################################################
-
-## BATS
-*.bash              text eol=lf
-*.bats              text eol=lf
-
-## CONFIG (test/config/)
-### OpenLDAP image
-*.ldif              text
-### OpenDKIM
-*.private           text
-KeyTable            text
-SigningTable        text
-TrustedHosts        text
-### Postgrey
-whitelist_recipients text
-
-## MISC
-### test/config/ + test/files/
-*.txt               text
-### test/linting/ (.ecrc.json) + test/files/ (*.acme.json):
-*.json              text
-
-#################################################
-###  Documentation  Website #####################
-#################################################
-
-## DOCUMENTATION
-### docs/content/assets/
-*.css               text
-*.png               binary
-*.svg               text -diff
-*.woff              binary
-### docs/overrides/
-*.html              text
-*.ico               binary
-*.webp              binary
-
-#################################################
-###  Info # #####################################
-#################################################
-
-### WHAT IS THIS FILE?
-# `.gitattributes` - Pattern-based overrides (Project specific)
-# Documentation: https://git-scm.com/docs/gitattributes
-#
-# Travels with the project and can override the defaults from `.gitconfig`.
-# This helps to enforce consistent line endings (CRLF / LF) where needed via
-# patterns (_when the git client supports `.gitattributes`_).
-
-# `.gitconfig` - Global Git defaults (Dev environment)
-# Documentation: https://git-scm.com/docs/git-config
-#
-# Git settings `core.autocrlf` and `core.eol` can vary across dev environments.
-# Those defaults can introduce subtle bugs due to incompatible line endings.
-
-
-### WHY SHOULD I CARE?
-# The desired result is to ensure the repo contains normalized LF line endings,
-# notably avoiding unhelpful noise in diffs or issues incurred from mixed line
-# endings. Storing as LF ensures no surprises for line endings during checkout.
-# Additionally for checkout to the local working directory, line endings can be
-# forced to CRLF or LF per file where appropriate, which ensures the files have
-# compatible line endings where software expects a specific kind.
-#
-# Examples:
-# Diffs with nothing visual changed. Line endings appear invisible.
-# Tests that compare text from two sources where only line endings differ fail.
-# /bin/sh with a shebang fails to run a binary at the given path due to a CRLF.
-
-
-### ATTRIBUTES
-# `text` normalizes the line endings of a file to LF upon commit (CRLF -> LF).
-# `text=auto` sets `text` if Git doesn't consider the file as binary data.
-
-# `eol` sets an explicit line ending to write files to the working directory.
-# `core.eol` is used for any files not explicitly set with an `eol` attr value.
-# `core.eol` uses the native line endings for your platform by default.
-# `core.autocrlf` (if set to `true` or `input`) overrides the `core.eol` value.
-
-# `binary` is an alias for `-text -diff`. The file won't be normalized (-text).
-# `-diff` indicates to avoid creating a diff. Useful when diffs are unlikely
-# to be meaningful, such as generated content (SVG, Source Maps, Lockfiles).
-
-# `export-ignore` excludes matched files and directories during `git archive`,
-# which services like Github use to create releases with archived source files.

.github/FUNDING.yml

@@ -1,11 +0,0 @@
-github: [georglauterbach]
-# patreon: # Replace with a single Patreon username
-# open_collective: # Replace with a single Open Collective username
-# ko_fi: # Replace with a single Ko-fi username
-# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-# liberapay: # Replace with a single Liberapay username
-# issuehunt: # Replace with a single IssueHunt username
-# otechie: # Replace with a single Otechie username
-# lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
-# custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,69 +1,173 @@
-name: Bug Report
-description: Submit a bug report to help us improve
-title: 'bug report: '
+name: Bug report
+description: File a bug report
+title: "[BUG] "
 labels:
-  - kind/bug/report
+  - kind/bug
   - meta/needs triage
+  - priority/medium
 
 body:
+  - type: markdown
+    attributes:
+      value: |
+        # Filing a report
+
+        Thank you for participating in this project and reporting a bug. Docker Mail Server (DMS) is a community-driven project, and each contribution counts.
+
+        Please **fill out all the fields and checkboxes of this form** to make it easier for maintainers to understand the problem and to solve it. The maintainers and moderators are volunteers that need you to fill this template with accurate informations in order to help you in the best and quickest way. We will have to label your request with `meta/no template - no support` if your request is sloppy and provides no way to help you correctly.
+
+        **Make sure** you read through the whole [README](https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md), the [documentation](https://docker-mailserver.github.io/docker-mailserver/edge/) and the [issue tracker](https://github.com/docker-mailserver/docker-mailserver/issues?q=is%3Aissue) before opening a new bug report.
+
+        ## Levels of support
+
+        We provide official support for
+
+        1. OS/ARCH: Linux on amd64/x86_64 or ARMv7 or ARM64
+        2. Containerization platform: Docker and Docker Compose (i.e. based on Docker Engine)
+
+        Other configurations are not officially supported, but there are maintainers that may be able to help you. This is the case for
+
+        1. OS/ARCH: macOS
+        2. Containerization platform: Kubernetes (K8s)
+
+        Support for these cases is dependent on specific maintainers, and these cases are marked with `not officially supported`. All other cases are not supported and there are very likely no maintainers that can help you. These cases are marked with `unsupported`.
   - type: checkboxes
-    id: preliminary-checks
+    id: miscellaneous-first-checks
     attributes:
-      label: 📝 Preliminary Checks
-      description: |
-        By submitting this issue, you agree to our [Code of Conduct](https://github.com/docker-mailserver/docker-mailserver/blob/master/CODE_OF_CONDUCT.md).
+      label: Miscellaneous first checks
+      description: Please read these carefully.
       options:
-        - label: I tried searching for an existing issue and followed the [debugging docs](https://docker-mailserver.github.io/docker-mailserver/latest/config/debugging/) advice, but still need assistance.
+        - label: I checked that all ports are open and not blocked by my ISP / hosting provider.
           required: true
-  - type: textarea
-    id: what-happened
+        - label: I know that SSL errors are likely the result of a wrong setup on the user side and not caused by DMS itself. I'm confident my setup is correct.
+          required: true
+  - type: input
+    id: affected-components
     attributes:
-      label: 👀 What Happened?
-      description: How did this differ from your expectations?
-      placeholder: Although `LOG_LEVEL=debug` is set, the logs are missing debug output.
+      label: Affected Component(s)
+      description: What is affected by this bug? Please describe it with only a few words here. Detailed description can be given later.
+      placeholder: No debug output is shown.
     validations:
       required: true
   - type: textarea
-    id: steps-to-reproduce
+    id: when-does-it-occur
     attributes:
-      label: 👟 Reproduction Steps
-      description: |
-        How did you trigger this bug? Please walk us through it step by step.
-        Please 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: The easier it is for us to reproduce your issue, the sooner we can help resolve it 😉
+      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.
+      render: Markdown
+    validations:
+      required: true
+  - type: textarea
+    id: what-did-you-expect-to-happen
+    attributes:
+      label:  What did you expect to happen?
+      description: Tell us what you expected.
+      placeholder: I expected to see debug messages.
+      render: Markdown
+    validations:
+      required: true
+  - type: textarea
+    id: how-do-we-replicate-this-issue
+    attributes:
+      label: How do we replicate the issue?
+      description: What did you do and how can we replicate this issue?
+      value: |
+        1.
+        2.
+        3.
+        ...
+      render: Markdown
+    validations:
+      required: true
   - type: input
     id: mailserver-version
     attributes:
-      label: 🐋 DMS Version
+      label: DMS version
       description: On which version (image tag) did you encounter this bug?
-      placeholder: v12.1.0 (do not put "latest")
+      placeholder: v10.1.2
     validations:
       required: true
-  - type: input
+  - type: dropdown
     id: operating-system
     attributes:
-      label: 💻 Operating System and Architecture
-      description: |
-        Which OS is your docker host running on?
-        **NOTE:** Windows and macOS have limited support.
-      placeholder: Debian 11 (Bullseye) x86_64, Fedora 38 ARM64
+      label: What operating system is DMS running on?
+      options:
+        - Linux
+        - macOS (not officially supported)
+        - Windows (unsupported)
+        - Other (unsupported)
+    validations:
+      required: true
+  - type: dropdown
+    id: isa
+    attributes:
+      label: What instruction set architecture is DMS running on?
+      options:
+        - x86_64 / AMD64
+        - ARM64 / ARM v8 (and newer)
+        - ARM v7
+        - Other (unsupported)
+    validations:
+      required: true
+  - type: dropdown
+    id: container-orchestrator
+    attributes:
+      label: What container orchestration tool are you using?
+      options:
+        - Docker
+        - Docker Compose
+        - Podman (not officially supported)
+        - Kubernetes (not officially supported)
+        - Other (unsupported)
     validations:
       required: true
   - type: textarea
-    id: container-configuration-files
+    id: important-environment-variables
     attributes:
-      label: ⚙️ Container configuration files
-      description: |
-        Show us the `compose.yaml` file or command that you used to run DMS (and possibly other related services).
-        - This field is formatted as YAML.
-        - If you are using Kubernetes, you can alternatively share your manifest files here.
-      render: yml
+      label: docker-compose.yml
+      description: Show us your docker-compose.yml file or your equivalent "docker run" command.
+      render: yaml
   - type: textarea
     id: relevant-log-output
     attributes:
-      label: 📜 Relevant log output
-      description: |
-        Show us relevant log output here.
-        - This field expects only plain text (_rendered as a fenced code block_).
-        - You can enable debug output by setting the environment variable `LOG_LEVEL` to `debug` or `trace`.
-      render: Text
+      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`.
+      render: shell
+  - type: textarea
+    id: other-relevant-information
+    attributes:
+      label: Other relevant information
+      description: If there is more, you can tell us here. Make sure to use Markdown formatting here.
+      render: Markdown
+  - type: checkboxes
+    id: experience
+    attributes:
+      label: What level of experience do you have with Docker and mail servers?
+      description: >
+        **You are not obliged to answer this question**.
+        We do encourage answering though as it provides context to better assist you.
+        Less experienced users tend to make common mistakes, which is ok; by letting us know we can spot those more easily.
+        
+      options:
+        - 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:
+      label: Code of conduct
+      description: By submitting this issue, you agree to follow [our code of conduct](https://github.com/docker-mailserver/docker-mailserver/blob/master/CODE_OF_CONDUCT.md).
+      options:
+        - label: I have read this project's [Code of Conduct](https://github.com/docker-mailserver/docker-mailserver/blob/master/CODE_OF_CONDUCT.md) and I agree
+          required: true
+        - label: I have read the [README](https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md) and the [documentation](https://docker-mailserver.github.io/docker-mailserver/edge/) and I searched the [issue tracker](https://github.com/docker-mailserver/docker-mailserver/issues?q=is%3Aissue) but could not find a solution
+          required: true
+  - type: textarea
+    id: form-improvements
+    attributes:
+      label: Improvements to this form?
+      description: If you have criticism or general feedback about this issue form, feel free to tell us so we can enhance the experience for everyone.
+      render: Markdown

.github/ISSUE_TEMPLATE/config.yml

@@ -1,12 +1,9 @@
 blank_issues_enabled: false
 
 contact_links:
-  - name: Documentation | Landing Page
-    url: https://docker-mailserver.github.io/docker-mailserver/latest
-    about: Visit this first before opening issues!
-  - name: Documentation | Environment Variables Page
-    url: https://docker-mailserver.github.io/docker-mailserver/latest/config/environment/
-    about: Read this page for information about mail server variables.
-  - name: Documentation | Debugging Page
-    url: https://docker-mailserver.github.io/docker-mailserver/latest/config/debugging/
-    about: Read this page for information on how to debug DMS.
+  - name: Documentation
+    url: https://docker-mailserver.github.io/docker-mailserver/edge
+    about: Extended documentaton - visit this first before opening issues
+  - name: Environment Variables Section
+    url: https://docker-mailserver.github.io/docker-mailserver/edge/config/environment/
+    about: Read this section for information about mail server variables

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,48 @@
+---
+name: "\U0001F389 Feature request"
+about: Suggest an idea for this project
+title: '[FR]'
+labels: area/enhancement, kind/feature (request), meta/needs triage, priority/low
+assignees: ''
+
+---
+
+# Feature Request
+
+## Context
+
+
+
+### Is your Feature Request related to a Problem?
+
+
+
+### Describe the Solution you'd like
+
+
+
+### Are you going to implement it?
+
+<!-- Select one, remove the other and do not shorten the sentence -->
+
+Yes, because I know the probability of someone else doing it is low and I can learn from it.
+
+No, and I understand that it is highly likely no one will implement it. Furthermore, I understand that this issue will likely become stale and will be closed.
+
+### What are you going to contribute??
+
+
+
+## Additional context
+
+### Alternatives you've considered
+
+
+
+### Who will that Feature be useful to?
+
+
+
+### What have you done already?
+
+

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,62 +0,0 @@
-name: Feature Request
-description: Suggest an idea for this project
-title: 'feature request: '
-labels:
-  - kind/new feature
-  - meta/needs triage
-projects:
-  - DMS Core Backlog
-
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Markdown formatting can be used in almost all text fields. The description will tell you if this is not the case for a specific field.
-
-        Be as precise as possible, and if in doubt, it's best to add more information that too few.
-
-        ---
-  - type: textarea
-    id: context
-    attributes:
-      label: Context
-      description: Tell us how your request is related to DMS, one of its components or another issue / PR. Also **link all conected issues and PRs here**!
-    validations:
-      required: true
-  - type: textarea
-    id: description
-    attributes:
-      label: Description
-      description: Describe the solution you would like to have implemented. Be as precise as possible!
-    validations:
-      required: true
-  - type: textarea
-    id: alternatives
-    attributes:
-      label: Alternatives
-      description: Which alternatives have you considered?
-    validations:
-      required: true
-  - type: textarea
-    id: applicable-users
-    attributes:
-      label: Applicable Users
-      description: Who will that feature be useful to?
-    validations:
-      required: true
-  - type: dropdown
-    id: implementer
-    attributes:
-      label: Are you going to implement it?
-      options:
-        - Yes, because I know the probability of someone else doing it is low and I can learn from it.
-        - No, and I understand that it is highly likely no one will implement it. Furthermore, I understand that this issue will likely become stale and will be closed.
-    validations:
-      required: true
-  - type: textarea
-    id: contribution
-    attributes:
-      label: What are you going to contribute?
-      description: You may also tell us what you have already done.
-    validations:
-      required: true

.github/ISSUE_TEMPLATE/question.yml

@@ -1,30 +0,0 @@
-name: Other
-description: Miscellaneous questions and reports for the project (not support)
-title: 'other: '
-labels:
-  - meta/help wanted
-
-body:
-  - type: dropdown
-    id: subject
-    attributes:
-      label: Subject
-      options:
-        - I would like to contribute to the project
-        - I would like to configure a not documented mail server use case
-        - I would like some feedback concerning a use case
-        - Something else that requires developers attention
-    validations:
-      required: true
-  - type: textarea
-    id: description
-    validations:
-      required: true
-    attributes:
-      label: Description
-      value: |
-        <!---
-        Please do not use this form to bypass doing a proper bug report.
-        The issue tracker is for anything relevant to the project itself, not individual support queries.
-        If you don't want to fill out a bug report, please ask support questions at our community discussions page: https://github.com/orgs/docker-mailserver/discussions
-        -->

.github/ISSUE_TEMPLATE/questions.md

@@ -0,0 +1,27 @@
+---
+name: "❓ Question / Other"
+about: Ask a question about docker-mailserver
+title: ''
+labels: kind/question, priority/low, meta/help wanted, meta/needs triage
+assignees: ''
+
+---
+
+# Subject
+
+<!-- Select one, remove the others -->
+
+I would like to contribute to the project
+I would like to configure a not documented mail server use case
+I would like some feedback concerning a use case
+I have questions about TLS/SSL/STARTTLS/OpenSSL
+Other
+
+## Description
+
+<!-- When copy/pasting code, format the code with tripe backticks (`) ! -->
+
+``` BASH
+# CODE GOES HERE
+
+```

.github/dependabot.yml

@@ -4,16 +4,9 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+    reviewers:
+      - "georglauterbach"
+      - "wernerfred"
     labels:
       - "area/ci"
-      - "kind/update"
       - "priority/low"
-
-  - package-ecosystem: "docker"
-    directory: /
-    schedule:
-      interval: "weekly"
-    labels:
-      - "area/ci"
-      - "kind/update"
-      - "priority/medium"

.github/pull_request_template.md

@@ -1,9 +1,7 @@
 # Description
 
-<!--
-  Include a summary of the change.
-  Please also include relevant motivation and context.
--->
+<!-- Include a summary of the change.
+     Please also include relevant motivation and context. -->
 
 <!-- Link the issue which will be fixed (if any) here: -->
 Fixes #
@@ -18,12 +16,11 @@ Fixes #
 - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
 - [ ] This change requires a documentation update
 
-## Checklist
+## Checklist:
 
 - [ ] My code follows the style guidelines of this project
-- [ ] I have performed a self-review of my code
+- [ ] I have performed a self-review of my own code
 - [ ] I have commented my code, particularly in hard-to-understand areas
 - [ ] I have made corresponding changes to the documentation (README.md or the documentation under `docs/`)
-- [ ] If necessary, I have added tests that prove my fix is effective or that my feature works
+- [ ] If necessary I have added tests that prove my fix is effective or that my feature works
 - [ ] New and existing unit tests pass locally with my changes
-- [ ] **I have added information about changes made in this PR to `CHANGELOG.md`**

.github/workflows/contributors.yml

@@ -0,0 +1,65 @@
+name: Update contributors
+on:
+  workflow_dispatch:
+  schedule:
+    - cron:  '0 0 1 * *'
+
+jobs:
+  delete-old-branch:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    steps:
+      - name: Delete old contributors-update branch
+        uses: dawidd6/action-delete-branch@v3
+        with:
+          github_token: ${{secrets.GITHUB_TOKEN}}
+          branches: contributors-update
+
+  add-contributors:
+    runs-on: ubuntu-latest
+    needs: delete-old-branch
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Create contributors-update branch
+        uses: peterjgrainger/action-create-branch@v2.0.1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          branch: 'contributors-update'
+
+      - name: Auto-add contributors
+        uses: BobAnkh/add-contributors@v0.2.2
+        with:
+          BRANCH: 'contributors-update'
+          PULL_REQUEST: 'master'
+          CONTRIBUTOR: '## Contributors'
+          COLUMN_PER_ROW: '6'
+          ACCESS_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          IMG_WIDTH: '100'
+          FONT_SIZE: '14'
+          PATH: '/CONTRIBUTORS.md'
+          COMMIT_MESSAGE: 'docs(CONTRIBUTORS): update contributors'
+          AVATAR_SHAPE: 'round'
+
+      # This workflow will not trigger a `pull_request` event without a PAT.
+      # The lint workflow is not important for this type of PR, skip it and pretend it was successful:
+      - name: 'Get the latest commit hash from the contributors-update branch'
+        id: commit-data
+        run: |
+          git pull
+          git checkout contributors-update
+          echo "::set-output name=head_sha::$(git rev-parse contributors-update)"
+
+      - name: 'Commit Status: Set Lint status to success (skipped)'
+        uses: myrotvorets/set-commit-status-action@1.1.4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          # Skipped workflows are still assigned a "success" status:
+          status: success
+          # This should be the correct commit SHA on the contributors-update branch:
+          sha: ${{ steps.commit-data.outputs.head_sha }}
+          # Name of status check to add/update:
+          context: 'lint'
+          # Optional message/note we can inline to the right of the context name in the UI:
+          description: "Lint skipped. Not relevant."

.github/workflows/default_on_push.yml

@@ -1,4 +1,4 @@
-name: 'Build, Test & Deploy'
+name: "Build, Test & Deploy"
 
 on:
   workflow_dispatch:
@@ -6,34 +6,119 @@ on:
     branches:
       - master
     paths:
-      - target/**
-      - .dockerignore
-      - .gitmodules
-      - Dockerfile
-      - setup.sh
+      - 'target/**'
+      - '.dockerignore'
+      - '.gitmodules'
+      - 'Dockerfile'
+      - 'setup.sh'
     tags:
       - '*.*.*'
 
-permissions:
-  contents: read
-  packages: write
-
 jobs:
-  build-image:
-    name: 'Build AMD64 Image'
-    uses: docker-mailserver/docker-mailserver/.github/workflows/generic_build.yml@master
+  build-and-test-image:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2.3.4
+        with:
+          submodules: recursive
 
-  run-tests:
-    name: 'Test AMD64 Image'
-    needs: build-image
-    uses: docker-mailserver/docker-mailserver/.github/workflows/generic_test.yml@master
-    with:
-      cache-key: ${{ needs.build-image.outputs.build-cache-key }}
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1.6.0
+        id: buildx
 
-  publish-images:
-    name: 'Publish AMD64 and ARM64 Image'
-    needs: [build-image, run-tests]
-    uses: docker-mailserver/docker-mailserver/.github/workflows/generic_publish.yml@master
-    with:
-      cache-key: ${{ needs.build-image.outputs.build-cache-key }}
-    secrets: inherit
+      - name: Cache Docker layers
+        uses: actions/cache@v2.1.6
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
+
+      - name: Build image locally
+        uses: docker/build-push-action@v2.7.0
+        with:
+          builder: ${{ steps.buildx.outputs.name }}
+          context: .
+          file: ./Dockerfile
+          build-args: |
+            VCS_REF=${{ github.sha }}
+            VCS_VER=${{ github.ref }}
+          platforms: linux/amd64
+          load: true
+          tags: mailserver-testing:ci
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Run test suite
+        run: >
+          NAME=mailserver-testing:ci
+          bash -c 'make generate-accounts tests'
+        env:
+          CI: true
+
+  build-multiarch-and-publish:
+    needs: build-and-test-image
+    runs-on: ubuntu-20.04
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v2.3.4
+        with:
+          submodules: recursive
+
+      - name: Prepare tags
+        id: prep
+        uses: docker/metadata-action@v3.6.0
+        with:
+          images: |
+            ${{ secrets.DOCKER_REPOSITORY }}
+            ${{ secrets.GHCR_REPOSITORY }}
+          tags: |
+            type=edge,branch=master
+            type=semver,pattern={{major}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}.{{minor}}.{{patch}}
+          flavor: |
+            latest=auto
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1.2.0
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1.6.0
+        id: buildx
+
+      - name: Cache Docker layers
+        uses: actions/cache@v2.1.6
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v1.10.0
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v1.10.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build images locally
+        uses: docker/build-push-action@v2.7.0
+        with:
+          builder: ${{ steps.buildx.outputs.name }}
+          context: .
+          file: ./Dockerfile
+          build-args: |
+            VCS_REF=${{ github.sha }}
+            VCS_VER=${{ github.ref }}
+          platforms: linux/amd64,linux/arm/v7,linux/arm64
+          push: true
+          tags: ${{ steps.prep.outputs.tags }}
+          cache-from: type=local,src=/tmp/.buildx-cache

.github/workflows/docs-preview-deploy.yml

@@ -1,166 +1,120 @@
-name: 'Documentation (Deploy)'
+name: 'Documentation (run)'
 
 on:
-  # This workflow runs off the primary branch which provides access to the `secrets` context:
   workflow_run:
     workflows: ['Documentation (PR)']
     types:
       - completed
 
-permissions:
-  # Required by `actions/download-artifact`:
-  actions: read
-  # Required by `set-pr-context`:
-  contents: read
-  # Required by `marocchino/sticky-pull-request-comment` (write) + `set-pr-context` (read):
-  pull-requests: write
-  # Required by `myrotvorets/set-commit-status-action`:
-  statuses: write
+# Note: If limiting concurrency is required for this workflow:
+# 1. Add an additional job prior to `preview` to get the PR number make it an output.
+# 2. Assign that new job as a `needs` dependency for the `preview` job.
+# It is still required for `preview` job to download the artifact so that it can access the preview build files.
 
+# This workflow runs off the primary branch and has access to secrets as expected.
 jobs:
-  # NOTE: This is handled as pre-requisite job to minimize the noise from acquiring these two outputs needed for `deploy-preview` ENV:
-  pr-context:
-    name: 'Acquire PR Context'
-    runs-on: ubuntu-24.04
-    outputs:
-      PR_HEADSHA: ${{ steps.set-pr-context.outputs.head-sha }}
-      PR_NUMBER:  ${{ steps.set-pr-context.outputs.number   }}
-    if: ${{ github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.event == 'pull_request' }}
-    steps:
-      - name: 'Get PR context'
-        id: set-pr-context
-        env:
-          # Token is required for the GH CLI:
-          GH_TOKEN: ${{ github.token }}
-          # Best practice for scripts is to reference via ENV at runtime. Avoid using GHA context expressions in the script content directly:
-          # https://github.com/docker-mailserver/docker-mailserver/pull/4247#discussion_r1827067475
-          PR_TARGET_REPO: ${{ github.repository }}
-          # If the PR is from a fork, prefix it with `<owner-login>:`, otherwise only the PR branch name is relevant:
-          PR_BRANCH: |-
-            ${{
-              (github.event.workflow_run.head_repository.owner.login != github.event.workflow_run.repository.owner.login)
-                && format('{0}:{1}', github.event.workflow_run.head_repository.owner.login, github.event.workflow_run.head_branch)
-                || github.event.workflow_run.head_branch
-            }}
-        # Use the GH CLI to query the PR branch, which provides the PR number and head SHA to assign as outputs:
-        # (`--jq` formats JSON to `key=value` pairs and renames `headRefOid` to `head-sha`)
-        run: |
-          gh pr view --repo "${PR_TARGET_REPO}" "${PR_BRANCH}" \
-            --json 'number,headRefOid' \
-            --jq '"number=\(.number)\nhead-sha=\(.headRefOid)"' \
-            >> "${GITHUB_OUTPUT}"
-
-  deploy-preview:
+  preview:
     name: 'Deploy Preview'
-    runs-on: ubuntu-24.04
-    needs: [pr-context]
-    env:
-      # NOTE: Keep this in sync with the equivalent ENV in `docs-preview-prepare.yml`:
-      BUILD_DIR: docs/site/
-      # PR head SHA (latest commit):
-      PR_HEADSHA: ${{ needs.pr-context.outputs.PR_HEADSHA }}
-      PR_NUMBER:  ${{ needs.pr-context.outputs.PR_NUMBER  }}
-      # Deploy URL preview prefix (the site name for this prefix is managed at Netlify):
-      PREVIEW_SITE_PREFIX: pullrequest-${{ needs.pr-context.outputs.PR_NUMBER }}
+    runs-on: ubuntu-20.04
+    if: ${{ github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success' }}
     steps:
-      - name: 'Retrieve and extract the built docs preview'
-        uses: actions/download-artifact@v4
+
+      # ======================== #
+      # Restore workflow context #
+      # ======================== #
+
+      # The official Github Action for downloading artifacts does not support multi-workflow
+      - name: 'Download build artifact'
+        uses: dawidd6/action-download-artifact@v2
         with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          run_id: ${{ github.event.workflow_run.id }}
+          workflow: docs-preview-prepare.yml
           name: preview-build
-          path: ${{ env.BUILD_DIR }}
-          # These are needed due this approach relying on `workflow_run`, so that it can access the build artifact:
-          # (uploaded from the associated `docs-preview-prepare.yml` workflow run)
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          run-id: ${{ github.event.workflow_run.id }}
+
+      - name: 'Extract build artifact'
+        run: tar -xf artifact.tar.zst
+
+      - name: 'Restore preserved ENV'
+        run: cat pr.env >> "${GITHUB_ENV}"
 
       # ==================== #
       # Deploy preview build #
       # ==================== #
 
-      # Manage workflow deployment status (Part 1/2):
-      # NOTE:
-      # - `workflow_run` trigger does not appear on the PR/commit checks status, only the initial prepare workflow triggered.
-      #   This adds our own status check for this 2nd half of the workflow starting as `pending`, followed by `success` / `failure` at the end.
-      # - `enable-commit-status` from `nwtgck/actions-netlify` would have handled this,
-      #   but the context `github.sha` that action tries to use references the primary branch commit that this workflow runs from, not the relevant PR commit.
-      - name: 'Commit Status (1/2) - Set Workflow Status as Pending'
-        uses: myrotvorets/set-commit-status-action@v2.0.1
+      # Manage workflow deployment status. `enable-commit-status` from `nwtgck/actions-netlify` would handle this,
+      # but presently does not work correctly via split workflow. It is useful in a split workflow as the 1st stage
+      # no longer indicates if the entire workflow/deployment was successful.
+      - name: 'Commit Status: Set Workflow Status as Pending'
+        uses: myrotvorets/set-commit-status-action@1.1.4
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           status: pending
-          sha: ${{ env.PR_HEADSHA }}
+          # Should match `env.PR_HEADSHA` when triggered by `pull_request` event workflow,
+          # Avoids failure of ENV being unavailable if job fails early:
+          sha: ${{ github.event.workflow_run.head_sha }}
           context: 'Deploy Preview (pull_request => workflow_run)'
 
       - name: 'Send preview build to Netlify'
-        uses: nwtgck/actions-netlify@v3.0
-        id: preview-netlify
+        uses: nwtgck/actions-netlify@v1.2
+        id: preview
         timeout-minutes: 1
         env:
           NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
-          NETLIFY_SITE_ID:    ${{ secrets.NETLIFY_SITE_ID    }}
+          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
         with:
-          # Fail the job when the required Netlify credentials are missing from ENV:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          # Fail the job early if credentials are missing / invalid:
           fails-without-credentials: true
-          # Set/create the Netlify deploy URL prefix:
-          alias: ${{ env.PREVIEW_SITE_PREFIX }}
+          # Sets/creates the Netlify deploy URL prefix.
+          # Uses the PR number for uniqueness:
+          alias: ${{ env.NETLIFY_SITE_PREFIX }}
           # Only publish the contents of the build output:
           publish-dir: ${{ env.BUILD_DIR }}
           # Custom message for the deploy log on Netlify:
-          deploy-message: 'Preview Build (PR #${{ env.PR_NUMBER }} @ commit: ${{ env.PR_HEADSHA }}'
+          deploy-message: '${{ env.PR_TITLE }} (PR #${{ env.PR_NUMBER }} @ commit: ${{ env.PR_HEADSHA }})'
 
-          # Disable unwanted action defaults:
-          # This input does not fallback to the GITHUB_TOKEN taken from context, nor log that it will skip extra features of the action when this input is not set:
-          # https://github.com/nwtgck/actions-netlify/issues/1219
-          # github-token: ${{ secrets.GITHUB_TOKEN }}
-          # NOTE: These features won't work correctly when the triggered workflow is not run from the PR branch due to assumed `pull_request` context:
-          # https://github.com/nwtgck/actions-netlify/issues/545
-          # Disable adding a comment to the commit belonging to context `github.sha` about the successful deployment (redundant and often wrong commit):
-          enable-commit-comment: false
-          # Disable adding a "Netlify - Netlify deployment" PR check status (workflow job status is sufficient):
-          enable-commit-status: false
-          # Disable adding a comment about successful deployment status to the PR.
-          # Prefer `marocchino/sticky-pull-request-comment` instead (more flexible and allows custom message):
-          enable-pull-request-comment: false
-          # Opt-out of deployment feature:
-          # NOTE:
-          # - When affected by `nwtgck/actions-netlify/issues/545`, the deployments published reference the wrong commit and thus information.
-          # - While the feature creates or assigns a deployment to associate the build with, it is unrelated to the related environments feature (secrets/vars):
-          #   https://github.com/nwtgck/actions-netlify/issues/538#issuecomment-833983970
-          #   https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-deployments/viewing-deployment-history
-          #   https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment
-          enable-github-deployment: false
+          # Note: Split workflow incorrectly references latest primary branch commit for deployment.
           # Assign to non-default Deployment Environment for better management:
-          # github-deployment-environment: documentation-previews
-          # github-deployment-description: 'Preview deploy for documentation PRs'
+          github-deployment-environment: documentation-previews
+          github-deployment-description: 'Preview deploy for documentation PRs'
+
+          # Note - PR context used by this action is incorrect. These features are broken with split workflow:
+          # https://github.com/nwtgck/actions-netlify/issues/545
+          # Disable unwanted action defaults:
+          # Disable adding deploy comment on pre-merge commit (Github creates this for PR diff):
+          enable-commit-comment: false
+          # Disable adding a "Netlify - Netlify deployment" check status:
+          enable-commit-status: false
+          # Disable. We provide a custom PR comment in the next action:
+          enable-pull-request-comment: false
 
           # If a `netlify.toml` config is ever needed, enable this:
           # netlify-config-path: ./docs/netlify.toml
-          # If ever switching from Github Pages, enable this only when not deploying a preview build (false by default):
+          # If ever switching from Github Pages, enable this conditionally (false by default):
           # production-deploy: false
 
-      - name: 'Comment on PR with preview link'
+      - name: 'Comment on PR: Add/Update deployment status'
         uses: marocchino/sticky-pull-request-comment@v2
         with:
           number: ${{ env.PR_NUMBER }}
           header: preview-comment
           recreate: true
           message: |
-            [Documentation preview for this PR](${{ steps.preview-netlify.outputs.deploy-url }}) is ready! :tada:
+            [Documentation preview for this PR](${{ steps.preview.outputs.deploy-url }}) is ready! :tada:
 
             Built with commit: ${{ env.PR_HEADSHA }}
 
-      # Manage workflow deployment status (Part 2/2):
-      - name: 'Commit Status (2/2) - Update deployment status'
-        uses: myrotvorets/set-commit-status-action@v2.0.1
-        # Always run this step regardless of the job failing early:
+      - name: 'Commit Status: Update deployment status'
+        uses: myrotvorets/set-commit-status-action@1.1.4
+        # Always run this step regardless of job failing early:
         if: ${{ always() }}
-        # Custom status descriptions:
         env:
           DEPLOY_SUCCESS: Successfully deployed preview.
           DEPLOY_FAILURE: Failed to deploy preview.
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           status: ${{ job.status == 'success' && 'success' || 'failure' }}
-          sha: ${{ env.PR_HEADSHA }}
+          sha: ${{ github.event.workflow_run.head_sha }}
           context: 'Deploy Preview (pull_request => workflow_run)'
           description: ${{ job.status == 'success' && env.DEPLOY_SUCCESS || env.DEPLOY_FAILURE }}

.github/workflows/docs-preview-prepare.yml

@@ -7,68 +7,65 @@ on:
       - '.github/workflows/scripts/docs/build-docs.sh'
       - '.github/workflows/docs-preview-prepare.yml'
 
-# If this workflow is triggered while already running for the PR, cancel any earlier running instances:
-# Instances of the 2nd phase of this workflow (via `workflow_run`) lack any concurrency limits due to added complexity.
+# If the workflow for a PR is triggered multiple times, previous existing runs will be canceled.
+# eg: Applying multiple suggestions from a review directly via the Github UI.
+# Instances of the 2nd phase of this workflow (via `workflow_run`) presently lack concurrency limits due to added complexity.
 concurrency:
   group: deploypreview-pullrequest-${{ github.event.pull_request.number }}
   cancel-in-progress: true
 
-env:
-  # Build output directory (created by the mkdocs-material container, keep this in sync with `build-docs.sh`):
-  BUILD_DIR: docs/site/
-  # These two are only needed to construct `PREVIEW_URL`:
-  PREVIEW_SITE_NAME: dms-doc-previews
-  PREVIEW_SITE_PREFIX: pullrequest-${{ github.event.pull_request.number }}
-
 # `pull_request` workflow is unreliable alone: Non-collaborator contributions lack access to secrets for security reasons.
 # A separate workflow (docs-preview-deploy.yml) handles the deploy after the potentially untrusted code is first run in this workflow.
 # See: https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
-permissions:
-  # Required by `actions/checkout` for git checkout:
-  contents: read
-
 jobs:
   prepare-preview:
     name: 'Build Preview'
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-20.04
+    env:
+      BUILD_DIR: docs/site
+      NETLIFY_SITE_PREFIX: pullrequest-${{ github.event.pull_request.number }}
+      NETLIFY_SITE_NAME: dms-doc-previews
     steps:
-      - uses: actions/checkout@v4
-
-      # ================== #
-      # Build docs preview #
-      # ================== #
+      - uses: actions/checkout@v2.3.4
 
       - name: 'Build with mkdocs-material via Docker'
-        working-directory: docs/
+        working-directory: docs
         env:
-          PREVIEW_URL: 'https://${{ env.PREVIEW_SITE_PREFIX }}--${{ env.PREVIEW_SITE_NAME }}.netlify.app/'
+          PREVIEW_URL: 'https://${NETLIFY_SITE_PREFIX}--${NETLIFY_SITE_NAME}.netlify.app/'
+          NETLIFY_BRANDING: '<a href="https://www.netlify.com/"><img alt="Deploys by Netlify" src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg" style="float: right;"></a>'
         run: |
-          # Adjust `mkdocs.yml` for the preview build requirements:
-          # - Replace production `site_url` with the preview URL (only affects the canonical link: https://en.wikipedia.org/wiki/Canonical_link_element#HTML)
-          # - Prepend Netlify logo link to `copyright` content
-          sed -i "s|^site_url:.*|site_url: '${{ env.PREVIEW_URL }}'|" mkdocs.yml
+          # Adjust mkdocs.yml for preview build
+          sed -i "s|^site_url:.*|site_url: '${PREVIEW_URL}'|" mkdocs.yml
 
-          # Insert branding into page content (Netlify OSS plan requirement):
-          # - `mkdocs-material` does not provide a better way to do this.
-          # - Prepends HTML to the copyright text and then aligns the logo to the right-side of the page.
-          NETLIFY_BRANDING='<a href="https://www.netlify.com/"><img alt="Deploys by Netlify" src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg" style="float: right;"></a>'
+          # Insert sponsor branding into page content (Provider OSS plan requirement):
+          # Upstream does not provide a nicer maintainable way to do this..
+          # Prepends HTML to copyright text and then aligns to the right side.
           sed -i "s|^copyright: '|copyright: '${NETLIFY_BRANDING}|" mkdocs.yml
-          # Override a CSS media query for the parent element to always be full width:
+          # Need to override a CSS media query for parent element to always be full width:
           echo '.md-footer-copyright { width: 100%; }' >> content/assets/css/customizations.css
 
-          # Build and prepare for upload:
-          echo "::group::Build (stdout)"
-          bash ../.github/workflows/scripts/docs/build-docs.sh
-          echo "::endgroup::"
+          ../.github/workflows/scripts/docs/build-docs.sh
 
       # ============================== #
       # Volley over to secure workflow #
       # ============================== #
 
-      # Archives directory `path` into a ZIP file:
+      # Minimize risk of upload failure by bundling files to a single compressed archive (tar + zstd).
+      # Bundles build dir and env file into a compressed archive, nested file paths will be preserved.
+      - name: 'Prepare artifact for transfer'
+        run: |
+          # Save ENV for transfer
+          echo "PR_HEADSHA=${{ github.event.pull_request.head.sha }}" >> pr.env
+          echo "PR_NUMBER=${{ github.event.pull_request.number }}"    >> pr.env
+          echo "PR_TITLE=${{ github.event.pull_request.title }}"      >> pr.env
+          echo "NETLIFY_SITE_PREFIX=${{ env.NETLIFY_SITE_PREFIX }}"   >> pr.env
+          echo "BUILD_DIR=${{ env.BUILD_DIR }}"                       >> pr.env
+
+          tar --zstd -cf artifact.tar.zst pr.env ${{ env.BUILD_DIR }}
+
       - name: 'Upload artifact for workflow transfer'
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v2
         with:
           name: preview-build
-          path: ${{ env.BUILD_DIR }}
+          path: artifact.tar.zst
           retention-days: 1

.github/workflows/docs-production-deploy.yml

@@ -23,12 +23,10 @@ env:
 
 jobs:
   deploy:
-    permissions:
-      contents: write
     name: 'Deploy Docs'
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v2.3.4
 
       - name: 'Check if deploy is for a `v<major>.<minor>` tag version instead of `edge`'
         if: startsWith(github.ref, 'refs/tags/')
@@ -55,11 +53,11 @@ jobs:
           # Replace the tagged '${DOCS_VERSION}' in the 'canonical' link element of HTML files,
           # to point to the 'edge' version of docs as the authoritative source:
           find . -type f -name "*.html" -exec \
-            sed -i "s|^\(.*<link rel=\"canonical\".*\)${DOCS_VERSION}|\1latest|" \
+            sed -i "s|^\(.*<link rel=\"canonical\".*\)${DOCS_VERSION}|\1edge|" \
             {} +
 
       - name: 'Deploy to Github Pages'
-        uses: peaceiris/actions-gh-pages@v4.0.0
+        uses: peaceiris/actions-gh-pages@v3.8.0
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           # Build directory contents to publish to the `gh-pages` branch:
@@ -70,19 +68,17 @@ jobs:
           user_email: ${{ env.GIT_EMAIL }}
 
   add-version-to-docs:
-    permissions:
-      contents: write
     name: 'Update `versions.json` if necessary'
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-20.04
     if: startsWith(github.ref, 'refs/tags/')
     # Avoid race condition with pushing to `gh-pages` branch by waiting for `deploy` to complete first
     needs: deploy
     steps:
       - name: 'Checkout the tagged commit (shallow clone)'
-        uses: actions/checkout@v4
+        uses: actions/checkout@v2.3.4
 
       - name: 'Checkout the docs deployment branch to a subdirectory'
-        uses: actions/checkout@v4
+        uses: actions/checkout@v2.3.4
         with:
           ref: gh-pages
           path: gh-pages
@@ -105,32 +101,3 @@ jobs:
           git add versions.json
           git commit -m "chore: Add ${{ env.DOCS_VERSION }} to version selector list"
           git push
-
-  update-latest-symlink:
-    permissions:
-      contents: write
-    name: 'update `latest` symlink if neccessary'
-    runs-on: ubuntu-22.04
-    if: startsWith(github.ref, 'refs/tags/')
-    needs: add-version-to-docs
-    steps:
-      - name: 'Checkout the docs deployment branch'
-        uses: actions/checkout@v4
-        with:
-          ref: gh-pages
-
-      - name: 'Ensure `latest` symlink refers to the substring from tag name'
-        id: update-latest
-        run: |
-          DOCS_VERSION=$(grep -oE 'v[0-9]+\.[0-9]+' <<< "${GITHUB_REF}")
-          echo "DOCS_VERSION=${DOCS_VERSION}" >>"${GITHUB_ENV}"
-          rm latest
-          ln -s "${DOCS_VERSION}" latest
-
-      - name: 'Push update for `latest` symlink'
-        run: |
-          git config user.name ${{ env.GIT_USER }}
-          git config user.email ${{ env.GIT_EMAIL }}
-          git add latest
-          git commit -m "chore: Update \`latest\` symlink to point to ${{ env.DOCS_VERSION }}"
-          git push

.github/workflows/generic_build.yml

@@ -1,107 +0,0 @@
-name: 'Build the DMS Container Image'
-
-on:
-  workflow_call:
-    inputs:
-      platforms:
-        required: false
-        type: string
-        default: linux/amd64
-    outputs:
-      build-cache-key:
-        description: The cache key to use when restoring an image later
-        value: ${{ jobs.build-image.outputs.build-cache-key }}
-
-permissions:
-  contents: read
-
-# `actions/cache` does not upload a new cache until completing a job successfully.
-# To better cache image builds, tests are handled in a dependent job afterwards.
-# This way failing tests will not prevent caching of an image. Useful when the build context
-# is not changed by new commits.
-
-jobs:
-  build-image:
-    name: 'Build'
-    runs-on: ubuntu-22.04
-    outputs:
-      build-cache-key: ${{ steps.derive-image-cache-key.outputs.digest }}
-    steps:
-      - name: 'Checkout'
-        uses: actions/checkout@v4
-        with:
-          submodules: recursive
-
-      # Can potentially be replaced by: `${{ hashFiles('target/**', 'Dockerfile') }}`
-      # Must not be affected by file metadata changes and have a consistent sort order:
-      # https://docs.github.com/en/actions/learn-github-actions/expressions#hashfiles
-      # Keying by the relevant build context is more re-usable than a commit SHA.
-      - name: 'Derive Docker image cache key from content'
-        id: derive-image-cache-key
-        shell: bash
-        run: |
-          ADDITIONAL_FILES=( 'Dockerfile' )
-
-          # Recursively collect file paths from `target/` and pipe a list of
-          # checksums to be sorted (by hash value) and finally generate a checksum
-          # of that list, using `awk` to only return the hash value (digest):
-          IMAGE_CHECKSUM=$(\
-            find ./target -type f -exec sha256sum "${ADDITIONAL_FILES[@]}" {} + \
-              | sort \
-              | sha256sum \
-              | awk '{ print $1 }' \
-          )
-
-          echo "digest=${IMAGE_CHECKSUM}" >>"${GITHUB_OUTPUT}"
-
-      # Attempts to restore the build cache from a prior build run.
-      # If the exact key is not restored, then upon a successful job run
-      # the new cache is uploaded for this key containing the contents at `path`.
-      # Cache storage has a limit of 10GB, and uploads expire after 7 days.
-      # When full, the least accessed cache upload is evicted to free up storage.
-      # https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows
-      - name: 'Handle Docker build layer cache'
-        uses: actions/cache@v4
-        with:
-          path: /tmp/.buildx-cache
-          key: cache-buildx-${{ steps.derive-image-cache-key.outputs.digest }}
-          # If no exact cache-hit for key found, lookup caches with a `cache-buildx-` key prefix:
-          # This is safe due to cache layer invalidation via the image build context.
-          restore-keys: |
-            cache-buildx-
-
-      - name: 'Set up QEMU'
-        uses: docker/setup-qemu-action@v3.6.0
-        with:
-          platforms: arm64
-
-      - name: 'Set up Docker Buildx'
-        uses: docker/setup-buildx-action@v3.10.0
-
-      # NOTE: AMD64 can build within 2 minutes
-      - name: 'Build images'
-        uses: docker/build-push-action@v6.15.0
-        with:
-          context: .
-          # Build at least the AMD64 image (which runs against the test suite).
-          platforms: ${{ inputs.platforms }}
-          # Paired with steps `actions/cache` and `Replace cache` (replace src with dest):
-          # NOTE: `mode=max` is only for `cache-to`, it configures exporting all image layers.
-          # https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md#cache-from
-          cache-from: type=local,src=/tmp/.buildx-cache
-          cache-to: type=local,dest=/tmp/.buildx-cache-new,mode=max
-          # This job just builds the image and stores to cache, no other exporting required:
-          # https://github.com/docker/build-push-action/issues/546#issuecomment-1122631106
-          outputs: type=cacheonly
-          # Disable provenance attestation: https://docs.docker.com/build/attestations/slsa-provenance/
-          provenance: false
-
-      # WORKAROUND: The `cache-to: type=local` input for `build-push-action` persists old-unused cache.
-      # The workaround is to write the new build cache to a different location that replaces the
-      # original restored cache after build, reducing frequency of eviction due to cache storage limit (10GB).
-      # https://github.com/docker/build-push-action/blob/965c6a410d446a30e95d35052c67d6eded60dad6/docs/advanced/cache.md?plain=1#L193-L199
-      # NOTE: This does not affect `cache-hit == 'true'` (which skips upload on direct cache key hit)
-      - name: 'Replace cache'
-        run: |
-          rm -rf /tmp/.buildx-cache
-          mv /tmp/.buildx-cache-new /tmp/.buildx-cache

.github/workflows/generic_publish.yml

@@ -1,81 +0,0 @@
-name: 'Publish the DMS Container Image'
-
-on:
-  workflow_call:
-    inputs:
-      cache-key:
-        required: true
-        type: string
-
-permissions:
-  contents: read
-  packages: write
-
-jobs:
-  publish-images:
-    name: 'Publish'
-    runs-on: ubuntu-22.04
-    steps:
-      - name: 'Checkout'
-        uses: actions/checkout@v4
-        with:
-          submodules: recursive
-
-      - name: 'Prepare tags'
-        id: prep
-        uses: docker/metadata-action@v5.7.0
-        with:
-          images: |
-            ${{ secrets.DOCKER_REPOSITORY }}
-            ${{ secrets.GHCR_REPOSITORY }}
-          tags: |
-            type=edge,branch=master
-            type=semver,pattern={{major}}
-            type=semver,pattern={{major}}.{{minor}}
-            type=semver,pattern={{major}}.{{minor}}.{{patch}}
-
-      - name: 'Set up QEMU'
-        uses: docker/setup-qemu-action@v3.6.0
-        with:
-          platforms: arm64
-
-      - name: 'Set up Docker Buildx'
-        uses: docker/setup-buildx-action@v3.10.0
-
-      # Try get the cached build layers from a prior `generic_build.yml` job.
-      # NOTE: Until adopting `type=gha` scoped cache exporter (in `docker/build-push-action`),
-      # only AMD64 image is expected to be cached, ARM images will build from scratch.
-      - name: 'Retrieve image build from build cache'
-        uses: actions/cache@v4
-        with:
-          path: /tmp/.buildx-cache
-          key: cache-buildx-${{ inputs.cache-key }}
-          restore-keys: |
-            cache-buildx-
-
-      - name: 'Login to DockerHub'
-        uses: docker/login-action@v3
-        with:
-          username: ${{ secrets.DOCKER_USERNAME }}
-          password: ${{ secrets.DOCKER_PASSWORD }}
-
-      - name: 'Login to GitHub Container Registry'
-        uses: docker/login-action@v3
-        with:
-          registry: ghcr.io
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: 'Build and publish images'
-        uses: docker/build-push-action@v6.15.0
-        with:
-          context: .
-          build-args: |
-            DMS_RELEASE=${{ github.ref_type == 'tag' && github.ref_name || 'edge' }}
-            VCS_REVISION=${{ github.sha }}
-          platforms: linux/amd64,linux/arm64
-          push: true
-          tags: ${{ steps.prep.outputs.tags }}
-          cache-from: type=local,src=/tmp/.buildx-cache
-          # Disable provenance attestation: https://docs.docker.com/build/attestations/slsa-provenance/
-          provenance: false

.github/workflows/generic_test.yml

@@ -1,59 +0,0 @@
-name: 'Test the DMS Container Image'
-
-on:
-  workflow_call:
-    inputs:
-      cache-key:
-        required: true
-        type: string
-
-permissions:
-  contents: read
-
-jobs:
-  run-tests:
-    name: 'Test'
-    runs-on: ubuntu-22.04
-    strategy:
-      matrix:
-        part: [serial, parallel/set1, parallel/set2, parallel/set3]
-      fail-fast: false
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          # Required to retrieve bats (core + extras):
-          submodules: recursive
-
-      # Get the cached build layers from the build job:
-      # This should always be a cache-hit, thus `restore-keys` fallback is not used.
-      # No new cache uploads should ever happen for this job.
-      - name: 'Retrieve image built from build cache'
-        uses: actions/cache@v4
-        with:
-          path: /tmp/.buildx-cache
-          key: cache-buildx-${{ inputs.cache-key }}
-
-      # Configures buildx to use `docker-container` driver,
-      # Ensures consistent BuildKit version (not coupled to Docker Engine),
-      # and increased compatibility of the build cache vs mixing buildx drivers.
-      - name: 'Set up Docker Buildx'
-        uses: docker/setup-buildx-action@v3.10.0
-
-      # Importing from the cache should create the image within approx 30 seconds:
-      # NOTE: `qemu` step is not needed as we only test for AMD64.
-      - name: 'Build AMD64 image from cache'
-        uses: docker/build-push-action@v6.15.0
-        with:
-          context: .
-          tags: mailserver-testing:ci
-          # Export the built image to the Docker host for use with BATS:
-          load: true
-          # Rebuilds the AMD64 image from the cache:
-          platforms: linux/amd64
-          cache-from: type=local,src=/tmp/.buildx-cache
-          # Disable provenance attestation: https://docs.docker.com/build/attestations/slsa-provenance/
-          provenance: false
-
-      - name: 'Run tests'
-        run: make generate-accounts tests/${{ matrix.part }}

.github/workflows/generic_vulnerability-scan.yml

@@ -1,67 +0,0 @@
-# This workflow checks out code, re-builds an image from cache, performs a container image
-# vulnerability scan with Anchore's Grype tool, and integrates the results with GitHub
-# Advanced Security code scanning feature.
-#
-# For more information on the Anchore scan action usage and parameters, see
-# https://github.com/anchore/scan-action. For more information on Anchore's container
-# image scanning tool Grype, see https://github.com/anchore/grype.
-name: "Anchore Grype Vulnerability Scan"
-
-on:
-  workflow_call:
-    inputs:
-      cache-key:
-        required: true
-        type: string
-
-jobs:
-  scan-image:
-    permissions:
-      contents: read         # for actions/checkout to fetch code
-      security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
-    runs-on: ubuntu-22.04
-    steps:
-      - name: 'Checkout'
-        uses: actions/checkout@v4
-
-      # Get the cached build layers from the build job:
-      # This should always be a cache-hit, thus `restore-keys` fallback is not used.
-      # No new cache uploads should ever happen for this job.
-      - name: 'Retrieve image built from build cache'
-        uses: actions/cache@v4
-        with:
-          path: /tmp/.buildx-cache
-          key: cache-buildx-${{ inputs.cache-key }}
-
-      # Configures buildx to use `docker-container` driver,
-      # Ensures consistent BuildKit version (not coupled to Docker Engine),
-      # and increased compatibility of the build cache vs mixing buildx drivers.
-      - name: 'Set up Docker Buildx'
-        uses: docker/setup-buildx-action@v3.10.0
-
-      # Importing from the cache should create the image within approx 30 seconds:
-      # NOTE: `qemu` step is not needed as we only test for AMD64.
-      - name: 'Build AMD64 image from cache'
-        uses: docker/build-push-action@v6.15.0
-        with:
-          context: .
-          tags: mailserver-testing:ci
-          # Export the built image to the Docker host for later use:
-          load: true
-          # Rebuilds the AMD64 image from the cache:
-          platforms: linux/amd64
-          cache-from: type=local,src=/tmp/.buildx-cache
-          # Disable provenance attestation: https://docs.docker.com/build/attestations/slsa-provenance/
-          provenance: false
-
-      - name: 'Run the Anchore Grype scan action'
-        uses: anchore/scan-action@v6.1.0
-        id: scan
-        with:
-          image: mailserver-testing:ci
-          fail-build: false
-
-      - name: 'Upload vulnerability report'
-        uses: github/codeql-action/upload-sarif@v3
-        with:
-          sarif_file: ${{ steps.scan.outputs.sarif }}

.github/workflows/handle_stalled.yml

@@ -4,18 +4,12 @@ on:
   schedule:
     - cron: "0 1 * * *"
 
-permissions:
-  contents: read
-
 jobs:
   stale:
-    permissions:
-      issues: write
-      pull-requests: write
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-20.04
     steps:
       - name: Close stale issues
-        uses: actions/stale@v9
+        uses: actions/stale@v4
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           days-before-stale: 20
@@ -23,9 +17,9 @@ jobs:
 
           exempt-issue-labels: stale-bot/ignore
           stale-issue-label: meta/stale
-          stale-issue-message: |
-            This issue has become stale because it has been open for 20 days without activity.
-            This issue will be closed in 10 days automatically unless:
+          stale-issue-message: >
+            This issue has become stale because it has been open for 20 days
+            without activity. This issue will be closed in 10 days automatically unless:
 
             - a maintainer removes the `meta/stale` label or adds the `stale-bot/ignore` label
             - new activity occurs, such as a new comment
@@ -35,12 +29,12 @@ jobs:
 
           exempt-pr-labels: stale-bot/ignore
           stale-pr-label: meta/stale
-          stale-pr-message: |
-            This pull request has become stale because it has been open for 20 days without activity.
-            This pull request will be closed in 10 days automatically unless:
+          stale-pr-message: >
+            This pull request has become stale because it has been open for 20 days
+            without activity. This pull request will be closed in 10 days automatically unless:
 
             - a maintainer removes the `meta/stale` label or adds the `stale-bot/ignore` label
             - new activity occurs, such as a new comment
           close-pr-label: "meta/closed due to age or inactivity"
-          close-pr-message: >
+          closed-pr-message: >
             This PR was closed due to inactivity.

.github/workflows/linting.yml

@@ -1,28 +1,35 @@
-name: Lint
+name: "Lint"
 
 on:
-  # A workflow that creates a PR will not trigger this workflow,
-  # Providing a manual trigger as a workaround
-  workflow_dispatch:
   pull_request:
+    branches: [ "*" ]
   push:
-    branches: [ master ]
-
-permissions:
-  contents: read
+    branches:
+      - master
 
 jobs:
   lint:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v2.3.4
+        with:
+          submodules: recursive
 
       - name: Hadolint
-        run: make hadolint
+        run: |
+          make hadolint
+        env:
+          HADOLINT_VERSION: 2.4.1
 
       - name: ShellCheck
-        run: make shellcheck
+        run: |
+          make shellcheck
+        env:
+          SHELLCHECK_VERSION: 0.7.2
 
       - name: ECLint
-        run: make eclint
+        run: |
+          make eclint
+        env:
+          ECLINT_VERSION: 2.3.5

.github/workflows/scheduled_builds.yml

@@ -1,33 +1,57 @@
-name: 'Deploy :edge on Schedule'
+name: "Build Edge on Schedule"
 
 on:
-  workflow_dispatch:
   schedule:
-    - cron: 0 0 * * 5
-
-permissions:
-  contents: read
-  packages: write
-  security-events: write
+    - cron: "0 0 * * 5"
 
 jobs:
-  build-images:
-    name: 'Build Images'
-    uses: docker-mailserver/docker-mailserver/.github/workflows/generic_build.yml@master
-    with:
-      platforms: linux/amd64,linux/arm64
+  publish:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2.3.4
+        with:
+          submodules: recursive
 
-  scan-image:
-    name: 'Scan Image for Vulnerabilities'
-    needs: build-images
-    uses: docker-mailserver/docker-mailserver/.github/workflows/generic_vulnerability-scan.yml@master
-    with:
-      cache-key: ${{ needs.build-images.outputs.build-cache-key }}
+      - name: Prepare tags
+        id: prep
+        uses: docker/metadata-action@v3.6.0
+        with:
+          images: |
+            ${{ secrets.DOCKER_REPOSITORY }}
+            ${{ secrets.GHCR_REPOSITORY }}
+          tags: |
+            type=raw,value=edge
 
-  publish-images:
-    name: 'Publish Images'
-    needs: build-images
-    uses: docker-mailserver/docker-mailserver/.github/workflows/generic_publish.yml@master
-    with:
-      cache-key: ${{ needs.build-images.outputs.build-cache-key }}
-    secrets: inherit
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1.2.0
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1.6.0
+        id: buildx
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v1.10.0
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v1.10.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build image locally
+        uses: docker/build-push-action@v2.7.0
+        with:
+          builder: ${{ steps.buildx.outputs.name }}
+          context: .
+          file: ./Dockerfile
+          build-args: |
+            VCS_REF=${{ github.sha }}
+            VCS_VER=${{ github.ref }}
+          platforms: linux/amd64,linux/arm/v7,linux/arm64
+          push: true
+          tags: ${{ steps.prep.outputs.tags }}

.github/workflows/scripts/docs/build-docs.sh

@@ -7,11 +7,10 @@ set -ex
 # `build --strict` ensures the build fails when any warnings are omitted.
 docker run \
   --rm \
-  --quiet \
   --user "$(id -u):$(id -g)" \
-  --volume "./:/docs" \
+  --volume "${PWD}:/docs" \
   --name "build-docs" \
-  squidfunk/mkdocs-material:9.6 build --strict
+  squidfunk/mkdocs-material:7.3.6 build --strict
 
 # Remove unnecessary build artifacts: https://github.com/squidfunk/mkdocs-material/issues/2519
 # site/ is the build output folder.

.github/workflows/scripts/docs/update-versions-json.sh

@@ -33,7 +33,7 @@ function _update_versions_json
   local VERSION_EXISTS
   VERSION_EXISTS=$(jq --arg version "${MAJOR_MINOR}" '[.[].version == $version] | any' "${VERSIONS_JSON}")
 
-  if [[ ${VERSION_EXISTS} == "true" ]]
+  if [[ "${VERSION_EXISTS}" == "true" ]]
   then
     echo "${MAJOR_MINOR} docs are already supported. Nothing to change, exiting.."
     exit 1

.github/workflows/test_merge_requests.yml

@@ -4,35 +4,67 @@ on:
   workflow_dispatch:
   pull_request:
     paths:
-      - target/**
-      - test/**
-      - .dockerignore
-      - .gitmodules
-      - Dockerfile
-      - Makefile
-      - setup.sh
-
-permissions:
-  contents: read
+      - 'target/**'
+      - 'test/**'
+      - '.dockerignore'
+      - '.gitmodules'
+      - 'Dockerfile'
+      - 'setup.sh'
 
 jobs:
-  build-image-amd64:
-    name: "Build AMD64 Image"
-    uses: docker-mailserver/docker-mailserver/.github/workflows/generic_build.yml@master
+  build-and-test:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2.3.4
+        with:
+          submodules: recursive
 
-  run-tests:
-    name: "Test AMD64 Image"
-    needs: build-image-amd64
-    uses: docker-mailserver/docker-mailserver/.github/workflows/generic_test.yml@master
-    with:
-      cache-key: ${{ needs.build-image-amd64.outputs.build-cache-key }}
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1.2.0
 
-  job-build-arm:
-    name: "Build ARM64 Image"
-    # Dependency ensures the cache-key is only created for AMD64 builds.
-    # ARM64 will not be able to use this cache, building from scratch each time.
-    # Expect about 2 minutes extra build time until adopting `type=gha` with scopes for cache.
-    needs: build-image-amd64
-    uses: docker-mailserver/docker-mailserver/.github/workflows/generic_build.yml@master
-    with:
-      platforms: linux/arm64
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1.6.0
+        id: buildx
+
+      - name: Cache Docker layers
+        uses: actions/cache@v2.1.6
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
+
+      - name: Build images locally
+        uses: docker/build-push-action@v2.7.0
+        with:
+          builder: ${{ steps.buildx.outputs.name }}
+          context: .
+          file: ./Dockerfile
+          build-args: |
+            VCS_REF=${{ github.sha }}
+            VCS_VER=${{ github.ref }}
+          platforms: linux/amd64,linux/arm/v7,linux/arm64
+          tags: mailserver-testing:ci
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Build image for test suit
+        uses: docker/build-push-action@v2.7.0
+        with:
+          builder: ${{ steps.buildx.outputs.name }}
+          context: .
+          file: ./Dockerfile
+          build-args: |
+            VCS_REF=${{ github.sha }}
+            VCS_VER=${{ github.ref }}
+          platforms: linux/amd64
+          load: true
+          tags: mailserver-testing:ci
+          cache-from: type=local,src=/tmp/.buildx-cache
+
+      - name: Run test suite
+        run: >
+          NAME=mailserver-testing:ci
+          bash -c 'make generate-accounts tests'
+        env:
+          CI: true

.gitignore

@@ -2,22 +2,52 @@
 ###  General  ###################################
 #################################################
 
+.DS_Store
 .env
-compose.override.yaml
-docs/site/
-docker-data/
+config/opendkim/
 
 #################################################
 ###  IDEs  ######################################
 #################################################
 
-.idea/
-.vscode/
+.idea
+.vscode
+
+
+#################################################
+###  Linting Tools  #############################
+#################################################
+
+tools/
 
 #################################################
 ###  Tests  #####################################
 #################################################
 
-test/duplicate_configs/
-test/config/dovecot-masters.cf
+test/config/empty/
 test/config/postfix-accounts.cf
+test/config/letsencrypt/mail.my-domain.com/combined.pem
+test/config/dovecot-lmtp/userdb
+test/config/key*
+test/config/opendkim/keys/domain.tld/
+test/config/opendkim/keys/example.com/
+test/config/opendkim/keys/localdomain2.com/
+test/config/postfix-aliases.cf
+test/config/postfix-receive-access.cf
+test/config/postfix-receive-access.cfe
+test/config/postfix-send-access.cf
+test/config/postfix-send-access.cfe
+test/config/relay-hosts/chksum
+test/config/relay-hosts/postfix-aliases.cf
+test/config/without-virtual/
+test/config/with-domain/
+test/onedir
+test/duplicate_configs
+test/alias
+test/quota
+test/relay
+
+config.bak
+testconfig.bak
+
+docs/site

.gitmodules

@@ -3,7 +3,10 @@
 	url = https://github.com/bats-core/bats-core.git
 [submodule "test/test_helper/bats-support"]
 	path = test/test_helper/bats-support
-	url = https://github.com/bats-core/bats-support
+	url = https://github.com/ztombol/bats-support
 [submodule "test/test_helper/bats-assert"]
 	path = test/test_helper/bats-assert
-	url = https://github.com/bats-core/bats-assert
+	url = https://github.com/ztombol/bats-assert
+[submodule "target/docker-configomat"]
+	path = target/docker-configomat
+	url = https://github.com/alinmear/docker-configomat

CHANGELOG.md

@@ -1,896 +1,9 @@
 # Changelog
 
-All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased](https://github.com/docker-mailserver/docker-mailserver/compare/v15.0.2...HEAD)
-
-> **Note**: Changes and additions listed here are contained in the `:edge` image tag. These changes may not be as stable as released changes.
-
-### Updates
-
-- **Documentation:**
-  - Added a compatibility note for a Dovecot + Solr 9.8 breaking change ([#4433](https://github.com/docker-mailserver/docker-mailserver/pull/4433))
-- **Internal:**
-  - Refactored `setup config dkim` (`open-dkim`) ([#4375](https://github.com/docker-mailserver/docker-mailserver/pull/4375))
-
-## [v15.0.2](https://github.com/docker-mailserver/docker-mailserver/releases/tag/v15.0.2)
-
-### Fixes
-
-- **Postfix**
-  - Avoid modifying the message body when filtering sender headers. This regression was introduced from [#4120](https://github.com/docker-mailserver/docker-mailserver/pull/4120) as part of DMS v15.0.0 ([#4429](https://github.com/docker-mailserver/docker-mailserver/pull/4429))
-
-## [v15.0.1](https://github.com/docker-mailserver/docker-mailserver/releases/tag/v15.0.1)
-
-### Added
-
-- **Internal:**
-  - Added the Smallstep `step` CLI command for future internal usage ([#4376](https://github.com/docker-mailserver/docker-mailserver/pull/4376))
-
-### Fixes
-
-- **Postfix:**
-  - `setup email restrict` generated configs now only prepend to `dms_smtpd_sender_restrictions` ([#4379](https://github.com/docker-mailserver/docker-mailserver/pull/4379))
-- **Rspamd:**
-  - Change detection support now monitors all files found within the DMS _Config Volume_ Rspamd directory ([#4418](https://github.com/docker-mailserver/docker-mailserver/pull/4418))
-- **Internal:**
-  - A permissions fix for `/var/log/mail` that was [added in DMS v15]((https://github.com/docker-mailserver/docker-mailserver/pull/4374)) no longer encounters an error when no log files are present during a container restart, such as with a `tmpfs` volume mount ([#4391](https://github.com/docker-mailserver/docker-mailserver/pull/4391))
-  - The DMS _State Volume_ (`/var/mail-state`) will now ensure it's file tree is accessible for services when the volume was created with missing executable bit ([#4420](https://github.com/docker-mailserver/docker-mailserver/pull/4420))
-  - The DMS _Config Volume_ (`/tmp/docker-mailserver`) now correctly updates permissions on container restarts ([#4417](https://github.com/docker-mailserver/docker-mailserver/pull/4417))
-
-### Updates
-
-- **Internal:**
-  - Minor improvements to `_install_utils()` in `packages.sh` ([#4376](https://github.com/docker-mailserver/docker-mailserver/pull/4376))
-
-## [v15.0.0](https://github.com/docker-mailserver/docker-mailserver/releases/tag/v15.0.0)
-
-### Breaking
-
-- **saslauthd** mechanism support via ENV `SASLAUTHD_MECHANISMS` with `pam`, `shadow`, `mysql` values has been removed. Only `ldap` and `rimap` remain supported ([#4259](https://github.com/docker-mailserver/docker-mailserver/pull/4259))
-- **getmail6** has been refactored: ([#4156](https://github.com/docker-mailserver/docker-mailserver/pull/4156))
-  - The [DMS config volume](https://docker-mailserver.github.io/docker-mailserver/v15.0/config/advanced/optional-config/#volumes) now has support for `getmailrc_general.cf` for overriding [common default settings](https://docker-mailserver.github.io/docker-mailserver/v15.0/config/advanced/mail-getmail/#common-options). If you previously mounted this config file directly to `/etc/getmailrc_general` you should switch to our config volume support.
-  - Generated getmail configuration files no longer set the `message_log` option. Instead of individual log files per config, the [default base settings DMS configures](https://github.com/docker-mailserver/docker-mailserver/tree/v15.0.0/target/getmail/getmailrc_general) now enables `message_log_syslog`. This aligns with how other services in DMS log to syslog where it is captured in `mail.log`.
-  - Getmail configurations have changed location from the base of the DMS Config Volume, to the `getmail/` subdirectory. Any existing configurations **must be migrated manually.**
-  - **DMS v14 mistakenly** relocated the _getmail state directory_ to the _DMS Config Volume_ as a `getmail/` subdirectory.
-    - This has been corrected to `/var/lib/getmail` (_if you have mounted a DMS State Volume to `/var/mail-state`, `/var/lib/getmail` will be symlinked to `/var/mail-state/lib-getmail`_).
-    - To preserve this state when upgrading to DMS v15, **you must manually migrate `getmail/` from the _DMS Config Volume_ to `lib-getmail/` in the _DMS State Volume_.**
-  - `setup email delete <EMAIL ADDRESS>` now requires explicit confirmation if the mailbox data should be deleted ([#4365](https://github.com/docker-mailserver/docker-mailserver/pull/4365)).
-- **Rspamd:** Removed deprecated file path check (_DMS config volume: `./rspamd-modules.conf` => `./rspamd/custom-commands.conf`_) ([#4373](https://github.com/docker-mailserver/docker-mailserver/pull/4373))
-
-### Added
-
-- **Internal:**
-  - Add password confirmation to several `setup` CLI subcommands ([#4072](https://github.com/docker-mailserver/docker-mailserver/pull/4072))
-  - Added a `debug getmail` subcommand to `setup` ([#4346](https://github.com/docker-mailserver/docker-mailserver/pull/4346))
-
-### Updates
-
-- **Internal:**
-  - **Removed `VERSION` file** from the repo. Releases of DMS prior to v13 (Nov 2023) would check this to detect new releases ([#3677](https://github.com/docker-mailserver/docker-mailserver/issues/3677), [#4321](https://github.com/docker-mailserver/docker-mailserver/pull/4321))
-  - During image build, ensure a secure connection when downloading the `fail2ban` package ([#4080](https://github.com/docker-mailserver/docker-mailserver/pull/4080))
-- **Documentation:**
-  - Account Management and Authentication pages have been rewritten and better organized ([#4122](https://github.com/docker-mailserver/docker-mailserver/pull/4122))
-  - Add a caveat for `DMS_VMAIL_UID` not being compatible with `0` / root ([#4143](https://github.com/docker-mailserver/docker-mailserver/pull/4143))
-- **Getmail:** ([#4156](https://github.com/docker-mailserver/docker-mailserver/pull/4156))
-  - Added `getmail` as a new service for `supervisor` to manage, replacing cron for periodic polling.
-  - IMAP/POP3 example configs added to our [`config-examples`](https://github.com/docker-mailserver/docker-mailserver/tree/v15.0.0/config-examples/getmail).
-  - ENV [`GETMAIL_POLL`](https://docker-mailserver.github.io/docker-mailserver/v15.0/config/environment/#getmail_poll) now supports values above 30 minutes.
-- **Postfix:**
-  - By default opt-out from _Microsoft reactions_ for outbound mail ([#4120](https://github.com/docker-mailserver/docker-mailserver/pull/4120))
-- **Rspamd:**
-  - Updated GTube settings and tests ([#4191](https://github.com/docker-mailserver/docker-mailserver/pull/4191))
-- Updated externally installed software ([#4357](https://github.com/docker-mailserver/docker-mailserver/pull/4357)):
-  - `DOVECOT_COMMUNITY_REPO=1` custom image build ARG now supports the latest Dovecot [`2.4.x`](https://github.com/dovecot/core/releases/tag/2.4.0) (_DMS provides Dovecot `2.3.19` by default_)
-  - Dovecot FTS Xapian module (`1.7.12` => [`1.9.0`](https://github.com/grosjo/fts-xapian/releases/tag/1.9))
-  - `jaq` (`1.3.0` => [`2.1.0`](https://github.com/01mf02/jaq/releases/tag/v2.1.0))
-  - Fail2Ban (`1.0.2-2` => [`1.1.0`](https://github.com/fail2ban/fail2ban/releases/tag/1.1.0)) ([#4045](https://github.com/docker-mailserver/docker-mailserver/pull/4045))
-  - Rspamd (`3.8.4` => [`3.11.0`](https://github.com/rspamd/rspamd/releases/tag/3.11.0)) - Implicitly upgraded during image build, as the third-party repo lacks version pinning support.
-
-### Fixes
-
-- **Dovecot:**
-  - The logwatch `ignore.conf` now also excludes Xapian messages about pending documents ([#4060](https://github.com/docker-mailserver/docker-mailserver/pull/4060))
-  - `dovecot-fts-xapian` plugin was updated, fixing a regression with indexing ([#4095](https://github.com/docker-mailserver/docker-mailserver/pull/4095))
-  - The "dummy account" workaround for _Dovecot Quota_ feature support no longer treats the alias as a regex when checking the Dovecot UserDB ([#4222](https://github.com/docker-mailserver/docker-mailserver/pull/4222))
-- **LDAP:**
-  - Correctly apply a compatibility fix for OAuth2 introduced in DMS `v13.3.1` which had not been applied to the actual LDAP config changes ([#4175](https://github.com/docker-mailserver/docker-mailserver/pull/4175))
-- **Internal:**
-  - The main `mail.log` (_which is piped to stdout via `tail`_) now correctly begins from the first log line of the active container run. Previously some daemon logs and potential warnings/errors were omitted ([#4146](https://github.com/docker-mailserver/docker-mailserver/pull/4146))
-  - `start-mailserver.sh` removed unused `shopt -s inherit_errexit` ([#4161](https://github.com/docker-mailserver/docker-mailserver/pull/4161))
-  - Fixed a regression introduced in DMS v14 where `postfix-main.cf` appended `stderr` output into `/etc/postfix/main.cf`, causing Postfix startup to fail ([#4147](https://github.com/docker-mailserver/docker-mailserver/pull/4147))
-  - Fixed a regression introduced in DMS v14 to better support running `start-mailserver.sh` with container restarts, which now only skip calling `_setup()` ([#4323](https://github.com/docker-mailserver/docker-mailserver/pull/4323#issuecomment-2629559254), [#4374](https://github.com/docker-mailserver/docker-mailserver/pull/4374))
-  - The command `swaks --help` is now functional ([#4282](https://github.com/docker-mailserver/docker-mailserver/pull/4282))
-- **Rspamd:**
-  - DKIM private key path checking is now performed only on paths that do not contain `$` ([#4201](https://github.com/docker-mailserver/docker-mailserver/pull/4201))
-
-### CI
-
-- Removed `CONTRIBUTORS.md`, `.all-contributorsrc`, and workflow ([#4141](https://github.com/docker-mailserver/docker-mailserver/pull/4141))
-- Refactored the workflows to be more secure for generating documentation previews on PRs ([#4267](https://github.com/docker-mailserver/docker-mailserver/pull/4267), [#4264](https://github.com/docker-mailserver/docker-mailserver/pull/4264), [#4262](https://github.com/docker-mailserver/docker-mailserver/pull/4262), [#4247](https://github.com/docker-mailserver/docker-mailserver/pull/4247), [#4244](https://github.com/docker-mailserver/docker-mailserver/pull/4244))
-
-## [v14.0.0](https://github.com/docker-mailserver/docker-mailserver/releases/tag/v14.0.0)
-
-The most noteworthy change of this release is the update of the container's base image from Debian 11 ("Bullseye") to Debian 12 ("Bookworm"). This update alone involves breaking changes and requires a careful update!
-
-### Breaking
-
-- **Updated base image to Debian 12** ([#3403](https://github.com/docker-mailserver/docker-mailserver/pull/3403))
-  - Changed the default of `DOVECOT_COMMUNITY_REPO` to `0` (disabled) - the Dovecot community repo will (for now) not be the default when building the DMS.
-    - While Debian 12 (Bookworm) was released in June 2023 and the latest Dovecot `2.3.21` in Sep 2023, as of Jan 2024 there is no [Dovecot community repo available for Debian 12](https://repo.dovecot.org).
-    - This results in the Dovecot version being downgraded from `2.3.21` (DMS v13.3) to `2.3.19`, which [may affect functionality when you've explicitly configured for these features](https://github.com/dovecot/core/blob/30cde20f63650d8dcc4c7ad45418986f03159946/NEWS#L1-L158):
-      - OAuth2 (_mostly regarding JWT usage, or POST requests (`introspection_mode = post`) with `client_id` + `client_secret`_).
-      - Lua HTTP client (_DNS related_).
-  - Updated packages. For an overview, [we have a review comment on the PR that introduces Debian 12](https://github.com/docker-mailserver/docker-mailserver/pull/3403#issuecomment-1694563615)
-    - Notable major version bump: `openssl 3`, `clamav 1`, `spamassassin 4`, `redis-server 7`.
-    - Notable minor version bump: `postfix 3.5.23 => 3.7.9`
-    - Notable minor version bump + downgrade: `dovecot 2.3.13 => 2.3.19` (_Previous release provided `2.3.21` via community repo, `2.3.19` is now the default_)
-  - Updates to `packages.sh`:
-    - Removed custom installations of Fail2Ban, getmail6 and Rspamd
-    - Updated packages lists and added comments for maintainability
-- OpenDMARC upgrade: `v1.4.0` => `v1.4.2` ([#3841](https://github.com/docker-mailserver/docker-mailserver/pull/3841))
-  - Previous versions of OpenDMARC would place incoming mail from domains announcing `p=quarantaine` (_that fail the DMARC check_) into the [Postfix "hold" queue](https://www.postfix.org/QSHAPE_README.html#hold_queue) until administrative intervention.
-  - [OpenDMARC v1.4.2 has disabled that feature by default](https://github.com/trusteddomainproject/OpenDMARC/issues/105), but it can be enabled again by adding the setting `HoldQuarantinedMessages true` to [`/etc/opendmarc.conf`](https://github.com/docker-mailserver/docker-mailserver/blob/v13.3.1/target/opendmarc/opendmarc.conf) (_provided from DMS_).
-    - [Our `user-patches.sh` feature](https://docker-mailserver.github.io/docker-mailserver/latest/config/advanced/override-defaults/user-patches/) provides a convenient approach to updating that config file.
-    - Please let us know if you disagree with the upstream default being carried with DMS, or the value of providing alternative configuration support within DMS.
-- **Postfix:**
-  - Postfix upgrade from 3.5 to 3.7 ([#3403](https://github.com/docker-mailserver/docker-mailserver/pull/3403))
-    - `compatibility_level` was raised from `2` to `3.6`
-    - Postfix has deprecated the usage of `whitelist` / `blacklist` in config parameters and logging in favor of `allowlist` / `denylist` and similar variations. ([#3403](https://github.com/docker-mailserver/docker-mailserver/pull/3403/files#r1306356328))
-      - This [may affect monitoring / analysis of logs output from Postfix](https://www.postfix.org/COMPATIBILITY_README.html#respectful_logging) that expects to match patterns on the prior terminology used.
-      - DMS `main.cf` has renamed `postscreen_dnsbl_whitelist_threshold` to `postscreen_dnsbl_allowlist_threshold` as part of this change.
-    - `smtpd_relay_restrictions` (relay policy) is now evaluated after `smtpd_recipient_restrictions` (spam policy). Previously it was evaluated before `smtpd_recipient_restrictions`. Mail to be relayed via DMS must now pass through the spam policy first.
-    - The TLS fingerprint policy has changed the default from MD5 to SHA256 (_DMS does not modify this Postfix parameter, but may affect any user customizations that do_).
-- **Dovecot**
-  - The "Junk" mailbox (folder) is now referenced by it's [special-use flag `\Junk`](https://docker-mailserver.github.io/docker-mailserver/v13.3/examples/use-cases/imap-folders/) instead of an explicit mailbox. ([#3925](https://github.com/docker-mailserver/docker-mailserver/pull/3925))
-    - This provides compatibility for the Junk mailbox when it's folder name differs (_eg: Renamed to "Spam"_).
-    - Potential breakage if your deployment modifies our `spam_to_junk.sieve` sieve script (_which is created during container startup when ENV `MOVE_SPAM_TO_JUNK=1`_) that handles storing spam mail into a users "Junk" mailbox folder.
-  - **Removed support for Solr integration:** ([#4025](https://github.com/docker-mailserver/docker-mailserver/pull/4025))
-    - This was a community contributed feature for FTS (Full Text Search), the docs advise using an image that has not been maintained for over 2 years and lacks ARM64 support. Based on user engagement over the years this feature has very niche value to continue to support, thus is being removed.
-    - If you use Solr, support can be restored if you're willing to contribute docs for the feature that resolves the concerns raised
-- **Log:**
-  - The format of DMS specific logs (_from our scripts, not running services_) has been changed. The new format is `<RFC 3339 TIMESTAMP> <LOG LEVEL> <LOG EVENT SRC>: <MESSAGE>` ([#4035](https://github.com/docker-mailserver/docker-mailserver/pull/4035))
-- **rsyslog:**
-  - Debian 12 adjusted the `rsyslog` configuration for the default file template from `RSYSLOG_TraditionalFileFormat` to `RSYSLOG_FileFormat` (_upstream default since 2012_). This change may affect you if you have any monitoring / analysis of log output (_eg: `mail.log` / `docker logs`_).
-    - The two formats are roughly equivalent to [RFC 3164](https://www.rfc-editor.org/rfc/rfc3164)) and [RFC 5424](https://datatracker.ietf.org/doc/html/rfc5424#section-1) respectively.
-    - A notable difference is the change to [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html#appendix-A) timestamps (_a strict subset of ISO 8601_). The [previous non-standardized timestamp format was defined in RFC 3164](https://www.rfc-editor.org/rfc/rfc3164.html#section-4.1.2) as `Mmm dd hh:mm:ss`.
-    - To revert this change you can add `sedfile -i '1i module(load="builtin:omfile" template="RSYSLOG_TraditionalFileFormat")' /etc/rsyslog.conf` via [our `user-patches.sh` feature](https://docker-mailserver.github.io/docker-mailserver/v14.0/config/advanced/override-defaults/user-patches/).
-  - Rsyslog now creates fewer log files:
-    - The files `/var/log/mail/mail.{info,warn,err}` are no longer created. These files represented `/var/log/mail.log` filtered into separate priority levels. As `/var/log/mail.log` contains all mail related messages, these files (_and their rotated counterparts_) can be deleted safely.
-    - `/var/log/messages`, `/var/log/debug` and several other log files not relevant to DMS were configured by default by Debian previously. These are not part of the `/var/log/mail/` volume mount, so should not impact anyone.
-- **Features:**
-  - The relay host feature was refactored ([#3845](https://github.com/docker-mailserver/docker-mailserver/pull/3845))
-    - The only breaking change this should introduce is with the Change Detection service (`check-for-changes.sh`).
-    - When credentials are configured for relays, change events that trigger the relayhost logic now reapply the relevant Postfix settings:
-      - `smtp_sasl_auth_enable = yes` (_SASL auth to outbound MTA connections is enabled_)
-      - `smtp_sasl_security_options = noanonymous` (_credentials are mandatory for outbound mail delivery_)
-      - `smtp_tls_security_level = encrypt` (_the outbound MTA connection must always be secure due to credentials sent_)
-- **Environment Variables:**
-  - `SA_SPAM_SUBJECT` has been renamed into `SPAM_SUBJECT` to become anti-spam service agnostic. ([#3820](https://github.com/docker-mailserver/docker-mailserver/pull/3820))
-    - As this functionality is now handled in Dovecot via a Sieve script instead of the respective anti-spam service during Postfix processing, this feature will only apply to mail stored in Dovecot. If you have relied on this feature in a different context, it will no longer be available.
-    - Rspamd previously handled this functionality via the `rewrite_subject` action which as now been disabled by default in favor of the new approach with `SPAM_SUBJECT`.
-    - `SA_SPAM_SUBJECT` is now deprecated and will log a warning if used. The value is copied as a fallback to `SPAM_SUBJECT`.
-    - The default has changed to not prepend any prefix to the subject unless configured to do so. If you relied on the implicit prefix, you will now need to provide one explicitly.
-    - `undef` was previously supported as an opt-out with `SA_SPAM_SUBJECT`. This is no longer valid, the equivalent opt-out value is now an empty value (_or rather the omission of this ENV being configured_).
-    - The feature to include [`_SCORE_` tag](https://spamassassin.apache.org/full/4.0.x/doc/Mail_SpamAssassin_Conf.html#rewrite_header-subject-from-to-STRING) in your value to be replaced by the associated spam score is no longer available.
-- **Supervisord:**
-  - `supervisor-app.conf` renamed to `dms-services.conf` ([#3908](https://github.com/docker-mailserver/docker-mailserver/pull/3908))
-- **Rspamd:**
-  - The Redis history key has been changed in order to not incorporate the hostname of the container (which is desirable in Kubernetes environments) ([#3927](https://github.com/docker-mailserver/docker-mailserver/pull/3927))
-- **Account Management:**
-  - Addresses (accounts) are now normalized to lowercase automatically and a warning is logged in case uppercase letters are supplied ([#4033](https://github.com/docker-mailserver/docker-mailserver/pull/4033))
-
-### Added
-
-- **Documentation:**
-  - A guide for configuring a public server to relay inbound and outbound mail from DMS on a private server ([#3973](https://github.com/docker-mailserver/docker-mailserver/pull/3973))
-- **Environment Variables:**
-  - `LOGROTATE_COUNT` defines the number of files kept by logrotate ([#3907](https://github.com/docker-mailserver/docker-mailserver/pull/3907))
-    - The fail2ban log file is now also taken into account by `LOGROTATE_COUNT` and `LOGROTATE_INTERVAL` ([#3915](https://github.com/docker-mailserver/docker-mailserver/pull/3915), [#3919](https://github.com/docker-mailserver/docker-mailserver/pull/3919))
-
-- **Internal:**
-  - Regular container restarts are now better supported. Setup scripts that ran previously will now be skipped ([#3929](https://github.com/docker-mailserver/docker-mailserver/pull/3929))
-
-### Updates
-
-- **Environment Variables:**
-  - `ONE_DIR` has been removed (legacy ENV) ([#3840](https://github.com/docker-mailserver/docker-mailserver/pull/3840))
-    - It's only functionality remaining was to opt-out of run-time state consolidation with `ONE_DIR=0` (_when a volume was already mounted to `/var/mail-state`_).
-- **Internal:**
-  - Changed the Postgrey whitelist retrieved during build to  [source directly from Github](https://github.com/schweikert/postgrey/blob/master/postgrey_whitelist_clients) as the list is updated more frequently than the [author publishes at their website](https://postgrey.schweikert.ch) ([#3879](https://github.com/docker-mailserver/docker-mailserver/pull/3879))
-  - Enable spamassassin only, when amavis is enabled too. ([#3943](https://github.com/docker-mailserver/docker-mailserver/pull/3943))
-- **Tests:**
-  - Refactored helper methods for sending e-mails with specific `Message-ID` headers and the helpers for retrieving + filtering logs, which together help isolate logs relevant to specific mail when multiple mails have been processed within a single test. ([#3786](https://github.com/docker-mailserver/docker-mailserver/pull/3786))
-- **Rspamd:**
-  - The `rewrite_subject` action, is now disabled by default. It has been replaced with the new `SPAM_SUBJECT` environment variable, which implements the functionality via a Sieve script instead which is anti-spam service agnostic ([#3820](https://github.com/docker-mailserver/docker-mailserver/pull/3820))
-  - `RSPAMD_NEURAL` was added and is disabled by default. If switched on it will enable the experimental Rspamd "Neural network" module to add a layer of analysis to spam detection ([#3833](https://github.com/docker-mailserver/docker-mailserver/pull/3833))
-  - The symbol weights of SPF, DKIM and DMARC have been adjusted again. Fixes a bug and includes more appropriate combinations of symbols ([#3913](https://github.com/docker-mailserver/docker-mailserver/pull/3913), [#3923](https://github.com/docker-mailserver/docker-mailserver/pull/3923))
-- **Dovecot:**
-  - `logwatch` now filters out non-error logs related to the status of the `index-worker` process for FTS indexing. ([#4012](https://github.com/docker-mailserver/docker-mailserver/pull/4012))
-  - updated FTS Xapian from version 1.5.5 to 1.7.12
-
-### Fixes
-
-- DMS config:
-  - Files that are parsed line by line are now more robust to parse by detecting and fixing line-endings ([#3819](https://github.com/docker-mailserver/docker-mailserver/pull/3819))
-  - The override config `postfix-main.cf` now retains custom parameters intended for use with `postfix-master.cf` ([#3880](https://github.com/docker-mailserver/docker-mailserver/pull/3880))
-- Variables related to Rspamd are declared as `readonly`, which would cause warnings in the log when being re-declared; we now guard against this issue ([#3837](https://github.com/docker-mailserver/docker-mailserver/pull/3837))
-- Relay host feature refactored ([#3845](https://github.com/docker-mailserver/docker-mailserver/pull/3845))
-  - `DEFAULT_RELAY_HOST` ENV can now also use the `RELAY_USER` + `RELAY_PASSWORD` ENV for supplying credentials.
-  - `RELAY_HOST` ENV no longer enforces configuring outbound SMTP to require credentials. Like `DEFAULT_RELAY_HOST` it can now configure a relay where credentials are optional.
-  - Restarting DMS should not be required when configuring relay hosts without these ENV, but solely via `setup relay ...`, as change detection events now apply relevant Postfix setting changes for supporting credentials too.
-- Rspamd configuration: Add a missing comma in `local_networks` so that all internal IP addresses are actually considered as internal ([#3862](https://github.com/docker-mailserver/docker-mailserver/pull/3862))
-- Ensure correct SELinux security context labels for files and directories moved to the mail-state volume during setup ([#3890](https://github.com/docker-mailserver/docker-mailserver/pull/3890))
-- Use correct environment variable for fetchmail ([#3901](https://github.com/docker-mailserver/docker-mailserver/pull/3901))
-- When using `ENABLE_GETMAIL=1` the undocumented internal location `/var/lib/getmail/` usage has been removed. Only the config volume `/tmp/docker-mailserver/getmail/` location is supported when Getmail has not been configured to deliver mail to Dovecot as advised in the DMS docs ([#4018](https://github.com/docker-mailserver/docker-mailserver/pull/4018))
-- Dovecot dummy accounts (_virtual alias workaround for dovecot feature `ENABLE_QUOTAS=1`_) now correctly matches the home location of the user for that alias ([#3997](https://github.com/docker-mailserver/docker-mailserver/pull/3997))
-
-## [v13.3.1](https://github.com/docker-mailserver/docker-mailserver/releases/tag/v13.3.1)
-
-### Fixes
-
-- **Dovecot:**
-  - Restrict the auth mechanisms for PassDB configs we manage (oauth2, passwd-file, ldap) ([#3812](https://github.com/docker-mailserver/docker-mailserver/pull/3812))
-    - Prevents misleading auth failures from attempting to authenticate against a PassDB with incompatible auth mechanisms.
-    - When the new OAuth2 feature was enabled, it introduced false-positives with logged auth failures which triggered Fail2Ban to ban the IP.
-- **Rspamd:**
-  - Ensure correct ownership (`_rspamd:_rspamd`) for the Rspamd DKIM directory + files `/tmp/docker-mailserver/rspamd/dkim/` ([#3813](https://github.com/docker-mailserver/docker-mailserver/pull/3813))
-
-## [v13.3.0](https://github.com/docker-mailserver/docker-mailserver/releases/tag/v13.3.0)
-
-### Features
-
-- **Authentication with OIDC / OAuth 2.0** 🎉
-  - DMS now supports authentication via OAuth2 (_via `XOAUTH2` or `OAUTHBEARER` SASL mechanisms_) from capable services (_like Roundcube_).
-    - This does not replace the need for an `ACCOUNT_PROVISIONER` (`FILE` / `LDAP`), which is required for an account to receive or send mail.
-    - Successful authentication (_via Dovecot PassDB_) still requires an existing account (_lookup via Dovecot UserDB_).
-- **MTA-STS** (_Optional support for mandatory outgoing TLS encryption_)
-  - If enabled and the outbound recipient has an MTA-STS policy set, TLS is mandatory for delivering to that recipient.
-    - Enable via the ENV `ENABLE_MTA_STS=1`
-    - Supported by major email service providers like Gmail, Yahoo and Outlook.
-
-### Added
-
-- **Documentation:**
-  - An example for how to bind outbound SMTP connections to a specific network interface ([#3465](https://github.com/docker-mailserver/docker-mailserver/pull/3465))
-
-### Updates
-
-- **Tests:**
-  - Revised OAuth2 test ([#3795](https://github.com/docker-mailserver/docker-mailserver/pull/3795))
-  - Replace `wc -l` with `grep -c` ([#3752](https://github.com/docker-mailserver/docker-mailserver/pull/3752))
-  - Revised testing of service process management (supervisord) to be more robust ([#3780](https://github.com/docker-mailserver/docker-mailserver/pull/3780))
-  - Refactored mail sending ([#3747](https://github.com/docker-mailserver/docker-mailserver/pull/3747) & [#3772](https://github.com/docker-mailserver/docker-mailserver/pull/3772)):
-    - This change is a follow-up to [#3732](https://github.com/docker-mailserver/docker-mailserver/pull/3732) from DMS v13.2.
-    - `swaks` version is now the latest from Github releases instead of the Debian package.
-    - `_nc_wrapper`, `_send_mail` and related helpers expect the `.txt` filepath extension again.
-    - `sending.bash` helper methods were refactored to better integrate `swaks` and accommodate different usage contexts.
-    - `test/files/emails/existing/` files were removed similar to previous removal of SMTP auth files as they became redundant with `swaks`.
-- **Internal:**
-  - Postfix is now configured with `smtputf8_enable = no` in our default `main.cf` config (_instead of during container startup_). ([#3750](https://github.com/docker-mailserver/docker-mailserver/pull/3750))
-- **Rspamd:** ([#3726](https://github.com/docker-mailserver/docker-mailserver/pull/3726)):
-  - Symbol scores for SPF, DKIM & DMARC were updated to more closely align with [RFC7489](https://www.rfc-editor.org/rfc/rfc7489#page-24). Please note that complete alignment is undesirable as other symbols may be added as well, which changes the overall score calculation again, see [this issue](https://github.com/docker-mailserver/docker-mailserver/issues/3690#issuecomment-1866871996)
-- **Documentation:**
-  - Revised the SpamAssassin ENV docs to better communicate configuration and their relation to other ENV settings. ([#3756](https://github.com/docker-mailserver/docker-mailserver/pull/3756))
-  - Detailed how mail received is assigned a spam score by Rspamd and processed accordingly ([#3773](https://github.com/docker-mailserver/docker-mailserver/pull/3773))
-
-### Fixes
-
-- **Setup:**
-  - `setup` CLI - `setup dkim domain` now creates the keys files with the user owning the key directory ([#3783](https://github.com/docker-mailserver/docker-mailserver/pull/3783))
-- **Dovecot:**
-  - During container startup for Dovecot Sieve, `.sievec` source files compiled to `.svbin` now have their `mtime` adjusted post setup to ensure it is always older than the associated `.svbin` file. This avoids superfluous error logs for sieve scripts that don't actually need to be compiled again ([#3779](https://github.com/docker-mailserver/docker-mailserver/pull/3779))
-- **Internal:**
-  - `.gitattributes`: Always use LF line endings on checkout for files with shell script content ([#3755](https://github.com/docker-mailserver/docker-mailserver/pull/3755))
-  - Fix missing 'jaq' binary for ARM architecture ([#3766](https://github.com/docker-mailserver/docker-mailserver/pull/3766))
-
-## [v13.2.0](https://github.com/docker-mailserver/docker-mailserver/releases/tag/v13.2.0)
-
-### Security
-
-DMS is now secured against the [recently published spoofing attack "SMTP Smuggling"](https://www.postfix.org/smtp-smuggling.html) that affected Postfix ([#3727](https://github.com/docker-mailserver/docker-mailserver/pull/3727)):
-
-- Postfix upgraded from `3.5.18` to `3.5.23` which provides the [long-term fix with `smtpd_forbid_bare_newline = yes`](https://www.postfix.org/smtp-smuggling.html#long)
-- If you are unable to upgrade to this release of DMS, you may follow [these instructions](https://github.com/docker-mailserver/docker-mailserver/issues/3719#issuecomment-1870865118) for applying the [short-term workaround](https://www.postfix.org/smtp-smuggling.html#short).
-- This change should not cause compatibility concerns for legitimate mail clients, however if you use software like `netcat` to send mail to DMS (_like our test-suite previously did_) it may now be rejected (_especially with the the short-term workaround `smtpd_data_restrictions = reject_unauth_pipelining`_).
-- **NOTE:** This Postfix update also includes the new parameter [`smtpd_forbid_bare_newline_exclusions`](https://www.postfix.org/postconf.5.html#smtpd_forbid_bare_newline_exclusions) which defaults to `$mynetworks` for excluding trusted mail clients excluded from the restriction.
-  - With our default `PERMIT_DOCKER=none` this is not a concern.
-  - Presently the Docker daemon config has `user-proxy: true` enabled by default.
-    - On a host that can be reached by IPv6, this will route to a DMS IPv4 only container implicitly through the Docker network bridge gateway which rewrites the source address.
-    - If your `PERMIT_DOCKER` setting allows that gateway IP, then it is part of `$mynetworks` and this attack would not be prevented from such connections.
-    - If this affects your deployment, refer to [our IPv6 docs](https://docker-mailserver.github.io/docker-mailserver/v13.2/config/advanced/ipv6/) for advice on handling IPv6 correctly in Docker. Alternatively [use our `postfix-main.cf`](https://docker-mailserver.github.io/docker-mailserver/v13.2/config/advanced/override-defaults/postfix/) to set `smtpd_forbid_bare_newline_exclusions=` as empty.
-
-### Updates
-
-- The test suite now uses `swaks` instead of `nc`, which has multiple benefits ([#3732](https://github.com/docker-mailserver/docker-mailserver/pull/3732)):
-  - `swaks` handles pipelining correctly, hence we can now use `reject_unauth_pipelining` in Postfix's configuration.
-  - `swaks` provides better CLI options that make many files superflous.
-  - `swaks` can also replace `openssl s_client` and handles authentication on submission ports better.
-- **Postfix:**
-  - We now defer rejection from unauthorized pipelining until the SMTP `DATA` command via `smtpd_data_restrictions` (_i.e. at the end of the mail transfer transaction_) ([#3744](https://github.com/docker-mailserver/docker-mailserver/pull/3744))
-    - Prevously our configuration only handled this during the client and recipient restriction stages. Postfix will flag this activity when encountered, but the rejection now is handled at `DATA` where unauthorized pipelining would have been valid from this point.
-    - If you had the Amavis service enabled (default), this restriction was already in place. Otherwise the concerns expressed with `smtpd_data_restrictions = reject_unauth_pipelining` from the security section above apply. We have permitted trusted clients (_`$mynetworks` or authenticated_) to bypass this restriction.
-
-## [v13.1.0](https://github.com/docker-mailserver/docker-mailserver/releases/tag/v13.1.0)
-
-### Added
-
-- **Dovecot:**
-  - ENV `ENABLE_IMAP` ([#3703](https://github.com/docker-mailserver/docker-mailserver/pull/3703))
-- **Tests:**
-  - You can now use `make run-local-instance` to run a DMS image that was built locally to test changes ([#3663](https://github.com/docker-mailserver/docker-mailserver/pull/3663))
-- **Internal:**
-  - Log a warning when update-check is enabled, but no stable release image is used ([#3684](https://github.com/docker-mailserver/docker-mailserver/pull/3684))
-
-### Updates
-
-- **Documentation:**
-  - Debugging - Raise awareness in the troubleshooting page for a common misconfiguration when deviating from our advice by using a bare domain ([#3680](https://github.com/docker-mailserver/docker-mailserver/pull/3680))
-  - Debugging - Raise awareness of temporary downtime during certificate renewal that can cause a failure to deliver local mail ([#3718](https://github.com/docker-mailserver/docker-mailserver/pull/3718))
-- **Internal:**
-  - Postfix configures `virtual_mailbox_maps` and `virtual_transport` during startup instead of using defaults (configured for Dovecot) via our `main.cf` ([#3681](https://github.com/docker-mailserver/docker-mailserver/pull/3681))
-- **Rspamd:**
-  - Upgraded to version `3.7.5`. This was previously inconsistent between our AMD64 (`3.5`) and ARM64 (`3.4`) images ([#3686](https://github.com/docker-mailserver/docker-mailserver/pull/3686))
-
-### Fixed
-
-- **Internal:**
-  - The container startup welcome log message now references `DMS_RELEASE` ([#3676](https://github.com/docker-mailserver/docker-mailserver/pull/3676))
-  - `VERSION` was incremented for prior releases to be notified of the v13.0.1 patch release ([#3676](https://github.com/docker-mailserver/docker-mailserver/pull/3676))
-  - `VERSION` is no longer included in the image ([#3711](https://github.com/docker-mailserver/docker-mailserver/pull/3711))
-  - Update-check: fix 'read' exit status ([#3688](https://github.com/docker-mailserver/docker-mailserver/pull/3688))
-  - `ENABLE_QUOTAS=0` no longer tries to remove non-existent config ([#3715](https://github.com/docker-mailserver/docker-mailserver/pull/3715))
-  - The `postgrey` service now writes logs to the supervisor directory like all other services. Previously this was `/var/log/mail/mail.log` ([#3724](https://github.com/docker-mailserver/docker-mailserver/pull/3724))
-- **Rspamd:**
-  - Switch to official arm64 packages to avoid segfaults ([#3686](https://github.com/docker-mailserver/docker-mailserver/pull/3686))
-- **CI / Automation:**
-  - The lint workflow can now be manually triggered by maintainers ([#3714]https://github.com/docker-mailserver/docker-mailserver/pull/3714)
-
-## [v13.0.1](https://github.com/docker-mailserver/docker-mailserver/releases/tag/v13.0.1)
-
-This patch release fixes two bugs that Rspamd users encountered with the `v13.0.0` release. Big thanks to the those that helped to identify these issues! ❤️
-
-### Fixed
-
-- **Internal:**
-  - The update check service now queries the latest GH release for a version tag (_instead of from a `VERSION` file at the GH repo_). This should provide more reliable update notifications ([#3666](https://github.com/docker-mailserver/docker-mailserver/pull/3666))
-- **Rspamd:**
-  - The check for correct permission on the private key when signing e-mails with DKIM was flawed. The result was that a false warning was emitted ([#3669](https://github.com/docker-mailserver/docker-mailserver/pull/3669))
-  - When [`RSPAMD_CHECK_AUTHENTICATED=0`][docs::env-rspamd-check-auth], DKIM signing for outbound e-mail was disabled, which is undesirable ([#3669](https://github.com/docker-mailserver/docker-mailserver/pull/3669)). **Make sure to check the documentation of [`RSPAMD_CHECK_AUTHENTICATED`][docs::env-rspamd-check-auth]**!
-
-[docs::env-rspamd-check-auth]: https://docker-mailserver.github.io/docker-mailserver/v13.0/config/environment/#rspamd_check_authenticated
-
-## [v13.0.0](https://github.com/docker-mailserver/docker-mailserver/releases/tag/v13.0.0)
-
-### 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))
-- **Rspamd:**
-  - The deprecated path for the Rspamd custom commands file (`/tmp/docker-mailserver/rspamd-modules.conf`) now prevents successful startup. The correct path is `/tmp/docker-mailserver/rspamd/custom-commands.conf`.
-- **Dovecot:**
-  - Dovecot mail storage per account in `/var/mail` previously shared the same path for the accounts home directory ([#3335](https://github.com/docker-mailserver/docker-mailserver/pull/3335))
-    - The home directory now is a subdirectory `home/`. This change better supports sieve scripts.
-    - **NOTE:** The change has not yet been implemented for `ACCOUNT_PROVISIONER=LDAP`.
-- **Postfix:**
-  - `/etc/postfix/master.cf` has renamed the "smtps" service to "submissions" ([#3235](https://github.com/docker-mailserver/docker-mailserver/pull/3235))
-    - This is the modern `/etc/services` name for port 465, aligning with the similar "submission" port 587.
-    - If you have configured Proxy Protocol support with a reverse proxy via `postfix-master.cf` (_as [per our docs guide](https://docker-mailserver.github.io/docker-mailserver/v13.0/examples/tutorials/mailserver-behind-proxy/)_), you will want to update `smtps` to `submissions` there.
-  - Postfix now defaults to supporting DSNs (_[Delivery Status Notifications](https://github.com/docker-mailserver/docker-mailserver/pull/3572#issuecomment-1751880574)_) only for authenticated users (_via ports 465 + 587_). This is a security measure to reduce spammer abuse of your DMS instance as a backscatter source. ([#3572](https://github.com/docker-mailserver/docker-mailserver/pull/3572))
-    - If you need to modify this change, please let us know by opening an issue / discussion.
-    - You can [opt out (_enable DSNs_) via the `postfix-main.cf` override support](https://docker-mailserver.github.io/docker-mailserver/v12.1/config/advanced/override-defaults/postfix/) using the contents: `smtpd_discard_ehlo_keywords =`.
-    - Likewise for authenticated users, the submission(s) ports (465 + 587) are configured internally via `master.cf` to keep DSNs enabled (_since authentication protects from abuse_).
-
-      If necessary, DSNs for authenticated users can be disabled via the `postfix-master.cf` override with the following contents:
-
-      ```cf
-      submission/inet/smtpd_discard_ehlo_keywords=silent-discard,dsn
-      submissions/inet/smtpd_discard_ehlo_keywords=silent-discard,dsn
-      ```
-
-### Added
-
-- **Features:**
-  - `getmail` as an alternative to `fetchmail` ([#2803](https://github.com/docker-mailserver/docker-mailserver/pull/2803))
-  - `setup` CLI - `setup fail2ban` gained a new `status <JAIL>` subcommand ([#3455](https://github.com/docker-mailserver/docker-mailserver/pull/3455))
-- **Environment Variables:**
-  - `MARK_SPAM_AS_READ`. When set to `1`, marks incoming spam as "read" to avoid unwanted "new mail" notifications for junk mail ([#3489](https://github.com/docker-mailserver/docker-mailserver/pull/3489))
-  - `DMS_VMAIL_UID` and `DMS_VMAIL_GID` allow changing the default ID values (`5000:5000`) for the Dovecot vmail user and group ([#3550](https://github.com/docker-mailserver/docker-mailserver/pull/3550))
-  - `RSPAMD_CHECK_AUTHENTICATED` allows authenticated users to avoid additional security checks by Rspamd ([#3440](https://github.com/docker-mailserver/docker-mailserver/pull/3440))
-- **Documentation:**
-  - Use-case examples / tutorials:
-    - iOS mail push support ([#3513](https://github.com/docker-mailserver/docker-mailserver/pull/3513))
-    - Guide for setting up Dovecot Authentication via Lua ([#3579](https://github.com/docker-mailserver/docker-mailserver/pull/3579))
-    - Guide for integrating with the Crowdsec service ([#3651](https://github.com/docker-mailserver/docker-mailserver/pull/3651))
-  - Debugging page:
-    - New compatibility section ([#3404](https://github.com/docker-mailserver/docker-mailserver/pull/3404))
-    - Now advises how to (re)start DMS correctly ([#3654](https://github.com/docker-mailserver/docker-mailserver/pull/3654))
-  - Better communicate distinction between DMS FQDN and DMS mail accounts ([#3372](https://github.com/docker-mailserver/docker-mailserver/pull/3372))
-  - Traefik example now includes `passthrough=true` on implicit ports ([#3568](https://github.com/docker-mailserver/docker-mailserver/pull/3568))
-  - Rspamd docs have received a variety of revisions ([#3318](https://github.com/docker-mailserver/docker-mailserver/pull/3318), [#3325](https://github.com/docker-mailserver/docker-mailserver/pull/3325), [#3329](https://github.com/docker-mailserver/docker-mailserver/pull/3329))
-  - IPv6 config examples with content tabs ([#3436](https://github.com/docker-mailserver/docker-mailserver/pull/3436))
-  - Mention [internet.nl](https://internet.nl/test-mail/) as another testing service ([#3445](https://github.com/docker-mailserver/docker-mailserver/pull/3445))
-  - `setup alias add ...` CLI help message now includes an example for aliasing to multiple recipients ([#3600](https://github.com/docker-mailserver/docker-mailserver/pull/3600))
-  - `SPAMASSASSIN_SPAM_TO_INBOX=1`, now emits a debug log to raise awareness that `SA_KILL` will be ignored ([#3360](https://github.com/docker-mailserver/docker-mailserver/pull/3360))
-  - `CLAMAV_MESSAGE_SIZE_LIMIT` now logs a warning when the value exceeds what ClamAV is capable of supporting (4GiB max scan size [#3332](https://github.com/docker-mailserver/docker-mailserver/pull/3332), 2GiB max file size [#3341](https://github.com/docker-mailserver/docker-mailserver/pull/3341))
-  - Added note to caution against changing `mydestination` in Postfix's `main.cf` ([#3316](https://github.com/docker-mailserver/docker-mailserver/pull/3316))
-- **Internal:**
-  - Added a wrapper to update Postfix configuration safely ([#3484](https://github.com/docker-mailserver/docker-mailserver/pull/3484), [#3503](https://github.com/docker-mailserver/docker-mailserver/pull/3503))
-  - Add debug group to `packages.sh` ([#3578](https://github.com/docker-mailserver/docker-mailserver/pull/3578))
-- **Tests:**
-  - Additional linting check for BASH syntax ([#3369](https://github.com/docker-mailserver/docker-mailserver/pull/3369))
-
-### Updates
-
-- **Misc:**
-  - Changed `setup config dkim` default key size to `2048` (`open-dkim`) ([#3508](https://github.com/docker-mailserver/docker-mailserver/pull/3508))
-- **Postfix:**
-  - Dropped special bits from `maildrop/` and `public/` directory permissions ([#3625](https://github.com/docker-mailserver/docker-mailserver/pull/3625))
-- **Rspamd:**
-  - Adjusted learning of ham ([#3334](https://github.com/docker-mailserver/docker-mailserver/pull/3334))
-  - Adjusted `antivirus.conf` ([#3331](https://github.com/docker-mailserver/docker-mailserver/pull/3331))
-  - `logrotate` setup + Rspamd log path + tests log helper fallback path ([#3576](https://github.com/docker-mailserver/docker-mailserver/pull/3576))
-  - Setup during container startup is now more resilient ([#3578](https://github.com/docker-mailserver/docker-mailserver/pull/3578))
-  - Changed DKIM default config location ([#3597](https://github.com/docker-mailserver/docker-mailserver/pull/3597))
-  - Removed the symlink for the `override.d/` directory in favor of using `cp`, integrated into the changedetector service, added a `--force` option for the Rspamd DKIM management, and provided a dedicated helper script for common ENV variables ([#3599](https://github.com/docker-mailserver/docker-mailserver/pull/3599))
-  - Required permissions are now verified for DKIM private key files ([#3627](https://github.com/docker-mailserver/docker-mailserver/pull/3627))
-- **Documentation:**
-  - Documentation aligned to Compose v2 conventions, `docker-compose` command changed to `docker compose`, `docker-compose.yaml` to `compose.yaml` ([#3295](https://github.com/docker-mailserver/docker-mailserver/pull/3295))
-  - Restored missing edit button ([#3338](https://github.com/docker-mailserver/docker-mailserver/pull/3338))
-  - Complete rewrite of the IPv6 page ([#3244](https://github.com/docker-mailserver/docker-mailserver/pull/3244), [#3531](https://github.com/docker-mailserver/docker-mailserver/pull/3531))
-  - Complete rewrite of the "Update and Cleanup" maintenance page ([#3539](https://github.com/docker-mailserver/docker-mailserver/pull/3539), [#3583](https://github.com/docker-mailserver/docker-mailserver/pull/3583))
-  - Improved debugging page advice on working with logs ([#3626](https://github.com/docker-mailserver/docker-mailserver/pull/3626), [#3640](https://github.com/docker-mailserver/docker-mailserver/pull/3640))
-  - Clarified the default for ENV `FETCHMAIL_PARALLEL` ([#3603](https://github.com/docker-mailserver/docker-mailserver/pull/3603))
-  - Removed port 25 from FAQ entry for mail client ports supporting authenticated submission ([#3496](https://github.com/docker-mailserver/docker-mailserver/pull/3496))
-  - Updated home path in docs for Dovecot Sieve ([#3370](https://github.com/docker-mailserver/docker-mailserver/pull/3370), [#3650](https://github.com/docker-mailserver/docker-mailserver/pull/3650))
-  - Fixed path to `rspamd.log` ([#3585](https://github.com/docker-mailserver/docker-mailserver/pull/3585))
-  - "Optional Config" page now uses consistent lowercase convention for directory names ([#3629](https://github.com/docker-mailserver/docker-mailserver/pull/3629))
-  - `CONTRIBUTORS.md`: Removed redundant "All Contributors" section ([#3638](https://github.com/docker-mailserver/docker-mailserver/pull/3638))
-- **Internal:**
-  - LDAP config improvements (Removed implicit `ldap://` LDAP URI scheme fallback) ([#3522](https://github.com/docker-mailserver/docker-mailserver/pull/3522))
-  - Changed style conventions for internal scripts ([#3361](https://github.com/docker-mailserver/docker-mailserver/pull/3361), [#3364](https://github.com/docker-mailserver/docker-mailserver/pull/3364), [#3365](https://github.com/docker-mailserver/docker-mailserver/pull/3365), [#3366](https://github.com/docker-mailserver/docker-mailserver/pull/3366), [#3368](https://github.com/docker-mailserver/docker-mailserver/pull/3368), [#3464](https://github.com/docker-mailserver/docker-mailserver/pull/3464))
-- **CI / Automation:**
-  - `.gitattributes` now ensures files are committed with `eol=lf` ([#3527](https://github.com/docker-mailserver/docker-mailserver/pull/3527))
-  - Revised the GitHub issue bug report template ([#3317](https://github.com/docker-mailserver/docker-mailserver/pull/3317), [#3381](https://github.com/docker-mailserver/docker-mailserver/pull/3381), [#3435](https://github.com/docker-mailserver/docker-mailserver/pull/3435))
-  - Clarified that the issue tracker is not for personal support ([#3498](https://github.com/docker-mailserver/docker-mailserver/pull/3498), [#3502](https://github.com/docker-mailserver/docker-mailserver/pull/3502))
-  - Bumped versions of miscellaneous software (also shoutout to @dependabot) ([#3371](https://github.com/docker-mailserver/docker-mailserver/pull/3371), [#3584](https://github.com/docker-mailserver/docker-mailserver/pull/3584), [#3504](https://github.com/docker-mailserver/docker-mailserver/pull/3504), [#3516](https://github.com/docker-mailserver/docker-mailserver/pull/3516))
-- **Tests:**
-  - Refactored LDAP tests to current conventions ([#3483](https://github.com/docker-mailserver/docker-mailserver/pull/3483))
-  - Changed OpenLDAP image to `bitnami/openldap` ([#3494](https://github.com/docker-mailserver/docker-mailserver/pull/3494))
-  - Revised LDAP config + setup ([#3514](https://github.com/docker-mailserver/docker-mailserver/pull/3514))
-  - Added tests for the helper function `_add_to_or_update_postfix_main()` ([#3505](https://github.com/docker-mailserver/docker-mailserver/pull/3505))
-  - EditorConfig Checker lint now uses a mount path to `/check` instead of `/ci` ([#3655](https://github.com/docker-mailserver/docker-mailserver/pull/3655))
-
-### Fixed
-
-- **Security:**
-  - Fixed issue with concatenating `$dmarc_milter` and `$dkim_milter` in `main.cf` ([#3380](https://github.com/docker-mailserver/docker-mailserver/pull/3380))
-  - Fixed Rspamd DKIM signing for inbound emails ([#3439](https://github.com/docker-mailserver/docker-mailserver/pull/3439), [#3453](https://github.com/docker-mailserver/docker-mailserver/pull/3453))
-  - OpenDKIM key generation is no longer broken when Rspamd is also enabled ([#3535](https://github.com/docker-mailserver/docker-mailserver/pull/3535))
-- **Internal:**
-  - The "database" files (_for managing users and aliases_) now correctly filters within lookup query ([#3359](https://github.com/docker-mailserver/docker-mailserver/pull/3359))
-  - `_setup_spam_to_junk()` no longer registered when `SMTP_ONLY=1` ([#3385](https://github.com/docker-mailserver/docker-mailserver/pull/3385))
-  - Dovecot `fts_xapian` is now compiled from source to match the Dovecot package ABI ([#3373](https://github.com/docker-mailserver/docker-mailserver/pull/3373))
-- **CI:**
-  - Scheduled build now have the correct permissions to run successfully ([#3345](https://github.com/docker-mailserver/docker-mailserver/pull/3345))
-- **Documentation:**
-  - Miscellaneous spelling and wording improvements ([#3324](https://github.com/docker-mailserver/docker-mailserver/pull/3324), [#3330](https://github.com/docker-mailserver/docker-mailserver/pull/3330), [#3337](https://github.com/docker-mailserver/docker-mailserver/pull/3337), [#3339](https://github.com/docker-mailserver/docker-mailserver/pull/3339), [#3344](https://github.com/docker-mailserver/docker-mailserver/pull/3344), [#3367](https://github.com/docker-mailserver/docker-mailserver/pull/3367), [#3411](https://github.com/docker-mailserver/docker-mailserver/pull/3411), [#3443](https://github.com/docker-mailserver/docker-mailserver/pull/3443))
-- **Tests:**
-  - Run `pgrep` within the actual container ([#3553](https://github.com/docker-mailserver/docker-mailserver/pull/3553))
-  - `lmtp_ip.bats` improved partial failure output ([#3552](https://github.com/docker-mailserver/docker-mailserver/pull/3552))
-  - Improvements to LDIF test data ([#3506](https://github.com/docker-mailserver/docker-mailserver/pull/3506))
-  - Normalized for `.gitattributes` + improved `eclint` coverage ([#3566](https://github.com/docker-mailserver/docker-mailserver/pull/3566))
-  - Fixed ShellCheck linting for BATS tests ([#3347](https://github.com/docker-mailserver/docker-mailserver/pull/3347))
-
-## [v12.1.0](https://github.com/docker-mailserver/docker-mailserver/releases/tag/v12.1.0)
-
-### Added
-
-- Rspamd:
-  - note about Rspamd's web interface ([#3245](https://github.com/docker-mailserver/docker-mailserver/pull/3245))
-  - add greylisting option & code refactoring ([#3206](https://github.com/docker-mailserver/docker-mailserver/pull/3206))
-  - added `HFILTER_HOSTNAME_UNKNOWN` and make it configurable ([#3248](https://github.com/docker-mailserver/docker-mailserver/pull/3248))
-  - add option to re-enable `reject_unknown_client_hostname` after #3248 ([#3255](https://github.com/docker-mailserver/docker-mailserver/pull/3255))
-  - add DKIM helper script ([#3286](https://github.com/docker-mailserver/docker-mailserver/pull/3286))
-- make `policyd-spf` configurable ([#3246](https://github.com/docker-mailserver/docker-mailserver/pull/3246))
-- add 'log' command to set up for Fail2Ban ([#3299](https://github.com/docker-mailserver/docker-mailserver/pull/3299))
-- `setup` command now expects accounts and aliases to be mutually exclusive ([#3270](https://github.com/docker-mailserver/docker-mailserver/pull/3270))
-
-### Updated
-
-- update DKIM/DMARC/SPF docs ([#3231](https://github.com/docker-mailserver/docker-mailserver/pull/3231))
-- Fail2Ban:
-  - made config more aggressive ([#3243](https://github.com/docker-mailserver/docker-mailserver/pull/3243) & [#3288](https://github.com/docker-mailserver/docker-mailserver/pull/3288))
-  - update fail2ban config examples with current DMS default values ([#3258](https://github.com/docker-mailserver/docker-mailserver/pull/3258))
-  - make Fail2Ban log persistent ([#3269](https://github.com/docker-mailserver/docker-mailserver/pull/3269))
-  - update F2B docs & bind mount links ([#3293](https://github.com/docker-mailserver/docker-mailserver/pull/3293))
-- Rspamd:
-  - improve Rspamd docs ([#3257](https://github.com/docker-mailserver/docker-mailserver/pull/3257))
-  - script stabilization ([#3261](https://github.com/docker-mailserver/docker-mailserver/pull/3261) & [#3282](https://github.com/docker-mailserver/docker-mailserver/pull/3282))
-  - remove WIP warnings ([#3283](https://github.com/docker-mailserver/docker-mailserver/pull/3283))
-- improve shutdown function by making PANIC_STRATEGY obsolete ([#3265](https://github.com/docker-mailserver/docker-mailserver/pull/3265))
-- update `bug_report.yml` ([#3275](https://github.com/docker-mailserver/docker-mailserver/pull/3275))
-- simplify `bug_report.yml` ([#3276](https://github.com/docker-mailserver/docker-mailserver/pull/3276))
-- revised the contributor workflow ([#2227](https://github.com/docker-mailserver/docker-mailserver/pull/2227))
-
-### Changed
-
-- default registry changed from DockerHub (`docker.io`) to GHCR (`ghcr.io`) ([#3233](https://github.com/docker-mailserver/docker-mailserver/pull/3233))
-- consistent namings in docs ([#3242](https://github.com/docker-mailserver/docker-mailserver/pull/3242))
-- get all `policyd-spf` setup in one place ([#3263](https://github.com/docker-mailserver/docker-mailserver/pull/3263))
-- miscellaneous script improvements ([#3281](https://github.com/docker-mailserver/docker-mailserver/pull/3281))
-- update FAQ entries ([#3294](https://github.com/docker-mailserver/docker-mailserver/pull/3294))
-
-### Fixed
-
-- GitHub Actions docs update workflow ([#3241](https://github.com/docker-mailserver/docker-mailserver/pull/3241))
-- fix dovecot: ldap mail delivery works ([#3252](https://github.com/docker-mailserver/docker-mailserver/pull/3252))
-- shellcheck: do not check .git folder ([#3267](https://github.com/docker-mailserver/docker-mailserver/pull/3267))
-- add missing -E for extended regexes in `smtpd_sender_restrictions` ([#3272](https://github.com/docker-mailserver/docker-mailserver/pull/3272))
-- fix setting `SRS_EXCLUDE_DOMAINS` during startup ([#3271](https://github.com/docker-mailserver/docker-mailserver/pull/3271))
-- remove superfluous `EOF` in `dmarc_dkim_spf.sh` ([#3266](https://github.com/docker-mailserver/docker-mailserver/pull/3266))
-- apply fixes to helpers when using `set -eE` ([#3285](https://github.com/docker-mailserver/docker-mailserver/pull/3285))
-
-## [12.0.0](https://github.com/docker-mailserver/docker-mailserver/releases/tag/v12.0.0)
-
-Notable changes are:
-
-- Rspamd feature is promoted from preview status
-- Services no longer use `chroot`
-- Fail2Ban major version upgrade
-- ARMv7 platform is no longer suppoted
-- TLS 1.2 is the minimum supported protocol
-- SMTP authentication on port 25 disabled
-- The value of `smtpd_sender_restrictions` for Postfix has replaced the value ([#3127](https://github.com/docker-mailserver/docker-mailserver/pull/3127)):
-  - In `main.cf` with `$dms_smtpd_sender_restrictions`
-  - In `master.cf` inbound submissions ports 465 + 587 extend this inherited `smtpd` restriction with `$mua_sender_restrictions`
-
-### Added
-
-- **security**: Rspamd support:
-  - integration into scripts, provisioning of configuration & documentation ([#2902](https://github.com/docker-mailserver/docker-mailserver/pull/2902),[#3016](https://github.com/docker-mailserver/docker-mailserver/pull/3016),[#3039](https://github.com/docker-mailserver/docker-mailserver/pull/3039))
-  - easily adjust options & modules ([#3059](https://github.com/docker-mailserver/docker-mailserver/pull/3059))
-  - advanced documentation ([#3104](https://github.com/docker-mailserver/docker-mailserver/pull/3104))
-  - make disabling Redis possible ([#3132](https://github.com/docker-mailserver/docker-mailserver/pull/3132))
-  - persistence for Redis ([#3143](https://github.com/docker-mailserver/docker-mailserver/pull/3143))
-  - integrate into `MOVE_SPAM_TO_JUNK` ([#3159](https://github.com/docker-mailserver/docker-mailserver/pull/3159))
-  - make it possible to learn from user actions ([#3159](https://github.com/docker-mailserver/docker-mailserver/pull/3159))
-- heavily updated CI & tests:
-  - added functionality to send mail with a helper function ([#3026](https://github.com/docker-mailserver/docker-mailserver/pull/3026),[#3103](https://github.com/docker-mailserver/docker-mailserver/pull/3103),[#3105](https://github.com/docker-mailserver/docker-mailserver/pull/3105))
-  - add a dedicated page for tests with more information ([#3019](https://github.com/docker-mailserver/docker-mailserver/pull/3019))
-- add information to Logwatch's mailer so `Envelope From` is properly set ([#3081](https://github.com/docker-mailserver/docker-mailserver/pull/3081))
-- add vulnerability scanning workflow & security policy ([#3106](https://github.com/docker-mailserver/docker-mailserver/pull/3106))
-- Add tools (ping & dig) to the image ([2989](https://github.com/docker-mailserver/docker-mailserver/pull/2989))
-
-### Updates
-
-- Fail2Ban major version updated to v1.0.2 ([#2959](https://github.com/docker-mailserver/docker-mailserver/pull/2959))
-- heavily updated CI & tests:
-  - we now run more tests in parallel bringing down overall time to build and test AMD64 to 6 minutes ([#2938](https://github.com/docker-mailserver/docker-mailserver/pull/2938),[#3038](https://github.com/docker-mailserver/docker-mailserver/pull/3038),[#3018](https://github.com/docker-mailserver/docker-mailserver/pull/3018),[#3062](https://github.com/docker-mailserver/docker-mailserver/pull/3062))
-  - remove CI ENV & disable fail-fast strategy ([#3065](https://github.com/docker-mailserver/docker-mailserver/pull/3065))
-  - streamlined GH Actions runners ([#3025](https://github.com/docker-mailserver/docker-mailserver/pull/3025))
-  - updated BATS & helper + minor updates to BATS variables ([#2988](https://github.com/docker-mailserver/docker-mailserver/pull/2988))
-  - improved consistency and documentation for test helpers ([#3012](https://github.com/docker-mailserver/docker-mailserver/pull/3012))
-- improve the `clean` recipe (don't require `sudo` anymore) ([#3020](https://github.com/docker-mailserver/docker-mailserver/pull/3020))
-- improve Amavis setup routine ([#3079](https://github.com/docker-mailserver/docker-mailserver/pull/3079))
-- completely refactor README & parts of docs ([#3097](https://github.com/docker-mailserver/docker-mailserver/pull/3097))
-- TLS setup (self-signed) error message now includes `SS_CA_CERT` ([#3168](https://github.com/docker-mailserver/docker-mailserver/pull/3168))
-- Better default value for SA_KILL variable ([#3058](https://github.com/docker-mailserver/docker-mailserver/pull/3058))
-
-### Fixed
-
-- `restrict-access` avoid inserting duplicates ([#3067](https://github.com/docker-mailserver/docker-mailserver/pull/3067))
-- correct the casing for Mime vs. MIME ([#3040](https://github.com/docker-mailserver/docker-mailserver/pull/3040))
-- Dovecot:
-  - Quota plugin is now properly configured via `mail_plugins` at setup ([#2958](https://github.com/docker-mailserver/docker-mailserver/pull/2958))
-  - `quota-status` service (port 65265) now only binds to `127.0.0.1` ([#3057](https://github.com/docker-mailserver/docker-mailserver/pull/3057))
-- OpenDMARC - Change default policy to reject ([#2933](https://github.com/docker-mailserver/docker-mailserver/pull/2933))
-- Change Detection service - Use service `reload` instead of restarting process to minimize downtime ([#2947](https://github.com/docker-mailserver/docker-mailserver/pull/2947))
-- Slightly faster container startup via `postconf` workaround ([#2998](https://github.com/docker-mailserver/docker-mailserver/pull/2998))
-- Better group ownership to `/var/mail-state` + ClamAV in `Dockerfile` ([#3011](https://github.com/docker-mailserver/docker-mailserver/pull/3011))
-- Dropping Postfix `chroot` mode:
-  - Remove syslog socket created by Debian ([#3134](https://github.com/docker-mailserver/docker-mailserver/pull/3134))
-  - Supervisor proxy signals for `postfix start-fg` via PID ([#3118](https://github.com/docker-mailserver/docker-mailserver/pull/3118))
-- Fixed several typos ([#2990](https://github.com/docker-mailserver/docker-mailserver/pull/2990)) ([#2993](https://github.com/docker-mailserver/docker-mailserver/pull/2993))
-- SRS setup fixed ([#3158](https://github.com/docker-mailserver/docker-mailserver/pull/3158))
-- Postsrsd restart loop fixed ([#3160](https://github.com/docker-mailserver/docker-mailserver/pull/3160))
-- Order of DKIM/DMARC milters matters ([#3082](https://github.com/docker-mailserver/docker-mailserver/pull/3082))
-- Make logrotate state persistant ([#3077](https://github.com/docker-mailserver/docker-mailserver/pull/3077))
-
-### Changed
-
-- the Dovecot community repository is now the default ([#2901](https://github.com/docker-mailserver/docker-mailserver/pull/2901))
-- moved SASL authentication socket location ([#3131](https://github.com/docker-mailserver/docker-mailserver/pull/3131))
-- only add Amavis configuration to Postfix when enabled ([#3046](https://github.com/docker-mailserver/docker-mailserver/pull/3046))
-- improve bug report template ([#3080](https://github.com/docker-mailserver/docker-mailserver/pull/3080))
-- remove Postfix DNSBLs ([#3069](https://github.com/docker-mailserver/docker-mailserver/pull/3069))
-- bigger script updates:
-  - split `setup-stack.sh` ([#3115](https://github.com/docker-mailserver/docker-mailserver/pull/3115))
-  - housekeeping & cleanup setup ([#3121](https://github.com/docker-mailserver/docker-mailserver/pull/3121),[#3123](https://github.com/docker-mailserver/docker-mailserver/pull/3123))
-  - issue warning in case of improper restart ([#3129](https://github.com/docker-mailserver/docker-mailserver/pull/3129))
-  - remove PostSRSD wrapper ([#3128](https://github.com/docker-mailserver/docker-mailserver/pull/3128))
-  - miscellaneous small improvements ([#3144](https://github.com/docker-mailserver/docker-mailserver/pull/3144))
-- improve Postfix config for spoof protection ([#3127](https://github.com/docker-mailserver/docker-mailserver/pull/3127))
-- Change Detection service - Remove 10 sec start-up delay ([#3064](https://github.com/docker-mailserver/docker-mailserver/pull/3064))
-- Postfix:
-  - Stop using `chroot` + remove wrapper script ([#3033](https://github.com/docker-mailserver/docker-mailserver/pull/3033))
-  - SMTP Authentication via port 25 disabled ([#3006](https://github.com/docker-mailserver/docker-mailserver/pull/3006))
-- Fail2Ban - Added support packages + remove wrapper script ([#3032](https://github.com/docker-mailserver/docker-mailserver/pull/3032))
-- Replace path with variable in mail_state.sh ([#3153](https://github.com/docker-mailserver/docker-mailserver/pull/3153))
-
-### Removed
-
-- configomat (submodule) ([#3045](https://github.com/docker-mailserver/docker-mailserver/pull/3045))
-- Due to deprecation:
-  - ARMv7 image support ([#2943](https://github.com/docker-mailserver/docker-mailserver/pull/2943))
-  - TLS 1.2 is now the minimum supported protocol ([#2945](https://github.com/docker-mailserver/docker-mailserver/pull/2945))
-  - ENV `SASL_PASSWD` ([#2946](https://github.com/docker-mailserver/docker-mailserver/pull/2946))
-- Redundant:
-  - Makefile `backup` target ([#3000](https://github.com/docker-mailserver/docker-mailserver/pull/3000))
-  - ENV `ENABLE_POSTFIX_VIRTUAL_TRANSPORT` ([#3004](https://github.com/docker-mailserver/docker-mailserver/pull/3004))
-  - `gamin` package ([#3030](https://github.com/docker-mailserver/docker-mailserver/pull/3030))
-
-## [11.3.1](https://github.com/docker-mailserver/docker-mailserver/releases/tag/v11.3.1)
-
-### Fixed
-
-- **build**:  Fix dovecot-fts-xapian dependency, when using dovecot community repository ([#2937](https://github.com/docker-mailserver/docker-mailserver/pull/2937))
-
-## [11.3.0](https://github.com/docker-mailserver/docker-mailserver/releases/tag/v11.3.0)
-
-### Added
-
-- **scripts**: Fail2ban - Enable network bans ([#2818](https://github.com/docker-mailserver/docker-mailserver/pull/2818))
-- **ci**: run tests in parallel ([#2857](https://github.com/docker-mailserver/docker-mailserver/pull/2857))
-- **docs**: added note about Docker version to documentation ([#2799](https://github.com/docker-mailserver/docker-mailserver/pull/2799))
-
-### Changed
-
-- **configuration**: Run fetchmail not in verbose mode ([#2859](https://github.com/docker-mailserver/docker-mailserver/pull/2859))
-- **build**: cleaned up `Makefile` and its targets ([#2833](https://github.com/docker-mailserver/docker-mailserver/pull/2833))
-- **configuration**: adjust handling of DNSBL return codes ([#2890](https://github.com/docker-mailserver/docker-mailserver/pull/2890))
-
-### Updates
-
-- **ci**: change to new output format in GH actions ([#2892](https://github.com/docker-mailserver/docker-mailserver/pull/2892))
-- **build**: cleaned up Makefile ([#2833](https://github.com/docker-mailserver/docker-mailserver/pull/2833))
-- **tests**: miscellaneous enhancements ([#2815](https://github.com/docker-mailserver/docker-mailserver/pull/2815))
-
-### Fixed
-
-- **scripts**: `./setup.sh email list` did not display aliases correctly ([#2877](https://github.com/docker-mailserver/docker-mailserver/issues/2877))
-- **scripts**: Improve error handling, when parameters are missing ([#2854](https://github.com/docker-mailserver/docker-mailserver/pull/2854))
-- **scripts**: Fix unbound variable error ([#2849](https://github.com/docker-mailserver/docker-mailserver/pull/2849), [#2853](https://github.com/docker-mailserver/docker-mailserver/pull/2853))
-- **scripts**: Make fetchmail data persistent ([#2851](https://github.com/docker-mailserver/docker-mailserver/pull/2851))
-- **scripts**: Run `user-patches.sh` right before starting daemons ([#2817](https://github.com/docker-mailserver/docker-mailserver/pull/2817))
-- **scripts**: Run Amavis cron job only when Amavis is enabled ([#2831](https://github.com/docker-mailserver/docker-mailserver/pull/2831))
-- **config**: `opendmarc.conf` - Change the default OpenDMARC policy to reject ([#2933](https://github.com/docker-mailserver/docker-mailserver/pull/2933))
-
-### Deprecation Notice
-
-- **Removing TLS 1.0 and TLS 1.1 ciphersuites from `TLS_LEVEL=intermediate`**
-  You should not realistically need support for TLS 1.0 or TLS 1.1, except in niche scenarios such as an old printer/scanner device that refuses to negotiate a compatible non-vulnerable cipher. [More details covered here](https://github.com/docker-mailserver/docker-mailserver/issues/2679).
-- **`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](https://github.com/docker-mailserver/docker-mailserver/pull/2605).
-- **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 of the older generations of Raspberry Pi. ARM64 is the modern target for ARM devices.
-
-  If you require ARMv7 support, [please let us know](https://github.com/docker-mailserver/docker-mailserver/issues/2642).
-
-## [11.2.0](https://github.com/docker-mailserver/docker-mailserver/releases/tag/v11.2.0)
-
-### Summary
-
-This release features a lot of small and medium-sized changes, many related to how the image is build and tested during CI. The build now multi-stage based and requires Docker Buildkit, as the ClamAV Signatures are added via `COPY --link ...` during build-time.
-
-### Deprecated
-
-- The environment variable `ENABLE_LDAP` is deprecated and will be removed in [13.0.0]. Use `ACCOUNT_PROVISIONER=LDAP` now.
-
-### Added
-
-- **documentation**: improve cron tasks documentation and fix link in documentation
-- **documentation**: added link to brakkee.org for setup of docker-mailserver on Kubernetes
-- **CI**: better build caching for CI
-- **CI**: improve GitHub Action CI with re-usable workflows
-- **tests**: ensure excessive FD limits are avoided
-- **configuration**: added `reject_unknown_client_hostname` to main.cf
-
-### Changed
-
-- **documentation**: update and improve K8s documentation
-- **scripts**: set configomat output to loglevel debug
-- **scripts**: refactor CLI commands for database management
-- **scripts**: simplify Fail2Ban output
-- **tests**: update submodules for BATS
-- **scripts**: rework environment variables setup
-- **scripts**: revised linting script
-- **scripts**: `addmailuser` - remove delaying completion until `/var/mail` is ready
-- **configuration**: remove unnecessary postconf switch '-e' and use single quotes where possible
-- **build**: streamline COPY statements in Dockerfile
-- **scripts**: improve `helpers/log.sh`
-- **build**: adjust build arguments
-- **build**: enhance build process
-
-### Removed
-
-- **configuration**: remove unnecessary configuration files
-
-### Fixed
-
-- **documentation**: update documentation to fix regression causing broken links
-- **scripts**: `_create_accounts()` should run after waiting
-- **scripts**: only calculate checksums, when there are files to monitor.
-- **tests**: wait at least 30 seconds before checking the health state of the container
-- **CI**: add `outputs` to `workflow_call` on `generic_build`
-
-### Security
-
-There are no security-related changes in this release.
-
----
-
-> **Note**: This part of the changelog was created before switching to the "Keep a Changelog"-format.
-
-## `v11.1.0`
-
-In this release the relay-host support saw [significant internal refactoring](https://github.com/docker-mailserver/docker-mailserver/pull/2604) in preparation for a future breaking change. Similar extensive restructuring through the codebase also occurred, where [each PR provides more details](https://github.com/docker-mailserver/docker-mailserver/milestone/17?closed=1). 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
-
-- There is now support for [Dovecot-Master accounts](https://docker-mailserver.github.io/docker-mailserver/v11.1/config/advanced/dovecot-master-accounts/) that provide admin access to all mail accounts ([#2535](https://github.com/docker-mailserver/docker-mailserver/pull/2535))
-
-### Fixes
-
-- Using Port 465 to authenticate with a relay-host no longer breaks the Amavis transport for Postfix ([#2607](https://github.com/docker-mailserver/docker-mailserver/pull/2607))
-- When mounting `/var/mail-state`, disabled services will no longer copy over data redundantly ([#2608](https://github.com/docker-mailserver/docker-mailserver/pull/2608))
-- Amavis is now aware of new domains detected during Change Detection, no longer skipping virus and spam filtering ([#2616](https://github.com/docker-mailserver/docker-mailserver/pull/2616))
-- `setup.sh -c <container name>` no longer ignores `<container name>` when more than 1 `docker-mailserver` container is running ([#2622](https://github.com/docker-mailserver/docker-mailserver/pull/2622))
-
-### Improvements
-
-- The Change Detector service will now only process relevant changes ([#2615](https://github.com/docker-mailserver/docker-mailserver/pull/2615)), in addition to now monitoring `postfix-sasl-password.cf`, `postfix-relaymap.cf`, and `postfix-regexp.cf` ([#2623](https://github.com/docker-mailserver/docker-mailserver/pull/2623))
-- For LDAP users that only need to support a single mail domain, `setup config dkim` should now detect the domain implicitly ([#2620](https://github.com/docker-mailserver/docker-mailserver/pull/2620))
-- The container capability `SYS_PTRACE` is no longer necessary ([#2624](https://github.com/docker-mailserver/docker-mailserver/pull/2624))
-- Added an example for configuring a basic container `healthcheck` command ([#2625](https://github.com/docker-mailserver/docker-mailserver/pull/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](https://github.com/docker-mailserver/docker-mailserver/pull/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](https://github.com/docker-mailserver/docker-mailserver/pull/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](https://github.com/docker-mailserver/docker-mailserver/pull/2605).
-- **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](https://github.com/docker-mailserver/docker-mailserver/issues/2642).
-
-## `v11.0.0`
-
-### Major Changes
-
-1. [**Internal logging has been refactored**](https://github.com/docker-mailserver/docker-mailserver/pull/2493). The environment variable `DMS_DEBUG` has been replaced by [`LOG_LEVEL`](https://docker-mailserver.github.io/docker-mailserver/v11.0/config/environment/#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`**](https://github.com/docker-mailserver/docker-mailserver/pull/2505). 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`](https://docker-mailserver.github.io/docker-mailserver/v11.0/config/environment/#permit_docker) has a new default value of `none`**. This change [better secures Podman](https://github.com/docker-mailserver/docker-mailserver/pull/2424); 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`](https://docker-mailserver.github.io/docker-mailserver/v11.0/config/environment/#clamav_message_size_limit)
-    2. [`TZ`](https://docker-mailserver.github.io/docker-mailserver/v11.0/config/environment/#tz)
-3. SpamAssassin KAM was added with [`ENABLE_SPAMASSASSIN_KAM`](https://docker-mailserver.github.io/docker-mailserver/v11.0/config/environment/#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](https://github.com/docker-mailserver/docker-mailserver/pull/2428) and [#2487](https://github.com/docker-mailserver/docker-mailserver/pull/2487).
-
-### Merged Pull Requests
-
-- **[improvement]** tests: remove legacy functions / tests [#2434](https://github.com/docker-mailserver/docker-mailserver/pull/2434)
-- **[improvement]** `PERMIT_DOCKER=none` as new default value [#2424](https://github.com/docker-mailserver/docker-mailserver/pull/2424)
-- **[improvement]** Adjust environment variables to more sensible defaults [#2428](https://github.com/docker-mailserver/docker-mailserver/pull/2428)
-- **[fix]** macOS linting support [#2448](https://github.com/docker-mailserver/docker-mailserver/pull/2448)
-- **[improvement]** Rename config examples directory [#2438](https://github.com/docker-mailserver/docker-mailserver/pull/2438)
-- **[docs]** FAQ - Update naked/bare domain section [#2446](https://github.com/docker-mailserver/docker-mailserver/pull/2446)
-- **[improvement]** Remove obsolete `setup.sh debug inspect` command from usage description [#2454](https://github.com/docker-mailserver/docker-mailserver/pull/2454)
-- **[feature]** Introduce `CLAMAV_MESSAGE_SIZE_LIMIT` env [#2453](https://github.com/docker-mailserver/docker-mailserver/pull/2453)
-- **[fix]** remove SA reload for KAM [#2456](https://github.com/docker-mailserver/docker-mailserver/pull/2456)
-- **[docs]** Enhance logrotate description [#2469](https://github.com/docker-mailserver/docker-mailserver/pull/2469)
-- **[improvement]** Remove macOS specific code / support + shellcheck should avoid python, regardless of permissions [#2466](https://github.com/docker-mailserver/docker-mailserver/pull/2466)
-- **[docs]** Update fail2ban.md [#2484](https://github.com/docker-mailserver/docker-mailserver/pull/2484)
-- **[fix]** Makefile: Remove backup/restore of obsolete config directory [#2479](https://github.com/docker-mailserver/docker-mailserver/pull/2479)
-- **[improvement]** scripts: small refactorings [#2485](https://github.com/docker-mailserver/docker-mailserver/pull/2485)
-- **[fix]** Building on Ubuntu 21.10 failing to install postfix [#2468](https://github.com/docker-mailserver/docker-mailserver/pull/2468)
-- **[improvement]** Use FQDN as `REPORT_SENDER` default value [#2487](https://github.com/docker-mailserver/docker-mailserver/pull/2487)
-- **[improvement]** Improve test, get rid of sleep [#2492](https://github.com/docker-mailserver/docker-mailserver/pull/2492)
-- **[feature]** scripts: new log [#2493](https://github.com/docker-mailserver/docker-mailserver/pull/2493)
-- **[fix]** Restart supervisord early [#2494](https://github.com/docker-mailserver/docker-mailserver/pull/2494)
-- **[improvement]** scripts: renamed function `_errex` -> `_exit_with_error` [#2497](https://github.com/docker-mailserver/docker-mailserver/pull/2497)
-- **[improvement]** Remove invalid URL from SPF message [#2503](https://github.com/docker-mailserver/docker-mailserver/pull/2503)
-- **[improvement]** scripts: refactored scripts located under `target/bin/` [#2500](https://github.com/docker-mailserver/docker-mailserver/pull/2500)
-- **[improvement]** scripts: refactoring & miscellaneous small changes [#2499](https://github.com/docker-mailserver/docker-mailserver/pull/2499)
-- **[improvement]** scripts: refactored `daemon-stack.sh` [#2496](https://github.com/docker-mailserver/docker-mailserver/pull/2496)
-- **[fix]** add compatibility for Bash 4 to setup.sh [#2519](https://github.com/docker-mailserver/docker-mailserver/pull/2519)
-- **[fix]** tests: disabled "quota exceeded" test [#2511](https://github.com/docker-mailserver/docker-mailserver/pull/2511)
-- **[fix]** typo in setup-stack.sh [#2521](https://github.com/docker-mailserver/docker-mailserver/pull/2521)
-- **[improvement]** scripts: introduce `_log` to `sedfile` [#2507](https://github.com/docker-mailserver/docker-mailserver/pull/2507)
-- **[feature]** create `.github/FUNDING.yml` [#2512](https://github.com/docker-mailserver/docker-mailserver/pull/2512)
-- **[improvement]** scripts: refactored `check-for-changes.sh` [#2498](https://github.com/docker-mailserver/docker-mailserver/pull/2498)
-- **[improvement]** scripts: remove `DMS_DEBUG` [#2523](https://github.com/docker-mailserver/docker-mailserver/pull/2523)
-- **[feature]** firewall: replace `iptables` with `nftables` [#2505](https://github.com/docker-mailserver/docker-mailserver/pull/2505)
-- **[improvement]** log: adjust level and message(s) slightly for four messages [#2532](https://github.com/docker-mailserver/docker-mailserver/pull/2532)
-- **[improvement]** log: introduce proper log level fallback and env getter function [#2506](https://github.com/docker-mailserver/docker-mailserver/pull/2506)
-- **[feature]** scripts: added `TZ` environment variable to set timezone [#2530](https://github.com/docker-mailserver/docker-mailserver/pull/2530)
-- **[improvement]** setup: added grace period for account creation [#2531](https://github.com/docker-mailserver/docker-mailserver/pull/2531)
-- **[improvement]** refactor: letsencrypt implicit location discovery [#2525](https://github.com/docker-mailserver/docker-mailserver/pull/2525)
-- **[improvement]** setup.sh/setup: show usage when no argument is given [#2540](https://github.com/docker-mailserver/docker-mailserver/pull/2540)
-- **[improvement]** Dockerfile: Remove not needed ENVs and add comment [#2541](https://github.com/docker-mailserver/docker-mailserver/pull/2541)
-- **[improvement]** chore: (setup-stack.sh) Fix a small typo [#2552](https://github.com/docker-mailserver/docker-mailserver/pull/2552)
-- **[feature]** Add ban feature to fail2ban script [#2538](https://github.com/docker-mailserver/docker-mailserver/pull/2538)
-- **[fix]** Fix changedetector restart loop [#2548](https://github.com/docker-mailserver/docker-mailserver/pull/2548)
-- **[improvement]** chore: Drop `setup.sh` DATABASE fallback ENV [#2556](https://github.com/docker-mailserver/docker-mailserver/pull/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](https://github.com/docker-mailserver/docker-mailserver/pull/2341)).
-2. A resource leak in `check-for-changes.sh` was fixed ([#2401](https://github.com/docker-mailserver/docker-mailserver/pull/2401))
-
-### Other Minor Changes
-
-1. `SPAMASSASSIN_SPAM_TO_INBOX`'s default changed to `1`. ([#2361](https://github.com/docker-mailserver/docker-mailserver/pull/2361))
-2. Changedetector functionality was added to `SSL_TYPE=manual`-setups. ([#2404](https://github.com/docker-mailserver/docker-mailserver/pull/2404))
-3. Four new environment variables were introduced: `LOGWATCH_SENDER`, `ENABLE_DNSBL`, `DOVECOT_INET_PROTOCOLS` and `ENABLE_SPAMASSASSIN_KAM`. ([#2362](https://github.com/docker-mailserver/docker-mailserver/pull/2362), [#2342](https://github.com/docker-mailserver/docker-mailserver/pull/2342), [#2358](https://github.com/docker-mailserver/docker-mailserver/pull/2358), [#2418](https://github.com/docker-mailserver/docker-mailserver/pull/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](https://github.com/docker-mailserver/docker-mailserver/pull/2341)
-- **[fix]** Prevent race condition on supervisorctl reload in [#2343](https://github.com/docker-mailserver/docker-mailserver/pull/2343)
-- **[docs]** Update links to dovecot docs in [#2351](https://github.com/docker-mailserver/docker-mailserver/pull/2351)
-- **[fix]** tests(fix): Align with upstream `testssl` field name change in [#2353](https://github.com/docker-mailserver/docker-mailserver/pull/2353)
-- **[improvement]** Make TLS tests more reliable in [#2354](https://github.com/docker-mailserver/docker-mailserver/pull/2354)
-- **[feature]** Introduce ENABLE_DNSBL env in [#2342](https://github.com/docker-mailserver/docker-mailserver/pull/2342)
-- **[feature]** Introduce DOVECOT_INET_PROTOCOLS env in [#2358](https://github.com/docker-mailserver/docker-mailserver/pull/2358)
-- **[fix]** Fix harmless startup errors in [#2357](https://github.com/docker-mailserver/docker-mailserver/pull/2357)
-- **[improvement]** Add tests for sedfile wrapper in [#2363](https://github.com/docker-mailserver/docker-mailserver/pull/2363)
-- **[feature]** add env var `LOGWATCH_SENDER` in [#2362](https://github.com/docker-mailserver/docker-mailserver/pull/2362)
-- **[fix]** Fixed non-number-argument in `listmailuser` in [#2382](https://github.com/docker-mailserver/docker-mailserver/pull/2382)
-- **[fix]** docs: Fail2Ban - Fix links for rootless podman in [#2384](https://github.com/docker-mailserver/docker-mailserver/pull/2384)
-- **[fix]** docs(kubernetes): fix image name in example in [#2385](https://github.com/docker-mailserver/docker-mailserver/pull/2385)
-- **[fix]** SSL documentation contains a small bug #2381 [#2383](https://github.com/docker-mailserver/docker-mailserver/pull/2383)
-- **[fix]** get rid of subshell + `exec` in `helper-functions.sh` in [#2401](https://github.com/docker-mailserver/docker-mailserver/pull/2401)
-- **[docs]** Rootless Podman security update [#2393](https://github.com/docker-mailserver/docker-mailserver/pull/2393)
-- **[fix]** fix: double occurrence of `/etc/postfix/regexp` in [#2397](https://github.com/docker-mailserver/docker-mailserver/pull/2397)
-- **[improvement]** consistently make 1 the default value for `SPAMASSASSIN_SPAM_TO_INBOX` in [#2361](https://github.com/docker-mailserver/docker-mailserver/pull/2361)
-- **[docs]** added sieve example for subaddress sorting in [#2410](https://github.com/docker-mailserver/docker-mailserver/pull/2410)
-- **[feature]** Add changedetector functionality for `${SSL_TYPE} == manual` in [#2404](https://github.com/docker-mailserver/docker-mailserver/pull/2404)
-- **[docs]** docs(deps): bump mkdocs-material to v8.2.1 in [#2422](https://github.com/docker-mailserver/docker-mailserver/pull/2422)
-- **[feature]** Add SpamAssassin KAM in [#2418](https://github.com/docker-mailserver/docker-mailserver/pull/2418)
-- **[improvement]** refactoring: split helper functions into smaller scripts in [#2420](https://github.com/docker-mailserver/docker-mailserver/pull/2420)
-- **[fix]** fix: do not add accounts that already exists to account files in [#2419](https://github.com/docker-mailserver/docker-mailserver/pull/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](https://github.com/docker-mailserver/docker-mailserver/pull/2326)
-- **[improvement]** Base image upgraded from Debian 10 Buster to Debian 11 Bullseye [#2116](https://github.com/docker-mailserver/docker-mailserver/pull/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](https://github.com/docker-mailserver/docker-mailserver/pull/2116#issuecomment-955615529)_).
-  - `yescrypt` is now supported upstream as a password hash algorithm, `docker-mailserver` continues to use `SHA512-CRYPT` (_[more information](https://github.com/docker-mailserver/docker-mailserver/pull/2116#issuecomment-955800544)_).
-- **[chore]** Dovecot statistics service disabled [#2292](https://github.com/docker-mailserver/docker-mailserver/pull/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](https://github.com/docker-mailserver/docker-mailserver/pull/2248)
-  - **NOTE:** If using aliases that map to another alias or multiple addresses, _this remains a risk_.
+    - **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](https://github.com/docker-mailserver/docker-mailserver/pull/2264)
 - **[fix]** `SSL_DOMAIN` ENV should now work much more reliably [#2274](https://github.com/docker-mailserver/docker-mailserver/pull/2274), [#2278](https://github.com/docker-mailserver/docker-mailserver/pull/2278), [#2279](https://github.com/docker-mailserver/docker-mailserver/pull/2279)
 - **[fix]** DKIM - Removed `refile:` (_regex type_) from KeyTable entry in `opendkim.conf`, fixes validation error output from `opendkim-testkey` [#2249](https://github.com/docker-mailserver/docker-mailserver/pull/2249)
@@ -909,6 +22,7 @@ These changes are primarily internal and are only likely relevant to users that
 - **[refactor]** As part of the Traefik `acme.json` and `SSL_DOMAIN` work, logic for `SSL_TYPE=letsencrypt` was also revised [#2278](https://github.com/docker-mailserver/docker-mailserver/pull/2278)
 - **[improvement]** Some minor tweaks to how we derive the internal `HOSTNAME` and `DOMAINNAME` from user configured `hostname` and `domainname` settings [#2280](https://github.com/docker-mailserver/docker-mailserver/pull/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>`.
@@ -964,15 +78,18 @@ This release mainly improves on `v10.1.0` with small bugfixes/improvements and d
 - **[dependency]** Update various dependencies through docs and base image
 - **[security]** This release contains also [security fixes for OpenSSL](https://www.openssl.org/news/secadv/20210824.txt)
 
+
 ## `v10.1.0`
 
-This release mainly improves on `v10.0.0` with many bugfixes.
+This release mainly improves on `v10.0.0` with many bugfixes. 
 
 - **[docs]** Various documentation updates ([#2105](https://github.com/docker-mailserver/docker-mailserver/pull/2105), [#2045](https://github.com/docker-mailserver/docker-mailserver/pull/2045), [#2043](https://github.com/docker-mailserver/docker-mailserver/pull/2043), [#2035](https://github.com/docker-mailserver/docker-mailserver/pull/2035), [#2001](https://github.com/docker-mailserver/docker-mailserver/pull/2001))
 - **[misc]** Fixed a lot of small bugs, updated dependencies and improved functionality ([#2095](https://github.com/docker-mailserver/docker-mailserver/pull/2095), [#2047](https://github.com/docker-mailserver/docker-mailserver/pull/2047), [#2046](https://github.com/docker-mailserver/docker-mailserver/pull/2046), [#2041](https://github.com/docker-mailserver/docker-mailserver/pull/2041), [#1980](https://github.com/docker-mailserver/docker-mailserver/pull/1980), [#2030](https://github.com/docker-mailserver/docker-mailserver/pull/2030), [#2024](https://github.com/docker-mailserver/docker-mailserver/pull/2024), [#2001](https://github.com/docker-mailserver/docker-mailserver/pull/2001), [#2000](https://github.com/docker-mailserver/docker-mailserver/pull/2000), [#2059](https://github.com/docker-mailserver/docker-mailserver/pull/2059))
 - **[feat]** Added dovecot-fts-xapian ([#2064](https://github.com/docker-mailserver/docker-mailserver/pull/2064))
 - **[security]** Switch GPG keyserver ([#2051](https://github.com/docker-mailserver/docker-mailserver/pull/2051))
 
+
+
 ## `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.
@@ -984,7 +101,7 @@ This release improves on `9.1.0` in many aspect, including general fixes, Fail2B
 - **[general]** Added update check and notification ([#1976](https://github.com/docker-mailserver/docker-mailserver/pull/1976), [#1951](https://github.com/docker-mailserver/docker-mailserver/pull/1951))
 - **[general]** Moved environment variables to the documentation and improvements ([#1948](https://github.com/docker-mailserver/docker-mailserver/pull/1948), [#1947](https://github.com/docker-mailserver/docker-mailserver/pull/1947), [#1931](https://github.com/docker-mailserver/docker-mailserver/pull/1931))
 - **[security]** Major Fail2Ban improvements (cleanup, update and breaking changes, see below)
-- **[fix]** `./setup.sh email del ...` now works properly
+- **[fix]** `./setup.sh email del ...` now works properly 
 - **[code]** Added color variables to `setup.sh` and improved the script as a whole ([#1879](https://github.com/docker-mailserver/docker-mailserver/pull/1879), [#1886](https://github.com/docker-mailserver/docker-mailserver/pull/1886))
 - **[ldap]** Added `LDAP_QUERY_FILTER_SENDERS` ([#1902](https://github.com/docker-mailserver/docker-mailserver/pull/1902))
 - **[ldap]** Use dovecots LDAP `uris` connect option instead of `hosts` ([#1901](https://github.com/docker-mailserver/docker-mailserver/pull/1901))
@@ -1008,12 +125,12 @@ This release improves on `9.1.0` in many aspect, including general fixes, Fail2B
 
 ## `v9.1.0`
 
-This release marks the breakpoint where the wiki was transferred to a [reworked documentation](https://docker-mailserver.github.io/docker-mailserver/latest/)
+This release marks the breakpoint where the wiki was transferred to a [reworked documentation](https://docker-mailserver.github.io/docker-mailserver/edge/)
 
 - **[feat]** Introduce ENABLE_AMAVIS env ([#1866](https://github.com/docker-mailserver/docker-mailserver/pull/1866))
 - **[docs]** Move wiki to gh-pages ([#1826](https://github.com/docker-mailserver/docker-mailserver/pull/1826)) - Special thanks to @polarathene 👨🏻‍💻
   - You can [edit the docs](https://github.com/docker-mailserver/docker-mailserver/tree/master/docs/content) now directly with your code changes
-  - Documentation is now versioned related to docker image versions and viewable here: <https://docker-mailserver.github.io/docker-mailserver/latest/>
+  - Documentation is now versioned related to docker image versions and viewable here: <https://docker-mailserver.github.io/docker-mailserver/edge/>
 
 ## `v9.0.1`
 

Dockerfile

@@ -1,113 +1,129 @@
-# syntax=docker.io/docker/dockerfile:1
-
-# This Dockerfile provides four stages: stage-base, stage-compile, stage-main and stage-final
-# This is in preparation for more granular stages (eg ClamAV and Fail2Ban split into their own)
+FROM docker.io/debian:buster-slim
 
+ARG VCS_VER
+ARG VCS_REF
 ARG DEBIAN_FRONTEND=noninteractive
-ARG DOVECOT_COMMUNITY_REPO=0
-ARG LOG_LEVEL=trace
 
-FROM docker.io/debian:12-slim AS stage-base
+ARG FAIL2BAN_DEB_URL=https://github.com/fail2ban/fail2ban/releases/download/0.11.2/fail2ban_0.11.2-1.upstream1_all.deb
+ARG FAIL2BAN_DEB_ASC_URL=${FAIL2BAN_DEB_URL}.asc
+ARG FAIL2BAN_GPG_PUBLIC_KEY_ID=0x683BF1BEBD0A882C
+ARG FAIL2BAN_GPG_PUBLIC_KEY_SERVER=hkps://keyserver.ubuntu.com
+ARG FAIL2BAN_GPG_FINGERPRINT="8738 559E 26F6 71DF 9E2C  6D9E 683B F1BE BD0A 882C"
 
-ARG DEBIAN_FRONTEND
-ARG DOVECOT_COMMUNITY_REPO
-ARG LOG_LEVEL
+LABEL org.opencontainers.image.version=${VCS_VER}
+LABEL org.opencontainers.image.revision=${VCS_REF}
+LABEL org.opencontainers.image.title="docker-mailserver"
+LABEL org.opencontainers.image.vendor="The Docker Mailserver Organization"
+LABEL org.opencontainers.image.authors="The Docker Mailserver Organization on GitHub"
+LABEL org.opencontainers.image.licenses="MIT"
+LABEL org.opencontainers.image.description="A fullstack but simple mail server (SMTP, IMAP, LDAP, Antispam, Antivirus, etc.). Only configuration files, no SQL database."
+LABEL org.opencontainers.image.url="https://github.com/docker-mailserver"
+LABEL org.opencontainers.image.documentation="https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md"
+LABEL org.opencontainers.image.source="https://github.com/docker-mailserver/docker-mailserver"
 
-SHELL ["/bin/bash", "-e", "-o", "pipefail", "-c"]
+ENV ENABLE_POSTGREY=0
+ENV FETCHMAIL_POLL=300
+ENV ONE_DIR=1
+ENV POSTGREY_AUTO_WHITELIST_CLIENTS=5
+ENV POSTGREY_DELAY=300
+ENV POSTGREY_MAX_AGE=35
+ENV POSTGREY_TEXT="Delayed by Postgrey"
+ENV SASLAUTHD_MECHANISMS=pam
+ENV SASLAUTHD_MECH_OPTIONS=""
+
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
 
 # -----------------------------------------------
 # --- Install Basic Software --------------------
 # -----------------------------------------------
 
-COPY target/bin/sedfile /usr/local/bin/sedfile
-RUN <<EOF
-  chmod +x /usr/local/bin/sedfile
-  adduser --quiet --system --group --disabled-password --home /var/lib/clamav --no-create-home --uid 200 clamav
-EOF
+RUN \
+  # Backport repo for dovecot-fts-xapian package. This can be removed once Debian 11 is used as base image.
+  echo 'deb http://deb.debian.org/debian buster-backports main' > /etc/apt/sources.list.d/buster-backports.list && \
+  apt-get -qq update && \
+  apt-get -qq install apt-utils 2>/dev/null && \
+  apt-get -qq dist-upgrade && \
+  apt-get -qq install postfix && \
+  apt-get -qq --no-install-recommends install \
+  # A - D
+  altermime amavisd-new apt-transport-https arj binutils bzip2 bsd-mailx \
+  ca-certificates cabextract clamav clamav-daemon cpio curl \
+  dbconfig-no-thanks dovecot-core dovecot-fts-xapian dovecot-imapd \
+  dovecot-ldap dovecot-lmtpd dovecot-managesieved dovecot-pop3d \
+  dovecot-sieve dovecot-solr dumb-init \
+  # E - O
+  ed fetchmail file gamin gnupg gzip iproute2 iptables \
+  locales logwatch lhasa libdate-manip-perl liblz4-tool \
+  libmail-spf-perl libnet-dns-perl libsasl2-modules lrzip lzop \
+  netcat-openbsd nomarch opendkim opendkim-tools opendmarc \
+  # P - Z
+  pax pflogsumm postgrey p7zip-full postfix-ldap postfix-pcre \
+  postfix-policyd-spf-python postsrsd pyzor \
+  razor rpm2cpio rsyslog sasl2-bin spamassassin supervisor \
+  unrar-free unzip uuid whois xz-utils && \
+  # Fail2Ban
+  gpg --keyserver ${FAIL2BAN_GPG_PUBLIC_KEY_SERVER} \
+    --recv-keys ${FAIL2BAN_GPG_PUBLIC_KEY_ID} 2>&1 && \
+  curl -Lkso fail2ban.deb ${FAIL2BAN_DEB_URL} && \
+  curl -Lkso fail2ban.deb.asc ${FAIL2BAN_DEB_ASC_URL} && \
+  FINGERPRINT="$(LANG=C gpg --verify \
+  fail2ban.deb.asc fail2ban.deb 2>&1 \
+    | sed -n 's#Primary key fingerprint: \(.*\)#\1#p')" && \
+  if [[ -z ${FINGERPRINT} ]]; then \
+    echo "ERROR: Invalid GPG signature!" >&2; exit 1; fi && \
+  if [[ ${FINGERPRINT} != "${FAIL2BAN_GPG_FINGERPRINT}" ]]; then \
+    echo "ERROR: Wrong GPG fingerprint!" >&2; exit 1; fi && \
+  dpkg -i fail2ban.deb 2>&1 && \
+  rm fail2ban.deb fail2ban.deb.asc && \
+  # cleanup
+  apt-get -qq autoremove && \
+  apt-get -qq autoclean && \
+  apt-get -qq clean && \
+  rm -rf /var/lib/apt/lists/* && \
+  c_rehash 2>&1
 
-COPY target/scripts/build/packages.sh /build/
-COPY target/scripts/helpers/log.sh /usr/local/bin/helpers/log.sh
-
-RUN /bin/bash /build/packages.sh && rm -r /build
-
-# -----------------------------------------------
-# --- Compile deb packages ----------------------
-# -----------------------------------------------
-
-FROM stage-base AS stage-compile
-
-ARG LOG_LEVEL
-ARG DEBIAN_FRONTEND
-
-COPY target/scripts/build/compile.sh /build/
-RUN /bin/bash /build/compile.sh
-
-#
-# main stage provides all packages, config, and adds scripts
-#
-
-FROM stage-base AS stage-main
-
-ARG DEBIAN_FRONTEND
-ARG LOG_LEVEL
-
-SHELL ["/bin/bash", "-e", "-o", "pipefail", "-c"]
+COPY ./target/bin/sedfile /usr/local/bin/sedfile
 
+RUN chmod +x /usr/local/bin/sedfile
 
 # -----------------------------------------------
 # --- ClamAV & FeshClam -------------------------
 # -----------------------------------------------
 
-# Copy over latest DB updates from official ClamAV image. This is better than running `freshclam`,
-# which would require an extra memory of 500MB+ during an image build.
-# When using `COPY --link`, the `--chown` option is only compatible with numeric ID values.
-# hadolint ignore=DL3021
-COPY --link --chown=200 --from=docker.io/clamav/clamav-debian:latest /var/lib/clamav /var/lib/clamav
-
-RUN <<EOF
-  # `COPY --link --chown=200` has a bug when built by the buildx docker-container driver.
-  # Restore ownership of parent dirs (Bug: https://github.com/moby/buildkit/issues/3912)
-  chown root:root /var /var/lib
-  echo '0 */6 * * * clamav /usr/bin/freshclam --quiet' >/etc/cron.d/clamav-freshclam
-  chmod 644 /etc/clamav/freshclam.conf
-  sedfile -i 's/Foreground false/Foreground true/g' /etc/clamav/clamd.conf
-  mkdir /var/run/clamav
-  chown -R clamav:root /var/run/clamav
+RUN \
+  echo '0 */6 * * * clamav /usr/bin/freshclam --quiet' >/etc/cron.d/clamav-freshclam && \
+  chmod 644 /etc/clamav/freshclam.conf && \
+  freshclam && \
+  sedfile -i 's/Foreground false/Foreground true/g' /etc/clamav/clamd.conf && \
+  mkdir /var/run/clamav && \
+  chown -R clamav:root /var/run/clamav && \
   rm -rf /var/log/clamav/
-EOF
 
 # -----------------------------------------------
 # --- Dovecot -----------------------------------
 # -----------------------------------------------
 
-# install fts_xapian plugin
-
-COPY --from=stage-compile dovecot-fts-xapian-*.deb /
-RUN dpkg -i /dovecot-fts-xapian-*.deb && rm /dovecot-fts-xapian-*.deb
-
-COPY target/dovecot/*.inc target/dovecot/*.conf /etc/dovecot/conf.d/
+COPY target/dovecot/auth-passwdfile.inc target/dovecot/??-*.conf /etc/dovecot/conf.d/
+COPY target/dovecot/sieve/ /etc/dovecot/sieve/
 COPY target/dovecot/dovecot-purge.cron /etc/cron.d/dovecot-purge.disabled
 RUN chmod 0 /etc/cron.d/dovecot-purge.disabled
+WORKDIR /usr/share/dovecot
 
-# -----------------------------------------------
-# --- Rspamd ------------------------------------
-# -----------------------------------------------
-
-COPY target/rspamd/local.d/ /etc/rspamd/local.d/
-
-# -----------------------------------------------
-# --- OAUTH2 ------------------------------------
-# -----------------------------------------------
-
-COPY target/dovecot/dovecot-oauth2.conf.ext /etc/dovecot
-COPY target/dovecot/auth-oauth2.conf.ext /etc/dovecot/conf.d
+# hadolint ignore=SC2016,SC2086,SC2069
+RUN \
+  sedfile -i -e 's/include_try \/usr\/share\/dovecot\/protocols\.d/include_try \/etc\/dovecot\/protocols\.d/g' /etc/dovecot/dovecot.conf && \
+  sedfile -i -e 's/#mail_plugins = \$mail_plugins/mail_plugins = \$mail_plugins sieve/g' /etc/dovecot/conf.d/15-lda.conf && \
+  sedfile -i -e 's/^.*lda_mailbox_autocreate.*/lda_mailbox_autocreate = yes/g' /etc/dovecot/conf.d/15-lda.conf && \
+  sedfile -i -e 's/^.*lda_mailbox_autosubscribe.*/lda_mailbox_autosubscribe = yes/g' /etc/dovecot/conf.d/15-lda.conf && \
+  sedfile -i -e 's/^.*postmaster_address.*/postmaster_address = '${POSTMASTER_ADDRESS:="postmaster@domain.com"}'/g' /etc/dovecot/conf.d/15-lda.conf && \
+  mkdir -p /usr/lib/dovecot/sieve-pipe /usr/lib/dovecot/sieve-filter /usr/lib/dovecot/sieve-global && \
+  chmod 755 -R /usr/lib/dovecot/sieve-pipe /usr/lib/dovecot/sieve-filter /usr/lib/dovecot/sieve-global
 
 # -----------------------------------------------
 # --- LDAP & SpamAssassin's Cron ----------------
 # -----------------------------------------------
 
 COPY target/dovecot/dovecot-ldap.conf.ext /etc/dovecot
-COPY target/dovecot/auth-ldap.conf.ext /etc/dovecot/conf.d
 COPY \
   target/postfix/ldap-users.cf \
   target/postfix/ldap-groups.cf \
@@ -117,13 +133,9 @@ COPY \
   /etc/postfix/
 
 # hadolint ignore=SC2016
-RUN <<EOF
-  # ref: https://github.com/docker-mailserver/docker-mailserver/pull/3403#discussion_r1306282387
-  echo 'CRON=1' >/etc/default/spamassassin
+RUN \
+  sedfile -i -r 's/^(CRON)=0/\1=1/g' /etc/default/spamassassin && \
   sedfile -i -r 's/^\$INIT restart/supervisorctl restart amavis/g' /etc/spamassassin/sa-update-hooks.d/amavisd-new
-  mkdir /etc/spamassassin/kam/
-  curl -sSfLo /etc/spamassassin/kam/kam.sa-channels.mcgrail.com.key https://mcgrail.com/downloads/kam.sa-channels.mcgrail.com.key
-EOF
 
 # -----------------------------------------------
 # --- PostSRSD, Postgrey & Amavis ---------------
@@ -131,52 +143,41 @@ EOF
 
 COPY target/postsrsd/postsrsd /etc/default/postsrsd
 COPY target/postgrey/postgrey /etc/default/postgrey
-RUN <<EOF
-  mkdir /var/run/postgrey
-  chown postgrey:postgrey /var/run/postgrey
-  curl -Lsfo /etc/postgrey/whitelist_clients https://raw.githubusercontent.com/schweikert/postgrey/master/postgrey_whitelist_clients
-EOF
+COPY target/postgrey/postgrey.init /etc/init.d/postgrey
+RUN \
+  chmod 755 /etc/init.d/postgrey && \
+  mkdir /var/run/postgrey && \
+  chown postgrey:postgrey /var/run/postgrey && \
+  curl -Lsfo /etc/postgrey/whitelist_clients https://postgrey.schweikert.ch/pub/postgrey_whitelist_clients
 
 COPY target/amavis/conf.d/* /etc/amavis/conf.d/
-COPY target/amavis/postfix-amavis.cf /etc/dms/postfix/master.d/
-RUN <<EOF
-  sedfile -i -r 's/#(@|   \\%)bypass/\1bypass/g' /etc/amavis/conf.d/15-content_filter_mode
+RUN \
+  sedfile -i -r 's/#(@|   \\%)bypass/\1bypass/g' /etc/amavis/conf.d/15-content_filter_mode && \
   # add users clamav and amavis to each others group
-  adduser clamav amavis
-  adduser amavis clamav
+  adduser clamav amavis && \
+  adduser amavis clamav && \
   # no syslog user in Debian compared to Ubuntu
-  adduser --system syslog
-  useradd -u 5000 -d /home/docker -s /bin/bash -p "$(echo docker | openssl passwd -1 -stdin)" docker
-  echo "0 4 * * * /usr/local/bin/virus-wiper" | crontab -
+  adduser --system syslog && \
+  useradd -u 5000 -d /home/docker -s /bin/bash -p "$(echo docker | openssl passwd -1 -stdin)" docker && \
+  echo "0 4 * * * /usr/local/bin/virus-wiper" | crontab - && \
   chmod 644 /etc/amavis/conf.d/*
-EOF
 
 # overcomplication necessary for CI
-# hadolint ignore=SC2086
-RUN <<EOF
-  for _ in {1..10}; do
-    su - amavis -c "razor-admin -create"
-    sleep 3
-    if su - amavis -c "razor-admin -register"; then
-      EC=0
-      break
-    else
-      EC=${?}
-    fi
-  done
-  exit ${EC}
-EOF
+RUN \
+  for _ in {1..10}; do su - amavis -c "razor-admin -create" ; sleep 3 ; \
+  if su - amavis -c "razor-admin -register" ; then { EC=0 ; break ; } ; \
+  else EC=${?} ; fi ; done ; (exit ${EC})
 
 # -----------------------------------------------
 # --- Fail2Ban, DKIM & DMARC --------------------
 # -----------------------------------------------
 
 COPY target/fail2ban/jail.local /etc/fail2ban/jail.local
-COPY target/fail2ban/fail2ban.d/fixes.local /etc/fail2ban/fail2ban.d/fixes.local
-RUN <<EOF
-  ln -s  /var/log/mail/mail.log     /var/log/mail.log
-  ln -sf /var/log/mail/fail2ban.log /var/log/fail2ban.log
-EOF
+RUN \
+  ln -s /var/log/mail/mail.log /var/log/mail.log && \
+  # disable sshd jail
+  rm /etc/fail2ban/jail.d/defaults-debian.conf && \
+  mkdir /var/run/fail2ban
 
 COPY target/opendkim/opendkim.conf /etc/opendkim.conf
 COPY target/opendkim/default-opendkim /etc/default/opendkim
@@ -185,26 +186,16 @@ COPY target/opendmarc/opendmarc.conf /etc/opendmarc.conf
 COPY target/opendmarc/default-opendmarc /etc/default/opendmarc
 COPY target/opendmarc/ignore.hosts /etc/opendmarc/ignore.hosts
 
-# --------------------------------------------------
-# --- postfix-mta-sts-daemon -----------------------
-# --------------------------------------------------
-COPY target/mta-sts-daemon/mta-sts-daemon.yml /etc/mta-sts-daemon.yml
-RUN <<EOF
-  mkdir /var/run/mta-sts
-  chown -R _mta-sts:root /var/run/mta-sts
-EOF
+RUN \
+  # switch iptables and ip6tables to legacy for Fail2Ban
+  update-alternatives --set iptables /usr/sbin/iptables-legacy && \
+  update-alternatives --set ip6tables /usr/sbin/ip6tables-legacy
 
-# --------------------------------------------------
-# --- Fetchmail, Getmail, Postfix & Let'sEncrypt ---
-# --------------------------------------------------
-
-# Remove invalid URL from SPF message
-# https://bugs.launchpad.net/spf-engine/+bug/1896912
-RUN echo 'Reason_Message = Message {rejectdefer} due to: {spf}.' >>/etc/postfix-policyd-spf-python/policyd-spf.conf
+# -----------------------------------------------
+# --- Fetchmail, Postfix & Let'sEncrypt ---------
+# -----------------------------------------------
 
 COPY target/fetchmail/fetchmailrc /etc/fetchmailrc_general
-COPY target/getmail/getmailrc_general /etc/getmailrc_general
-COPY target/getmail/getmail-service.sh /usr/local/bin/
 COPY target/postfix/main.cf target/postfix/master.cf /etc/postfix/
 
 # DH parameters for DHE cipher suites, ffdhe4096 is the official standard 4096-bit DH params now part of TLS 1.3
@@ -219,51 +210,46 @@ COPY \
   target/postfix/sender_login_maps.pcre \
   /etc/postfix/maps/
 
-RUN <<EOF
-  : >/etc/aliases
-  sedfile -i 's/START_DAEMON=no/START_DAEMON=yes/g' /etc/default/fetchmail
+RUN \
+  : >/etc/aliases && \
+  sedfile -i 's/START_DAEMON=no/START_DAEMON=yes/g' /etc/default/fetchmail && \
   mkdir /var/run/fetchmail && chown fetchmail /var/run/fetchmail
-EOF
 
 # -----------------------------------------------
 # --- Logs --------------------------------------
 # -----------------------------------------------
 
-RUN <<EOF
-  sedfile -i -r "/^#?compress/c\compress\ncopytruncate" /etc/logrotate.conf
-  mkdir /var/log/mail
-  chown syslog:root /var/log/mail
-  touch /var/log/mail/clamav.log
-  chown -R clamav:root /var/log/mail/clamav.log
-  touch /var/log/mail/freshclam.log
-  chown -R clamav:root /var/log/mail/freshclam.log
-  sedfile -i -r 's|/var/log/mail|/var/log/mail/mail|g' /etc/rsyslog.conf
-  sedfile -i -r 's|;auth,authpriv.none|;mail.none;mail.error;auth,authpriv.none|g' /etc/rsyslog.conf
-  sedfile -i -r 's|LogFile /var/log/clamav/|LogFile /var/log/mail/|g' /etc/clamav/clamd.conf
-  sedfile -i -r 's|UpdateLogFile /var/log/clamav/|UpdateLogFile /var/log/mail/|g' /etc/clamav/freshclam.conf
-  sedfile -i -r 's|/var/log/clamav|/var/log/mail|g' /etc/logrotate.d/clamav-daemon
-  sedfile -i -r 's|invoke-rc.d.*|/usr/bin/supervisorctl signal hup clamav >/dev/null \|\| true|g' /etc/logrotate.d/clamav-daemon
-  sedfile -i -r 's|/var/log/clamav|/var/log/mail|g' /etc/logrotate.d/clamav-freshclam
-  sedfile -i -r '/postrotate/,/endscript/d' /etc/logrotate.d/clamav-freshclam
-  sedfile -i -r 's|/var/log/mail|/var/log/mail/mail|g' /etc/logrotate.d/rsyslog
-  sedfile -i -r '/\/var\/log\/mail\/mail.log/d' /etc/logrotate.d/rsyslog
-  sedfile -i    's|^/var/log/fail2ban.log {$|/var/log/mail/fail2ban.log {|' /etc/logrotate.d/fail2ban
+RUN \
+  sedfile -i -r "/^#?compress/c\compress\ncopytruncate" /etc/logrotate.conf && \
+  mkdir -p /var/log/mail && \
+  chown syslog:root /var/log/mail && \
+  touch /var/log/mail/clamav.log && \
+  chown -R clamav:root /var/log/mail/clamav.log && \
+  touch /var/log/mail/freshclam.log && \
+  chown -R clamav:root /var/log/mail/freshclam.log && \
+  sedfile -i -r 's|/var/log/mail|/var/log/mail/mail|g' /etc/rsyslog.conf && \
+  sedfile -i -r 's|;auth,authpriv.none|;mail.none;mail.error;auth,authpriv.none|g' /etc/rsyslog.conf && \
+  sedfile -i -r 's|LogFile /var/log/clamav/|LogFile /var/log/mail/|g' /etc/clamav/clamd.conf && \
+  sedfile -i -r 's|UpdateLogFile /var/log/clamav/|UpdateLogFile /var/log/mail/|g' /etc/clamav/freshclam.conf && \
+  sedfile -i -r 's|/var/log/clamav|/var/log/mail|g' /etc/logrotate.d/clamav-daemon && \
+  sedfile -i -r 's|invoke-rc.d.*|/usr/bin/supervisorctl signal hup clamav >/dev/null \|\| true|g' /etc/logrotate.d/clamav-daemon && \
+  sedfile -i -r 's|/var/log/clamav|/var/log/mail|g' /etc/logrotate.d/clamav-freshclam && \
+  sedfile -i -r '/postrotate/,/endscript/d' /etc/logrotate.d/clamav-freshclam && \
+  sedfile -i -r 's|/var/log/mail|/var/log/mail/mail|g' /etc/logrotate.d/rsyslog && \
+  sedfile -i -r '/\/var\/log\/mail\/mail.log/d' /etc/logrotate.d/rsyslog && \
   # prevent syslog logrotate warnings
-  sedfile -i -e 's/\(printerror "could not determine current runlevel"\)/#\1/' /usr/sbin/invoke-rc.d
-  sedfile -i -e 's/^\(POLICYHELPER=\).*/\1/' /usr/sbin/invoke-rc.d
+  sedfile -i -e 's/\(printerror "could not determine current runlevel"\)/#\1/' /usr/sbin/invoke-rc.d && \
+  sedfile -i -e 's/^\(POLICYHELPER=\).*/\1/' /usr/sbin/invoke-rc.d && \
   # prevent syslog warning about imklog permissions
-  sedfile -i -e 's/^module(load=\"imklog\")/#module(load=\"imklog\")/' /etc/rsyslog.conf
-  # this change is for our alternative process manager rather than part of
-  # a fix related to the change preceding it.
-  echo -e '\n/usr/bin/supervisorctl signal hup rsyslog >/dev/null' >>/usr/lib/rsyslog/rsyslog-rotate
-EOF
+  sedfile -i -e 's/^module(load=\"imklog\")/#module(load=\"imklog\")/' /etc/rsyslog.conf && \
+  # prevent email when /sbin/init or init system is not existing
+  sedfile -i -e 's|invoke-rc.d rsyslog rotate > /dev/null|/usr/bin/supervisorctl signal hup rsyslog >/dev/null|g' /usr/lib/rsyslog/rsyslog-rotate
 
 # -----------------------------------------------
 # --- Logwatch ----------------------------------
 # -----------------------------------------------
 
 COPY target/logwatch/maillog.conf /etc/logwatch/conf/logfiles/maillog.conf
-COPY target/logwatch/ignore.conf /etc/logwatch/conf/ignore.conf
 
 # -----------------------------------------------
 # --- Supervisord & Start -----------------------
@@ -276,60 +262,32 @@ COPY target/supervisor/conf.d/* /etc/supervisor/conf.d/
 # --- Scripts & Miscellaneous--------------------
 # -----------------------------------------------
 
-RUN <<EOF
-  rm -rf /usr/share/locale/*
-  rm -rf /usr/share/man/*
-  rm -rf /usr/share/doc/*
-  update-locale
-EOF
+RUN \
+  rm -rf /usr/share/locale/* && \
+  rm -rf /usr/share/man/* && \
+  rm -rf /usr/share/doc/* && \
+  touch /var/log/auth.log && \
+  update-locale && \
+  rm /etc/postsrsd.secret && \
+  rm /etc/cron.daily/00logwatch
+
+COPY ./VERSION /
 
 COPY \
-  target/bin/* \
-  target/scripts/*.sh \
-  target/scripts/startup/*.sh \
+  ./target/bin/* \
+  ./target/scripts/*.sh \
+  ./target/scripts/startup/*.sh \
+  ./target/docker-configomat/configomat.sh \
   /usr/local/bin/
 
 RUN chmod +x /usr/local/bin/*
 
-COPY target/scripts/helpers /usr/local/bin/helpers
-COPY target/scripts/startup/setup.d /usr/local/bin/setup.d
-
-#
-# Final stage focuses only on image config
-#
-
-FROM stage-main AS stage-final
-ARG DMS_RELEASE=edge
-ARG VCS_REVISION=unknown
+COPY ./target/scripts/helpers /usr/local/bin/helpers
 
 WORKDIR /
+
 EXPOSE 25 587 143 465 993 110 995 4190
+
 ENTRYPOINT ["/usr/bin/dumb-init", "--"]
+
 CMD ["supervisord", "-c", "/etc/supervisor/supervisord.conf"]
-
-# These ENVs are referenced in target/supervisor/conf.d/saslauth.conf
-# and must be present when supervisord starts. Introduced by PR:
-# https://github.com/docker-mailserver/docker-mailserver/pull/676
-# These ENV are also configured with the same defaults at:
-# https://github.com/docker-mailserver/docker-mailserver/blob/672e9cf19a3bb1da309e8cea6ee728e58f905366/target/scripts/helpers/variables.sh
-ENV FETCHMAIL_POLL=300
-ENV POSTGREY_AUTO_WHITELIST_CLIENTS=5
-ENV POSTGREY_DELAY=300
-ENV POSTGREY_MAX_AGE=35
-ENV POSTGREY_TEXT="Delayed by Postgrey"
-ENV SASLAUTHD_MECH_OPTIONS=""
-
-# Add metadata to image:
-LABEL org.opencontainers.image.title="docker-mailserver"
-LABEL org.opencontainers.image.vendor="The Docker Mailserver Organization"
-LABEL org.opencontainers.image.authors="The Docker Mailserver Organization on GitHub"
-LABEL org.opencontainers.image.licenses="MIT"
-LABEL org.opencontainers.image.description="A fullstack but simple mail server (SMTP, IMAP, LDAP, Anti-spam, Anti-virus, etc.). Only configuration files, no SQL database."
-LABEL org.opencontainers.image.url="https://github.com/docker-mailserver"
-LABEL org.opencontainers.image.documentation="https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md"
-LABEL org.opencontainers.image.source="https://github.com/docker-mailserver/docker-mailserver"
-# ARG invalidates cache when it is used by a layer (implicitly affects RUN)
-# Thus to maximize cache, keep these lines last:
-LABEL org.opencontainers.image.revision=${VCS_REVISION}
-LABEL org.opencontainers.image.version=${DMS_RELEASE}
-ENV DMS_RELEASE=${DMS_RELEASE}

Makefile

@@ -1,88 +1,56 @@
-SHELL       := /bin/bash
-.SHELLFLAGS += -e -u -o pipefail
+SHELL = /bin/bash
 
-export REPOSITORY_ROOT := $(CURDIR)
-export IMAGE_NAME      ?= mailserver-testing:ci
-export NAME            ?= $(IMAGE_NAME)
+NAME   ?= mailserver-testing:ci
+VCS_REF = $(shell git rev-parse --short HEAD)
+VCS_VER = $(shell git describe --tags --contains --always)
 
-MAKEFLAGS              += --no-print-directory
-BATS_FLAGS             ?= --timing
-BATS_PARALLEL_JOBS     ?= 2
+# -----------------------------------------------
+# --- Generic Build Targets ---------------------
+# -----------------------------------------------
+
+all: lint build backup generate-accounts tests clean
+
+build:
+	docker build -t $(NAME) . --build-arg VCS_VER=$(VCS_VER) --build-arg VCS_REF=$(VCS_REF)
+
+backup:
+# if backup directories exist, clean hasn't been called, therefore
+# we shouldn't overwrite it. It still contains the original content.
+	-@ [[ ! -d config.bak ]] && cp -rp config config.bak || :
+	-@ [[ ! -d testconfig.bak ]] && cp -rp test/config testconfig.bak || :
+
+clean:
+# remove running and stopped test containers
+	-@ [[ -d config.bak ]] && { rm -rf config ; mv config.bak config ; } || :
+	-@ [[ -d testconfig.bak ]] && { sudo rm -rf test/config ; mv testconfig.bak test/config ; } || :
+	-@ for container in $$(docker ps -a --filter name='^/mail$$|^ldap_for_mail$$|^mail_override_hostname$$|^mail_non_subdomain_hostname$$|^open-dkim$$|^hadolint$$|^eclint$$|^shellcheck$$|mail_changedetector.*' | sed 1d | cut -f 1-1 -d ' '); do docker rm -f $$container; done
+	-@ sudo rm -rf test/onedir test/alias test/quota test/relay test/config/dovecot-lmtp/userdb test/config/key* test/config/opendkim/keys/domain.tld/ test/config/opendkim/keys/example.com/ test/config/opendkim/keys/localdomain2.com/ test/config/postfix-aliases.cf test/config/postfix-receive-access.cf test/config/postfix-receive-access.cfe test/config/dovecot-quotas.cf test/config/postfix-send-access.cf test/config/postfix-send-access.cfe test/config/relay-hosts/chksum test/config/relay-hosts/postfix-aliases.cf test/config/dhparams.pem test/config/dovecot-lmtp/dh.pem test/config/relay-hosts/dovecot-quotas.cf test/config/user-patches.sh test/alias/config/postfix-virtual.cf test/quota/config/dovecot-quotas.cf test/quota/config/postfix-accounts.cf test/relay/config/postfix-relaymap.cf test/relay/config/postfix-sasl-password.cf test/duplicate_configs/
+
+# -----------------------------------------------
+# --- Tests -------------------------------------
+# -----------------------------------------------
+
+generate-accounts:
+	@ docker run --rm -e MAIL_USER=user1@localhost.localdomain -e MAIL_PASS=mypassword -t $(NAME) /bin/sh -c 'echo "$$MAIL_USER|$$(doveadm pw -s SHA512-CRYPT -u $$MAIL_USER -p $$MAIL_PASS)"' > test/config/postfix-accounts.cf
+	@ docker run --rm -e MAIL_USER=user2@otherdomain.tld -e MAIL_PASS=mypassword -t $(NAME) /bin/sh -c 'echo "$$MAIL_USER|$$(doveadm pw -s SHA512-CRYPT -u $$MAIL_USER -p $$MAIL_PASS)"' >> test/config/postfix-accounts.cf
+	@ docker run --rm -e MAIL_USER=user3@localhost.localdomain -e MAIL_PASS=mypassword -t $(NAME) /bin/sh -c 'echo "$$MAIL_USER|$$(doveadm pw -s SHA512-CRYPT -u $$MAIL_USER -p $$MAIL_PASS)|userdb_mail=mbox:~/mail:INBOX=~/inbox"' >> test/config/postfix-accounts.cf
+	@ echo "# this is a test comment, please don't delete me :'(" >> test/config/postfix-accounts.cf
+	@ echo "           # this is also a test comment, :O" >> test/config/postfix-accounts.cf
+
+tests:
+	@ NAME=$(NAME) ./test/bats/bin/bats --timing test/*.bats
 
 .PHONY: ALWAYS_RUN
+test/%.bats: ALWAYS_RUN
+	@ ./test/bats/bin/bats $@
 
-# -----------------------------------------------
-# --- Generic Targets ---------------------------
-# -----------------------------------------------
+lint: eclint hadolint shellcheck
 
-all: lint build generate-accounts tests clean
-
-build: ALWAYS_RUN
-	@ docker build --tag $(IMAGE_NAME) .
-
-generate-accounts: ALWAYS_RUN
-	@ cp test/config/templates/postfix-accounts.cf test/config/postfix-accounts.cf
-	@ cp test/config/templates/dovecot-masters.cf test/config/dovecot-masters.cf
-
-# `docker ps`:  Remove any lingering test containers
-# `.gitignore`: Remove `test/duplicate_configs` and files copied via `make generate-accounts`
-clean: ALWAYS_RUN
-	-@ while read -r LINE; do CONTAINERS+=("$${LINE}"); done < <(docker ps -qaf name='^(dms-test|mail)_.*') ; \
-		for CONTAINER in "$${CONTAINERS[@]}"; do docker rm -f "$${CONTAINER}"; done
-	-@ while read -r LINE; do [[ $${LINE} =~ test/.+ ]] && FILES+=("/mnt$${LINE#test}"); done < .gitignore ; \
-		docker run --rm -v "$(REPOSITORY_ROOT)/test/:/mnt" alpine ash -c "rm -rf $${FILES[@]}"
-
-run-local-instance: ALWAYS_RUN
-	bash -c 'sleep 8 ; ./setup.sh email add postmaster@example.test 123' &
-	docker run --rm --interactive --tty --name dms-test_example \
-		--env OVERRIDE_HOSTNAME=mail.example.test \
-		--env POSTFIX_INET_PROTOCOLS=ipv4 \
-		--env DOVECOT_INET_PROTOCOLS=ipv4 \
-		--env ENABLE_CLAMAV=0 \
-		--env ENABLE_AMAVIS=0 \
-		--env ENABLE_RSPAMD=0 \
-		--env ENABLE_OPENDKIM=0 \
-		--env ENABLE_OPENDMARC=0 \
-		--env ENABLE_POLICYD_SPF=0 \
-		--env ENABLE_SPAMASSASSIN=0 \
-		--env LOG_LEVEL=trace \
-		$(IMAGE_NAME)
-
-# -----------------------------------------------
-# --- Tests  ------------------------------------
-# -----------------------------------------------
-
-tests: ALWAYS_RUN
-# See https://github.com/docker-mailserver/docker-mailserver/pull/2857#issuecomment-1312724303
-# on why `generate-accounts` is run before each set (TODO/FIXME)
-	@ for DIR in tests/{serial,parallel/set{1,2,3}} ; do $(MAKE) generate-accounts "$${DIR}" ; done
-
-tests/serial: ALWAYS_RUN
-	@ shopt -s globstar ; ./test/bats/bin/bats $(BATS_FLAGS) test/$@/*.bats
-
-tests/parallel/set%: ALWAYS_RUN
-	@ shopt -s globstar ; $(REPOSITORY_ROOT)/test/bats/bin/bats $(BATS_FLAGS) \
-		--no-parallelize-within-files \
-		--jobs $(BATS_PARALLEL_JOBS) \
-		test/$@/**/*.bats
-
-test/%: ALWAYS_RUN
-	@ shopt -s globstar nullglob ; ./test/bats/bin/bats $(BATS_FLAGS) test/tests/**/{$*,}.bats
-
-# -----------------------------------------------
-# --- Lints -------------------------------------
-# -----------------------------------------------
-
-lint: ALWAYS_RUN eclint hadolint bashcheck shellcheck
-
-hadolint: ALWAYS_RUN
+hadolint:
 	@ ./test/linting/lint.sh hadolint
 
-bashcheck: ALWAYS_RUN
-	@ ./test/linting/lint.sh bashcheck
-
-shellcheck: ALWAYS_RUN
+shellcheck:
 	@ ./test/linting/lint.sh shellcheck
 
-eclint: ALWAYS_RUN
+eclint:
 	@ ./test/linting/lint.sh eclint

README.md

@@ -2,55 +2,299 @@
 
 [![ci::status]][ci::github] [![docker::pulls]][docker::hub] [![documentation::badge]][documentation::web]
 
-[ci::status]: https://img.shields.io/github/actions/workflow/status/docker-mailserver/docker-mailserver/default_on_push.yml?branch=master&color=blue&label=CI&logo=github&logoColor=white&style=for-the-badge
+[ci::status]: https://img.shields.io/github/workflow/status/docker-mailserver/docker-mailserver/Build%2C%20Test%20%26%20Deploy?color=blue&label=CI&logo=github&logoColor=white&style=for-the-badge
 [ci::github]: https://github.com/docker-mailserver/docker-mailserver/actions
-[docker::pulls]: https://img.shields.io/docker/pulls/mailserver/docker-mailserver.svg?style=for-the-badge&logo=docker&logoColor=white&color=blue
+[docker::pulls]: https://img.shields.io/docker/pulls/mailserver/docker-mailserver.svg?style=for-the-badge&logo=docker&logoColor=white
 [docker::hub]: https://hub.docker.com/r/mailserver/docker-mailserver/
-[documentation::badge]: https://img.shields.io/badge/DOCUMENTATION-GH%20PAGES-0078D4?style=for-the-badge&logo=googledocs&logoColor=white
-[documentation::web]: https://docker-mailserver.github.io/docker-mailserver/latest/
+[documentation::badge]: https://img.shields.io/badge/DOCUMENTATION-GH%20PAGES-0078D4?style=for-the-badge&logo=git&logoColor=white
+[documentation::web]: https://docker-mailserver.github.io/docker-mailserver/edge/
 
-## :page_with_curl: About
+A production-ready fullstack but simple mail server (SMTP, IMAP, LDAP, Antispam, Antivirus, etc.). Only configuration files, no SQL database. Keep it simple and versioned. Easy to [deploy](#usage) and upgrade. [Documentation][documentation::web] via MkDocs. [Why this image was created](https://tvi.al/simple-mail-server-with-docker/).
 
-A production-ready fullstack but simple containerized mail server (SMTP, IMAP, LDAP, Anti-spam, Anti-virus, etc.).
-- Only configuration files, no SQL database. Keep it simple and versioned. Easy to deploy and upgrade.
-- Originally created by [@tomav](https://github.com/tomav), this project is now maintained by volunteers since January 2021.
+If you have issues, read the full `README` **and** the [documentation][documentation::web] **for your version** (default is `edge`) first **before opening an issue**. The issue tracker is for issues, not for personal support.
 
-## <!-- Adds a thin line break separator style -->
+1. [Included Services](#included-services)
+2. [Issues and Contributing](https://docker-mailserver.github.io/docker-mailserver/edge/contributing/issues-and-pull-requests/)
+3. [Requirements](#requirements)
+4. [Usage](#usage)
+5. [Examples](#examples)
+6. [Environment Variables](https://docker-mailserver.github.io/docker-mailserver/edge/config/environment/)
+7. [Documentation][documentation::web]
+8. [Release Notes](./CHANGELOG.md)
 
-> [!TIP]
-> Be sure to read [our documentation][documentation::web]. It provides guidance on initial setup of your mail server.
+## Included Services
 
-> [!IMPORTANT]
-> If you have issues, please search through [the documentation][documentation::web] **for your version** before opening an issue.
-> 
-> The issue tracker is for issues, not for personal support.  
-> Make sure the version of the documentation matches the image version you're using!
-
-## :link: Links to Useful Resources
-
-1. [FAQ](https://docker-mailserver.github.io/docker-mailserver/latest/faq/)
-2. [Usage](https://docker-mailserver.github.io/docker-mailserver/latest/usage/)
-3. [Examples](https://docker-mailserver.github.io/docker-mailserver/latest/examples/tutorials/basic-installation/)
-4. [Issues and Contributing](https://docker-mailserver.github.io/docker-mailserver/latest/contributing/issues-and-pull-requests/)
-5. [Release Notes](./CHANGELOG.md)
-6. [Environment Variables](https://docker-mailserver.github.io/docker-mailserver/latest/config/environment/)
-7. [Updating](https://docker-mailserver.github.io/docker-mailserver/latest/faq/#how-do-i-update-dms)
-
-## :package: Included Services
-
-- [Postfix](http://www.postfix.org) with SMTP or LDAP authentication and support for [extension delimiters](https://docker-mailserver.github.io/docker-mailserver/latest/config/account-management/overview/#aliases)
-- [Dovecot](https://www.dovecot.org) with SASL, IMAP, POP3, LDAP, [basic Sieve support](https://docker-mailserver.github.io/docker-mailserver/latest/config/advanced/mail-sieve) and [quotas](https://docker-mailserver.github.io/docker-mailserver/latest/config/account-management/overview/#quotas)
-- [Rspamd](https://rspamd.com/)
+- [Postfix](http://www.postfix.org) with SMTP or LDAP auth
+- [Dovecot](https://www.dovecot.org) for SASL, IMAP (or POP3), with LDAP Auth, Sieve and [quotas](https://docker-mailserver.github.io/docker-mailserver/edge/config/user-management/accounts#notes)
 - [Amavis](https://www.amavis.org/)
 - [SpamAssassin](http://spamassassin.apache.org/) supporting custom rules
 - [ClamAV](https://www.clamav.net/) with automatic updates
-- [OpenDKIM](http://www.opendkim.org) & [OpenDMARC](https://github.com/trusteddomainproject/OpenDMARC)
+- [OpenDKIM](http://www.opendkim.org)
+- [OpenDMARC](https://github.com/trusteddomainproject/OpenDMARC)
 - [Fail2ban](https://www.fail2ban.org/wiki/index.php/Main_Page)
 - [Fetchmail](http://www.fetchmail.info/fetchmail-man.html)
-- [Getmail6](https://getmail6.org/documentation.html)
 - [Postscreen](http://www.postfix.org/POSTSCREEN_README.html)
 - [Postgrey](https://postgrey.schweikert.ch/)
-- Support for [LetsEncrypt](https://letsencrypt.org/), manual and self-signed certificates
-- A [setup script](https://docker-mailserver.github.io/docker-mailserver/latest/config/setup.sh) for easy configuration and maintenance
-- SASLauthd with LDAP authentication
-- OAuth2 authentication (_via `XOAUTH2` or `OAUTHBEARER` SASL mechanisms_)
+- [LetsEncrypt](https://letsencrypt.org/) and self-signed certificates
+- [Setup script](https://docker-mailserver.github.io/docker-mailserver/edge/config/setup.sh) to easily configure and maintain your mail-server
+- Basic [Sieve support](https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/mail-sieve) using dovecot
+- SASLauthd with LDAP auth
+- Persistent data and state
+- [CI/CD](https://github.com/docker-mailserver/docker-mailserver/actions)
+- [Extension Delimiters](http://www.postfix.org/postconf.5.html#recipient_delimiter) (`you+extension@example.com` go to `you@example.com`)
+
+## Requirements
+
+**Recommended**:
+
+- 1 Core
+- 2GB RAM
+- Swap enabled for the container
+
+**Minimum**:
+
+- 1 vCore
+- 512MB RAM
+
+**Note:** You'll need to deactivate some services like ClamAV to be able to run on a host with 512MB of RAM. Even with 1G RAM you may run into problems without swap, see [FAQ](https://docker-mailserver.github.io/docker-mailserver/edge/faq/#what-system-requirements-are-required-to-run-docker-mailserver-effectively).
+
+## Usage
+
+### Available Images / Tags - Tagging Convention
+
+[CI/CD](https://github.com/docker-mailserver/docker-mailserver/actions) will automatically build, test and push new images to container registries. Currently, the following registries are supported:
+
+- [DockerHub](https://hub.docker.com/repository/docker/mailserver/docker-mailserver)
+- [GitHub Container Registry](https://github.com/orgs/docker-mailserver/packages?repo_name=docker-mailserver)
+
+All workflows are using the tagging convention listed below. It is subsequently applied to all images.
+
+| Event        | Ref                   | Image Tags                    |
+|--------------|-----------------------|-------------------------------|
+| `push`       | `refs/heads/master`   | `edge`                        |
+| `push tag`   | `refs/tags/[v]1.2.3`  | `1.2.3`, `1.2`, `1`, `latest` |
+
+### Get the tools
+
+Since Docker Mailserver `v10.2.0`, `setup.sh` functionality is included within the Docker image. The external convenience script is no longer required if you prefer using `docker exec <CONTAINER NAME> setup <COMMAND>` instead.
+
+**Note:** If you're using Docker or Docker Compose and are new to `docker-mailserver`, it is recommended to use the script `setup.sh` for convenience.
+
+``` BASH
+DMS_GITHUB_URL='https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/master'
+wget "${DMS_GITHUB_URL}/docker-compose.yml"
+wget "${DMS_GITHUB_URL}/mailserver.env"
+wget "${DMS_GITHUB_URL}/setup.sh"
+
+chmod a+x ./setup.sh
+./setup.sh help
+```
+
+If no `docker-mailserver` container is running, any `./setup.sh` command will check online for the `:latest` image tag (the current stable release), performing a `pull` if necessary followed by running the command in a temporary container.
+
+#### `setup.sh` for `docker-mailserver` version `v10.1.x` and below
+
+If you're using `docker-mailserver` version `v10.1.x` or below, you will need to get `setup.sh` with a specific version. Substitute `<VERSION>` with the `docker-mailserver` release version you're using: `wget https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/<VERSION>/setup.sh`.
+
+### Create a docker-compose environment
+
+1. [Install the latest docker-compose](https://docs.docker.com/compose/install/)
+2. Edit `docker-compose.yml` to your liking
+   - substitute `mail` (hostname) and `example.com` (domainname) according to your FQDN
+   - if you want to use SELinux for the `./docker-data/dms/config/:/tmp/docker-mailserver/` mount, append `-z` or `-Z`
+3. Configure the mailserver container to your liking by editing `mailserver.env` ([**Documentation**](https://docker-mailserver.github.io/docker-mailserver/edge/config/environment/)), but keep in mind this `.env` file:
+   - [_only_ basic `VAR=VAL`](https://docs.docker.com/compose/env-file/) is supported (**do not** quote your values!)
+   - variable substitution is **not** supported (e.g. :no_entry_sign: `OVERRIDE_HOSTNAME=$HOSTNAME.$DOMAINNAME` :no_entry_sign:)
+
+### Get up and running
+
+#### First Things First
+
+**Use `docker-compose up / down`, not `docker-compose start / stop`**. Otherwise, the container is not properly destroyed and you may experience problems during startup because of inconsistent state.
+
+You are able to get a full overview of how the configuration works by either running:
+
+1. `./setup.sh help` which includes the options of `setup.sh`.
+2. `docker run --rm docker.io/mailserver/docker-mailserver:latest setup help` which provides you with all the information on configuration provided "inside" the container itself.
+
+#### Starting for the first time
+
+On first start, you will likely see an error stating that there are no mail accounts and the container will exit. You must now do one of two things:
+
+1. Use `setup.sh` to help you: `./setup.sh email add <user@domain> <password>`. You may need  the `-c` option to provide the local path for persisting configuration (_a directory that mounts to `/tmp/docker-mailserver` inside the container_). This will spin up a new container, mount your configuration volume, and create your first account.
+2. Execute the complete command yourself: `docker run --rm -v "${PWD}/docker-data/dms/config/:/tmp/docker-mailserver/" docker.io/mailserver/docker-mailserver setup email add <user@domain> <password>`. Make sure to mount the correct configuration directory.
+
+You can then proceed by creating the postmaster alias and by creating DKIM keys.
+
+``` BASH
+docker-compose up -d mailserver
+
+# you may add some more users
+# for SELinux, use -Z
+./setup.sh [-Z] email add <user@domain> [<password>]
+
+# and configure aliases, DKIM and more
+./setup.sh [-Z] alias add postmaster@<domain> <user@domain>
+./setup.sh [-Z] config dkim
+```
+
+In case you're using LDAP, the setup looks a bit different as you do not add user accounts directly. Postfix doesn't know your domain(s) and you need to provide it when configuring DKIM:
+
+``` BASH
+./setup.sh config dkim domain '<domain.tld>[,<domain2.tld>]'
+```
+
+If you want to see detailed usage information, run `./setup.sh config dkim help`.
+
+### Miscellaneous
+
+#### DNS - DKIM
+
+When keys are generated, you can configure your DNS server by just pasting the content of `config/opendkim/keys/domain.tld/mail.txt` to [set up DKIM](https://mxtoolbox.com/dmarc/dkim/setup/how-to-setup-dkim). See the [documentation](https://docker-mailserver.github.io/docker-mailserver/edge/config/best-practices/dkim/) for more details.
+
+#### Custom User Changes & Patches
+
+If you'd like to change, patch or alter files or behavior of `docker-mailserver`, you can use a script. See the [documentation](https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/override-defaults/user-patches/) for a detailed explanation.
+
+#### Updating `docker-mailserver`
+
+Make sure to read the [CHANGELOG](https://github.com/docker-mailserver/docker-mailserver/blob/master/CHANGELOG.md) before updating to new versions, to be prepared for possible breaking changes.
+
+``` BASH
+docker-compose pull
+docker-compose down
+docker-compose up -d mailserver
+```
+
+You should see the new version number on startup, for example: `[ TASKLOG ]  Welcome to docker-mailserver 10.1.2`.
+
+You're done! And don't forget to have a look at the remaining functions of the `setup.sh` script with `./setup.sh help`.
+
+#### Supported Operating Systems
+
+We are currently providing support for Linux. Windows is _not_ supported and is known to cause problems. Similarly, macOS is _not officially_ supported - but you may get it to work there. In the end, Linux should be your preferred operating system for this image, especially when using this mail-server in production.
+
+#### Bare Domains
+
+If you want to use a bare domain (`hostname` == `domainname`), see [FAQ](https://docker-mailserver.github.io/docker-mailserver/edge/faq#can-i-use-nakedbare-domains-no-host-name).
+
+#### Support for Multiple Domains
+
+`docker-mailserver` supports multiple domains out of the box, so you can do this:
+
+``` BASH
+./setup.sh email add user1@docker.example.com
+./setup.sh email add user1@mail.example.de
+./setup.sh email add user1@server.example.org
+```
+
+#### SPF/Forwarding Problems
+
+If you got any problems with SPF and/or forwarding mails, give [SRS](https://github.com/roehling/postsrsd/blob/master/README.md) a try. You enable SRS by setting `ENABLE_SRS=1`. See the variable description for further information.
+
+#### Ports
+
+See the [documentation](https://docker-mailserver.github.io/docker-mailserver/edge/config/security/understanding-the-ports/) for further details and best practice advice, **especially regarding security concerns**.
+
+#### Mailboxes (_aka IMAP Folders_)
+
+`INBOX` is setup by default with the special IMAP folders `Drafts`, `Sent`, `Junk` and `Trash`. You can learn how to modify or add your own folders (_including additional special folders like `Archive`_) by visiting our docs page [_Customizing IMAP Folders_][docs-examples-imapfolders] for more information.
+
+[docs-examples-imapfolders]: https://docker-mailserver.github.io/docker-mailserver/edge/examples/use-cases/imap-folders
+
+## Examples
+
+### With Relevant Environmental Variables
+
+This example provides you only with a basic example of what a minimal setup could look like. We **strongly recommend** that you go through the configuration file yourself and adjust everything to your needs. The default [docker-compose.yml](./docker-compose.yml) can be used for the purpose out-of-the-box, see the [usage section](#usage).
+
+``` YAML
+version: '3.8'
+
+services:
+  mailserver:
+    image: docker.io/mailserver/docker-mailserver:latest
+    container_name: mailserver
+    hostname: mail
+    domainname: example.com
+    ports:
+      - "25:25"
+      - "143:143"
+      - "587:587"
+      - "993:993"
+    volumes:
+      - ./docker-data/dms/mail-data/:/var/mail/
+      - ./docker-data/dms/mail-state/:/var/mail-state/
+      - ./docker-data/dms/mail-logs/:/var/log/mail/
+      - ./docker-data/dms/config/:/tmp/docker-mailserver/
+      - /etc/localtime:/etc/localtime:ro
+    environment:
+      - ENABLE_SPAMASSASSIN=1
+      - SPAMASSASSIN_SPAM_TO_INBOX=1
+      - ENABLE_CLAMAV=1
+      - ENABLE_FAIL2BAN=1
+      - ENABLE_POSTGREY=1
+      - ENABLE_SASLAUTHD=0
+      - ONE_DIR=1
+      - DMS_DEBUG=0
+    cap_add:
+      - NET_ADMIN
+      - SYS_PTRACE
+    restart: always
+```
+
+#### LDAP setup
+
+``` YAML
+version: '3.8'
+
+services:
+  mailserver:
+    image: docker.io/mailserver/docker-mailserver:latest
+    container_name: mailserver
+    hostname: mail
+    domainname: example.com
+    ports:
+      - "25:25"
+      - "143:143"
+      - "587:587"
+      - "993:993"
+    volumes:
+      - ./docker-data/dms/mail-data/:/var/mail/
+      - ./docker-data/dms/mail-state/:/var/mail-state/
+      - ./docker-data/dms/mail-logs/:/var/log/mail/
+      - ./docker-data/dms/config/:/tmp/docker-mailserver/
+      - /etc/localtime:/etc/localtime:ro
+    environment:
+      - ENABLE_SPAMASSASSIN=1
+      - SPAMASSASSIN_SPAM_TO_INBOX=1
+      - ENABLE_CLAMAV=1
+      - 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
+      - LDAP_BIND_DN=cn=admin,dc=localhost,dc=localdomain
+      - LDAP_BIND_PW=admin
+      - LDAP_QUERY_FILTER_USER=(&(mail=%s)(mailEnabled=TRUE))
+      - LDAP_QUERY_FILTER_GROUP=(&(mailGroupMember=%s)(mailEnabled=TRUE))
+      - LDAP_QUERY_FILTER_ALIAS=(|(&(mailAlias=%s)(objectClass=PostfixBookMailForward))(&(mailAlias=%s)(objectClass=PostfixBookMailAccount)(mailEnabled=TRUE)))
+      - LDAP_QUERY_FILTER_DOMAIN=(|(&(mail=*@%s)(objectClass=PostfixBookMailAccount)(mailEnabled=TRUE))(&(mailGroupMember=*@%s)(objectClass=PostfixBookMailAccount)(mailEnabled=TRUE))(&(mailalias=*@%s)(objectClass=PostfixBookMailForward)))
+      - DOVECOT_PASS_FILTER=(&(objectClass=PostfixBookMailAccount)(uniqueIdentifier=%n))
+      - DOVECOT_USER_FILTER=(&(objectClass=PostfixBookMailAccount)(uniqueIdentifier=%n))
+      - ENABLE_SASLAUTHD=1
+      - SASLAUTHD_MECHANISMS=ldap
+      - SASLAUTHD_LDAP_SERVER=ldap
+      - SASLAUTHD_LDAP_BIND_DN=cn=admin,dc=localhost,dc=localdomain
+      - SASLAUTHD_LDAP_PASSWORD=admin
+      - SASLAUTHD_LDAP_SEARCH_BASE=ou=people,dc=localhost,dc=localdomain
+      - SASLAUTHD_LDAP_FILTER=(&(objectClass=PostfixBookMailAccount)(uniqueIdentifier=%U))
+      - POSTMASTER_ADDRESS=postmaster@localhost.localdomain
+      - POSTFIX_MESSAGE_SIZE_LIMIT=100000000
+    cap_add:
+      - NET_ADMIN
+      - SYS_PTRACE
+    restart: always
+```

SECURITY.md

@@ -1,14 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-Due to the way DMS is released, the most recent patches and the most current software is published on the `:edge` tag of the container image. Hence, security updates will land on this "rolling release tag". Older tags need manual updating, as we do not usually release an updated image for an existing tag; this will only be done in case of _severe_ vulnerabilities.
-
-| Image Tags  | Latest Packages & Patches |
-|-------------|:-------------------------:|
-| `:edge`     | :white_check_mark:        |
-| not `:edge` | :x:                       |
-
-## Reporting a Vulnerability
-
-When reporting a vulnerability, you can use GitHub's "Private Vulnerability Reporting". Just navigate to the [Open an Issue](https://github.com/docker-mailserver/docker-mailserver/issues/new/choose) page and choose "Report a security vulnerability". This way, maintainers will privately notified first. Afterwards, in a best-case scenario, if the vulnerability is fixed, the report will be made public.

VERSION

@@ -0,0 +1 @@
+10.3.0

config-examples/dovecot.cf

@@ -1,4 +0,0 @@
-# File for additional dovecot configurations.
-# For more information read https://doc.dovecot.org/configuration_manual/quick_configuration/
-
-#mail_max_userip_connections = 50

config-examples/fail2ban-jail.cf

@@ -1,40 +0,0 @@
-[DEFAULT]
-
-# "bantime" is the number of seconds that a host is banned.
-bantime = 1w
-
-# A host is banned if it has generated "maxretry" during the last "findtime"
-# seconds.
-findtime = 1w
-
-# "maxretry" is the number of failures before a host get banned.
-maxretry = 6
-
-# "ignoreip" can be a list of IP addresses, CIDR masks or DNS hosts. Fail2ban
-# will not ban a host which matches an address in this list. Several addresses
-# can be defined using space (and/or comma) separator.
-ignoreip = 127.0.0.1/8
-
-# default ban action
-# nftables-multiport: block IP only on affected port
-# nftables-allports:  block IP on all ports
-banaction = nftables-allports
-
-[dovecot]
-enabled = true
-
-[postfix]
-enabled = true
-# For a reference on why this mode was chose, see
-# https://github.com/docker-mailserver/docker-mailserver/issues/3256#issuecomment-1511188760
-mode = extra
-
-[postfix-sasl]
-enabled = true
-
-# This jail is used for manual bans.
-# To ban an IP address use: setup.sh fail2ban ban <IP>
-[custom]
-enabled = true
-bantime = 180d
-port = smtp,pop3,pop3s,imap,imaps,submission,submissions,sieve

config-examples/getmail/getmailrc_general.cf

@@ -1,11 +0,0 @@
-# https://getmail6.org/configuration.html#conf-options
-
-[options]
-verbose = 0
-read_all = false
-delete = false
-max_messages_per_session = 500
-received = false
-delivered_to = false
-message_log_syslog = true
-

config-examples/getmail/imap-example.cf

@@ -1,13 +0,0 @@
-# https://getmail6.org/configuration.html
-
-[retriever]
-type = SimpleIMAPSSLRetriever
-server = imap.gmail.com
-username = alice
-password = notsecure
-
-[destination]
-type = MDA_external
-path = /usr/lib/dovecot/deliver
-allow_root_commands = true
-arguments =("-d","user1@example.com")

config-examples/getmail/pop3-example.cf

@@ -1,13 +0,0 @@
-# https://getmail6.org/configuration.html
-
-[retriever]
-type = SimplePOP3SSLRetriever
-server = pop3.gmail.com
-username = alice
-password = notsecure
-
-[destination]
-type = MDA_external
-path = /usr/lib/dovecot/deliver
-allow_root_commands = true
-arguments =("-d","user1@example.com")

config-examples/user-patches.sh

@@ -1,12 +0,0 @@
-#!/bin/bash
-
-# This user patches script runs right before starting the daemons.
-# That means, all the other configuration is in place, so the script
-# can make final adjustments.
-# If you modify any supervisord configuration, make sure to run
-# "supervisorctl update" or "supervisorctl reload" afterwards.
-
-# For more information, see
-# https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/override-defaults/user-patches/
-
-echo 'user-patches.sh successfully executed'

config/dovecot.cf

@@ -0,0 +1,4 @@
+# File for additional dovecot configurations.
+# For more informations read http://wiki.dovecot.org/BasicConfiguration
+
+#mail_max_userip_connections = 50

config/fail2ban-fail2ban.cf

@@ -5,11 +5,11 @@
 # Changes:  in most of the cases you should not modify this
 #           file, but provide customizations in fail2ban.local file, e.g.:
 #
-# [DEFAULT]
+# [Definition]
 # loglevel = DEBUG
 #
 
-[DEFAULT]
+[Definition]
 
 # Option: loglevel
 # Notes.: Set the log level output.
@@ -19,26 +19,26 @@
 #         NOTICE
 #         INFO
 #         DEBUG
-# Values: [ LEVEL ]  Default: INFO
+# Values: [ LEVEL ]  Default: ERROR
 #
-loglevel = INFO
+#loglevel = INFO
 
 # Option: logtarget
-# Notes.: Set the log target. This could be a file, SYSTEMD-JOURNAL, SYSLOG, STDERR or STDOUT.
+# Notes.: Set the log target. This could be a file, SYSLOG, STDERR or STDOUT.
 #         Only one log target can be specified.
 #         If you change logtarget from the default value and you are
 #         using logrotate -- also adjust or disable rotation in the
 #         corresponding configuration file
 #         (e.g. /etc/logrotate.d/fail2ban on Debian systems)
-# Values: [ STDOUT | STDERR | SYSLOG | SYSOUT | SYSTEMD-JOURNAL | FILE ]  Default: STDERR
+# Values: [ STDOUT | STDERR | SYSLOG | SYSOUT | FILE ]  Default: STDERR
 #
-logtarget = /var/log/fail2ban.log
+#logtarget = /var/log/fail2ban.log
 
 # Option: syslogsocket
 # Notes: Set the syslog socket file. Only used when logtarget is SYSLOG
 #        auto uses platform.system() to determine predefined paths
 # Values: [ auto | FILE ]  Default: auto
-syslogsocket = auto
+#syslogsocket = auto
 
 # Option: socket
 # Notes.: Set the socket file. This is used to communicate with the daemon. Do
@@ -46,47 +46,24 @@ syslogsocket = auto
 #         communicate with the server afterwards.
 # Values: [ FILE ]  Default: /var/run/fail2ban/fail2ban.sock
 #
-socket = /var/run/fail2ban/fail2ban.sock
+#socket = /var/run/fail2ban/fail2ban.sock
 
 # Option: pidfile
 # Notes.: Set the PID file. This is used to store the process ID of the
 #         fail2ban server.
 # Values: [ FILE ]  Default: /var/run/fail2ban/fail2ban.pid
 #
-pidfile = /var/run/fail2ban/fail2ban.pid
-
-# Option: allowipv6
-# Notes.: Allows IPv6 interface:
-#         Default: auto
-# Values: [ auto yes (on, true, 1) no (off, false, 0) ] Default: auto
-#allowipv6 = auto
+#pidfile = /var/run/fail2ban/fail2ban.pid
 
 # Options: dbfile
 # Notes.: Set the file for the fail2ban persistent data to be stored.
-#         A value of ":memory:" means database is only stored in memory
+#         A value of ":memory:" means database is only stored in memory 
 #         and data is lost when fail2ban is stopped.
 #         A value of "None" disables the database.
 # Values: [ None :memory: FILE ] Default: /var/lib/fail2ban/fail2ban.sqlite3
-dbfile = /var/lib/fail2ban/fail2ban.sqlite3
+#dbfile = /var/lib/fail2ban/fail2ban.sqlite3
 
 # Options: dbpurgeage
 # Notes.: Sets age at which bans should be purged from the database
 # Values: [ SECONDS ] Default: 86400 (24hours)
-dbpurgeage = 1d
-
-# Options: dbmaxmatches
-# Notes.: Number of matches stored in database per ticket (resolvable via
-#         tags <ipmatches>/<ipjailmatches> in actions)
-# Values: [ INT ] Default: 10
-dbmaxmatches = 10
-
-[Definition]
-
-
-[Thread]
-
-# Options: stacksize
-# Notes.: Specifies the stack size (in KiB) to be used for subsequently created threads,
-#         and must be 0 or a positive integer value of at least 32.
-# Values: [ SIZE ] Default: 0 (use platform or configured default)
-#stacksize = 0
+#dbpurgeage = 1d

config/fail2ban-jail.cf

@@ -0,0 +1,21 @@
+[DEFAULT]
+
+# "bantime" is the number of seconds that a host is banned.
+#bantime  = 10m
+
+# A host is banned if it has generated "maxretry" during the last "findtime"
+# seconds.
+#findtime  = 10m
+
+# "maxretry" is the number of failures before a host get banned.
+#maxretry = 5
+
+# "ignoreip" can be a list of IP addresses, CIDR masks or DNS hosts. Fail2ban
+# will not ban a host which matches an address in this list. Several addresses
+# can be defined using space (and/or comma) separator.
+#ignoreip = 127.0.0.1/8
+
+# Default ban action
+# iptables-multiport:	block IP only on affected port
+# iptables-allports:	block IP on all ports
+#banaction = iptables-allports

config/user-patches.sh.dist

@@ -0,0 +1,7 @@
+#! /bin/bash
+##
+# This user patches script runs right before starting the daemons. That means, all the other configuration is in place, so the script can make final adjustments.
+# If you modify any supervisord configuration, make sure to run "supervisorctl update" or "supervisorctl reload" afterwards.
+# To enable the script, you must save it in your config directory as "user-patches.sh".
+##
+echo "Default user-patches.sh successfully executed"

demo-setups/fetchmail-compose.yaml

@@ -1,60 +0,0 @@
-# Docs: https://docker-mailserver.github.io/docker-mailserver/v15.0/config/advanced/mail-fetchmail
-# Additional context, with CLI commands for verification:
-# https://github.com/orgs/docker-mailserver/discussions/3994#discussioncomment-9290570
-
-services:
-  dms-fetch:
-    image: ghcr.io/docker-mailserver/docker-mailserver:latest # :15.0
-    hostname: mail.example.test
-    environment:
-      ENABLE_FETCHMAIL: 1
-      # We change this setting to 10 for quicker testing:
-      FETCHMAIL_POLL: 10
-    # Link the DNS lookup `remote.test` to resolve to the `dms-remote` container IP (for `@remote.test` address):
-    # This is only for this example, since no real DNS service is configured, this is a Docker internal DNS feature:
-    links:
-      - "dms-remote:remote.test"
-    # NOTE: Optional, You only need to publish ports if you want to verify via your own mail client.
-    #ports:
-    #  - "465:465"  # ESMTP (implicit TLS)
-    #  - "993:993"  # IMAP4 (implicit TLS)
-    # You'd normally use `volumes` here but for simplicity of the example, all config is contained within `compose.yaml`:
-    configs:
-      - source: dms-accounts-fetch
-        target: /tmp/docker-mailserver/postfix-accounts.cf
-      - source: fetchmail
-        target: /tmp/docker-mailserver/fetchmail.cf
-
-  dms-remote:
-    image: ghcr.io/docker-mailserver/docker-mailserver:latest # :15.0
-    hostname: mail.remote.test
-    environment:
-      # Allows for us send a test mail easily by trusting any mail client run within this container (`swaks`):
-      PERMIT_DOCKER: container
-      # Alternatively, trust and accept any mail received from clients in same subnet of dms-fetch:
-      #PERMIT_DOCKER: connected-networks
-    configs:
-      - source: dms-accounts-remote
-        target: /tmp/docker-mailserver/postfix-accounts.cf
-
-# Using the Docker Compose `configs.content` feature instead of volume mounting separate files.
-# NOTE: This feature requires Docker Compose v2.23.1 (Nov 2023) or newer:
-# https://github.com/compose-spec/compose-spec/pull/446
-configs:
-  fetchmail:
-    content: |
-      poll 'mail.remote.test' proto imap
-        user 'jane.doe@remote.test'
-        pass 'secret'
-        is 'john.doe@example.test'
-        no sslcertck
-
-  # DMS requires an account to complete setup, configure one for each instance:
-  # NOTE: Both accounts are configured with the same password (SHA512-CRYPT hashed), `secret`.
-  dms-accounts-fetch:
-    content: |
-      john.doe@example.test|{SHA512-CRYPT}$$6$$sbgFRCmQ.KWS5ryb$$EsWrlYosiadgdUOxCBHY0DQ3qFbeudDhNMqHs6jZt.8gmxUwiLVy738knqkHD4zj4amkb296HFqQ3yDq4UXt8.
-
-  dms-accounts-remote:
-    content: |
-      jane.doe@remote.test|{SHA512-CRYPT}$$6$$sbgFRCmQ.KWS5ryb$$EsWrlYosiadgdUOxCBHY0DQ3qFbeudDhNMqHs6jZt.8gmxUwiLVy738knqkHD4zj4amkb296HFqQ3yDq4UXt8.

demo-setups/relay-compose.yaml

@@ -1,147 +0,0 @@
-# Docs: https://docker-mailserver.github.io/docker-mailserver/v15.0/config/advanced/mail-forwarding/relay-hosts/
-# Additional context, with CLI commands for verification:
-# https://github.com/docker-mailserver/docker-mailserver/issues/4136#issuecomment-2253693490
-
-services:
-  # This would represent your actual DMS container:
-  dms-sender:
-    image: mailserver/docker-mailserver:latest # :15.0
-    hostname: mail.example.test
-    environment:
-      # All outbound mail will be relayed through this host
-      # (change the port to 587 if you do not want the postfix-main.cf override)
-      - DEFAULT_RELAY_HOST=[smtp.relay-service.test]:465
-      # Your relay host credentials.
-      # (since the relay in the example is DMS, the relay account username is a full email address)
-      - RELAY_USER=relay-user@relay-service.test
-      - RELAY_PASSWORD=secret
-      # The mail client (swaks) needs to connect with TLS:
-      - SSL_TYPE=manual
-      - SSL_KEY_PATH=/tmp/tls/key.pem
-      - SSL_CERT_PATH=/tmp/tls/cert.pem
-    # You would usually have `volumes` instead of this `configs`:
-    configs:
-      - source: dms-main
-        target: /tmp/docker-mailserver/postfix-main.cf
-      - source: dms-accounts
-        target: /tmp/docker-mailserver/postfix-accounts.cf
-      # Authenticating on port 587 or 465 enforces TLS requirement:
-      - source: tls-cert
-        target: /tmp/tls/cert.pem
-      - source: tls-key
-        target: /tmp/tls/key.pem
-      # This is only needed if you want to verify the TLS cert chain with swaks
-      # (normally with public CA providers like LetsEncrypt this file is already available to a mail client)
-      - source: tls-ca-cert
-        target: /tmp/tls/ca-cert.pem
-
-  # Pretend this is your third-party relay service:
-  dms-relay:
-    image: mailserver/docker-mailserver:latest # :15.0
-    hostname: smtp.relay-service.test
-    environment:
-      # WORKAROUND: Bypass security checks from the mail-client (dms-sender container)
-      # (avoids needing expected DNS records to run this example)
-      - PERMIT_DOCKER=connected-networks
-      # TLS is required when relaying to dms-relay via ports 587 / 465
-      # (dms-relay will then relay the mail to dms-destination over port 25)
-      - SSL_TYPE=manual
-      - SSL_KEY_PATH=/tmp/tls/key.pem
-      - SSL_CERT_PATH=/tmp/tls/cert.pem
-    configs:
-      - source: dms-accounts-relay
-        target: /tmp/docker-mailserver/postfix-accounts.cf
-      - source: tls-cert
-        target: /tmp/tls/cert.pem
-      - source: tls-key
-        target: /tmp/tls/key.pem
-
-  # Pretend this is another mail server that your target recipient belongs to (like Gmail):
-  dms-destination:
-    image: mailserver/docker-mailserver:latest # :15.0
-    hostname: mail.destination.test
-    # WORKAROUND: dms-relay must be able to resolve DNS for `@destination.test` to the IP of this container:
-    # Normally a MX record would direct mail to the MTA (eg: `mail.destination.test`)
-    networks:
-      default:
-        aliases:
-          - destination.test
-    environment:
-      # WORKAROUND: Same workaround as needed for dms-relay
-      - PERMIT_DOCKER=connected-networks
-    configs:
-      - source: dms-accounts-destination
-        target: /tmp/docker-mailserver/postfix-accounts.cf
-
-# Using the Docker Compose `configs.content` feature instead of volume mounting separate files.
-# NOTE: This feature requires Docker Compose v2.23.1 (Nov 2023) or newer:
-# https://github.com/compose-spec/compose-spec/pull/446
-configs:
-  # `postfix-main.cf`, a single line change to make all outbound SMTP connections over implicit TLS instead of the default explicit TLS (StartTLS).
-  # NOTE: If you need to only selectively relay mail, you would need to instead adjust this on the relay service in `/etc/postfix/master.cf`,
-  # However DMS presently modifies this when using the DMS Relay Host feature support, which may override `postfix-master.cf` or `user-patches.sh` due to `check-for-changes.sh`.
-  dms-main:
-    content: |
-      smtp_tls_wrappermode=yes
-
-  # DMS expects an account to be configured to run, this example provides accounts already created.
-  # Login credentials:
-  # user: "john.doe@example.test" password: "secret"
-  # user: "relay-user@relay-service.test" password: "secret"
-  # user: "jane.doe@destination.test" password: "secret"
-  dms-accounts:
-    # NOTE: `$` needed to be repeated to escape it,
-    # which opts out of the `compose.yaml` variable interpolation feature.
-    content: |
-      john.doe@example.test|{SHA512-CRYPT}$$6$$sbgFRCmQ.KWS5ryb$$EsWrlYosiadgdUOxCBHY0DQ3qFbeudDhNMqHs6jZt.8gmxUwiLVy738knqkHD4zj4amkb296HFqQ3yDq4UXt8.
-
-  dms-accounts-relay:
-    content: |
-      relay-user@relay-service.test|{SHA512-CRYPT}$$6$$o65y1ZXC4ooOPLwZ$$7TF1nYowEtNJpH6BwJBgdj2pPAxaCvhIKQA6ww5zdHm/AA7aemY9eoHC91DOgYNaKj1HLxSeWNDdvrp6mbtUY.
-
-  dms-accounts-destination:
-    content: |
-      jane.doe@destination.test|{SHA512-CRYPT}$$6$$o65y1ZXC4ooOPLwZ$$7TF1nYowEtNJpH6BwJBgdj2pPAxaCvhIKQA6ww5zdHm/AA7aemY9eoHC91DOgYNaKj1HLxSeWNDdvrp6mbtUY.
-
-  # TLS files:
-  # - Use an ECDSA cert that's been signed by a self-signed CA for TLS cert verification.
-  # - This cert is only valid for mail.example.test, mail.destination.test, smtp.relay-service.test
-
-  # `swaks` run in the container will need to reference this CA cert file for successful verficiation (optional).
-  tls-ca-cert:
-    content: |
-      -----BEGIN CERTIFICATE-----
-      MIIBfTCCASKgAwIBAgIRAMAZttlRlkcuSun0yV0z4RwwCgYIKoZIzj0EAwIwHDEa
-      MBgGA1UEAxMRU21hbGxzdGVwIFJvb3QgQ0EwHhcNMjEwMTAxMDAwMDAwWhcNMzEw
-      MTAxMDAwMDAwWjAcMRowGAYDVQQDExFTbWFsbHN0ZXAgUm9vdCBDQTBZMBMGByqG
-      SM49AgEGCCqGSM49AwEHA0IABJX2hCtoK3+bM5I3rmyApXLJ1gOcVhtoSSwM8XXR
-      SEl25Kkc0n6mINuMK8UrBkiBUgexf6CYayx3xVr9TmMkg4KjRTBDMA4GA1UdDwEB
-      /wQEAwIBBjASBgNVHRMBAf8ECDAGAQH/AgEBMB0GA1UdDgQWBBQD8sBrApbyYyqU
-      y+/TlwGynx2V5jAKBggqhkjOPQQDAgNJADBGAiEAi8N2eOETI+6hY3+G+kzNMd3K
-      Sd3Ke8b++/nlwr5Fb/sCIQDYAjpKp/MpTDWICeHC2tcB5ptxoTdWkTBuG4rKcktA
-      0w==
-      -----END CERTIFICATE-----
-
-  tls-key:
-    content: |
-      -----BEGIN EC PRIVATE KEY-----
-      MHcCAQEEIOc6wqZmSDmT336K4O26dMk1RCVc0+cmnsO2eK4P5K5yoAoGCCqGSM49
-      AwEHoUQDQgAEFOWNgekKKvUZE89vJ7henUYxODYIvCiHitRc2ylwttjqt1KUY1cp
-      q3jof2fhURHfBUH3dHPXLHig5V9Jw5gqeg==
-      -----END EC PRIVATE KEY-----
-
-  tls-cert:
-    content: |
-      -----BEGIN CERTIFICATE-----
-      MIIB9DCCAZqgAwIBAgIQE53a/y2c//YXRsz2kLm6gDAKBggqhkjOPQQDAjAcMRow
-      GAYDVQQDExFTbWFsbHN0ZXAgUm9vdCBDQTAeFw0yMTAxMDEwMDAwMDBaFw0zMTAx
-      MDEwMDAwMDBaMBkxFzAVBgNVBAMTDlNtYWxsc3RlcCBMZWFmMFkwEwYHKoZIzj0C
-      AQYIKoZIzj0DAQcDQgAEFOWNgekKKvUZE89vJ7henUYxODYIvCiHitRc2ylwttjq
-      t1KUY1cpq3jof2fhURHfBUH3dHPXLHig5V9Jw5gqeqOBwDCBvTAOBgNVHQ8BAf8E
-      BAMCB4AwHQYDVR0lBBYwFAYIKwYBBQUHAwEGCCsGAQUFBwMCMB0GA1UdDgQWBBSz
-      w74g+O6dcBbwienD70D8A9ESmDAfBgNVHSMEGDAWgBQD8sBrApbyYyqUy+/TlwGy
-      nx2V5jBMBgNVHREERTBDghFtYWlsLmV4YW1wbGUudGVzdIIVbWFpbC5kZXN0aW5h
-      dGlvbi50ZXN0ghdzbXRwLnJlbGF5LXNlcnZpY2UudGVzdDAKBggqhkjOPQQDAgNI
-      ADBFAiEAoety5oClZtuBMkvlUIWRmWlyg1VIOZ544LSEbplsIhcCIHb6awMwNdXP
-      m/xHjFkuwH1+UjDDRW53Ih7KZoLrQ6Cp
-      -----END CERTIFICATE-----

docker-compose.yml

@@ -1,14 +1,17 @@
 services:
   mailserver:
-    image: ghcr.io/docker-mailserver/docker-mailserver:latest
+    image: docker.io/mailserver/docker-mailserver:latest
     container_name: mailserver
-    # Provide the FQDN of your mail server here (Your DNS MX record should point to this value)
-    hostname: mail.example.com
+    # If the FQDN for your mail-server is only two labels (eg: example.com),
+    # you can assign this entirely to `hostname` and remove `domainname`.
+    hostname: mail
+    domainname: example.com
     env_file: mailserver.env
     # More information about the mail-server ports:
-    # https://docker-mailserver.github.io/docker-mailserver/latest/config/security/understanding-the-ports/
+    # https://docker-mailserver.github.io/docker-mailserver/edge/config/security/understanding-the-ports/
+    # To avoid conflicts with yaml base-60 float, DO NOT remove the quotation marks.
     ports:
-      - "25:25"    # SMTP  (explicit TLS => STARTTLS, Authentication is DISABLED => use port 465/587 instead)
+      - "25:25"    # SMTP  (explicit TLS => STARTTLS)
       - "143:143"  # IMAP4 (explicit TLS => STARTTLS)
       - "465:465"  # ESMTP (implicit TLS)
       - "587:587"  # ESMTP (explicit TLS => STARTTLS)
@@ -21,10 +24,7 @@ services:
       - /etc/localtime:/etc/localtime:ro
     restart: always
     stop_grace_period: 1m
-    # Uncomment if using `ENABLE_FAIL2BAN=1`:
-    # cap_add:
-    #   - NET_ADMIN
-    healthcheck:
-      test: "ss --listening --tcp | grep -P 'LISTEN.+:smtp' || exit 1"
-      timeout: 3s
-      retries: 0
+    cap_add:
+      - NET_ADMIN
+      - SYS_PTRACE
+

docs/content/assets/css/customizations.css

@@ -16,16 +16,12 @@ If you want to append instead, switch `::before` to `::after`.
   src: url('../fonts/external-link.woff') format('woff');
 }
 
-/*
-  Since mkdocs-material 9.5.5 broke support in our docs from DMS v13.3.1, we now use our own class name,
-  which has been included for the two external nav links in mkdocs.yml via workaround (insert HTML).
-*/
-.icon-external-link::before {
+/* Matches the two nav link classes that start with `http` `href` values, regular docs pages use relative URLs instead. */
+.md-tabs__link[href^="http"]::before, .md-nav__link[href^="http"]::before {
   display: inline-block; /* treat similar to text */
   font-family: 'external-link';
   content:'\0041'; /* represents "A" which our font renders as an icon instead of the "A" glyph */
   font-size: 80%; /* icon is a little too big by default, scale it down */
-  margin-right: 4px;
 }
 
 /* ============================================================================================================= */
@@ -102,42 +98,3 @@ div.md-content article.md-content__inner a.toclink code {
 .highlight.no-copy .md-clipboard { display: none; }
 
 /* ============================================================================================================= */
-
-/* Make the left-sidebar nav categories better distinguished from page links (bold text) */
-.md-nav__item--nested > .md-nav__link {
-  font-weight: 700;
-}
-
-/* ============================================================================================================= */
-
-/*
-  TaskList style for a pro/con list. Presently only used for this type of list in the kubernetes docs.
-  Uses a custom icon for the unchecked (con) state: :octicons-x-circle-fill-24:
-  https://github.com/squidfunk/mkdocs-material/discussions/6811#discussioncomment-8700795
-
-  TODO: Can better scope the style under a class name when migrating to block extension syntax:
-  https://github.com/facelessuser/pymdown-extensions/discussions/1973
-*/
-
-:root {
-  --md-tasklist-icon--failed: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M1 12C1 5.925 5.925 1 12 1s11 4.925 11 11-4.925 11-11 11S1 18.075 1 12Zm8.036-4.024a.751.751 0 0 0-1.042.018.751.751 0 0 0-.018 1.042L10.939 12l-2.963 2.963a.749.749 0 0 0 .326 1.275.749.749 0 0 0 .734-.215L12 13.06l2.963 2.964a.75.75 0 0 0 1.061-1.06L13.061 12l2.963-2.964a.749.749 0 0 0-.326-1.275.749.749 0 0 0-.734.215L12 10.939Z"/></svg>');
-}
-
-.md-typeset [type="checkbox"] + .task-list-indicator::before {
-  background-color: rgb(216, 87, 48);
-  -webkit-mask-image: var(--md-tasklist-icon--failed);
-  mask-image: var(--md-tasklist-icon--failed);
-}
-
-/* More suitable shade of green */
-.md-typeset [type=checkbox]:checked+.task-list-indicator:before {
-  background-color: rgb(97, 216, 42);
-}
-
-/* Tiny layout shift */
-[dir=ltr] .md-typeset .task-list-indicator:before {
-  left: -1.6em;
-  top: 1px;
-}
-
-/* ============================================================================================================= */

docs/content/config/account-management/overview.md

@@ -1,252 +0,0 @@
-# Account Management - Overview
-
-This page provides a technical reference for account management in DMS.
-
-!!! note "Account provisioners and alternative authentication support"
-
-    Each [`ACCOUNT_PROVISIONER`][docs::env::account-provisioner] has a separate page for configuration guidance and caveats:
-
-    - [`FILE` provisioner docs][docs::account-provisioner::file]
-    - [`LDAP` provisioner docs][docs::account-provisioner::ldap]
-
-    Authentication from the provisioner can be supplemented with additional methods:
-
-    - [OAuth2 / OIDC][docs::account-auth::oauth2] (_allow login from an external authentication service_)
-    - [Master Accounts][docs::account-auth::master-accounts] (_access the mailbox of any DMS account_)
-
-    ---
-
-    For custom authentication requirements, you could [implement this with Lua][docs::examples::auth-lua].
-
-## Accounts
-
-!!! info
-
-    To receive or send mail, you'll need to provision user accounts into DMS (_as each provisioner page documents_).
-
-    ---
-
-    A DMS account represents a user with their _login username_ + password, and optional config like aliases and quota.
-
-    - Sending mail from different addresses **does not require** aliases or separate accounts.
-    - Each account is configured with a _primary email address_ that a mailbox is associated to.
-
-??? info "Primary email address"
-
-    The email address associated to an account creates a mailbox. This address is relevant:
-
-    - When DMS **receives mail** for that address as the recipient (_or an alias that resolves to it_), to identify which mailbox to deliver into.
-    - With **mail submission**:
-        - `SPOOF_PROTECTION=1` **restricts the sender address** to the DMS account email address (_unless additional sender addresses have been permitted via supported config_).
-        - `SPOOF_PROTECTION=0` allows DMS accounts to **use any sender address** (_only a single DMS account is necessary to send mail with different sender addresses_).
-
-    ---
-
-    For more details, see the [Technical Overview](#technical-overview) section.
-
-??? note "Support for multiple mail domains"
-
-    No extra configuration in DMS is required after provisioning an account with an email address.
-
-    - The DNS records for a domain should direct mail to DMS and allow DMS to send mail on behalf of that domain.
-    - DMS does not need TLS certificates for your mail domains, only for the DMS FQDN (_the `hostname` setting_).
-
-??? warning "Choosing a compatible email address"
-
-    An email address should conform to the standard [permitted charset and format][email-syntax::valid-charset-format] (`local-part@domain-part`).
-
-    ---
-
-    DMS has features that need to reserve special characters to work correctly. Ensure those characters are not present in email addresses you configure for DMS, otherwise disable / opt-out of the feature.
-
-    - [Sub-addressing](#sub-addressing) is enabled by default with `+` as the _tag delimiter_. The tag can be changed, feature opt-out when the tag is explicitly unset.
-
-### Aliases
-
-!!! info
-
-    Aliases allow receiving mail:
-
-    - As an alternative delivery address for a DMS account mailbox.
-    - To redirect / forward to an external address outside of DMS like `@gmail.com`.
-
-??? abstract "Technical Details (_Local vs Virtual aliases_)"
-
-    Aliases are managed through Postfix which supports _local_ and _virtual_ aliases:
-
-    - **Local aliases** are for mail routed to the [`local` delivery agent][postfix::delivery-agent::local] (see [associated alias config format][postfix::config-table::local-alias])
-        - You rarely need to configure this. It is used internally for system unix accounts belonging to the services running in DMS (_including `root`_).
-        - `postmaster` may be a local alias to `root`, and `root` to a virtual alias or real email address.
-        - Any mail sent through the `local` delivery agent will not be delivered to an inbox managed by Dovecot (_unless you have configured a local alias to redirect mail to a valid address or alias_).
-        - The domain-part of an these aliases belongs to your DMS FQDN (_`hostname: mail.example.com`, thus `user@mail.example.com`_). Technically there is no domain-part at this point, that context is used when routing delivery, the local delivery agent only knows of the local-part (_an alias or unix account_).
-    - [**Virtual aliases**][postfix-docs::virtual-alias] are for mail routed to the [`virtual` delivery agent][postfix::delivery-agent::virtual] (see [associated alias config format][postfix::config-table::virtual-alias])
-        - When alias support in DMS is discussed without the context of being a local or virtual alias, it's likely the virtual kind (_but could also be agnostic_).
-        - The domain-part of an these aliases belongs to a mail domain managed by DMS (_like `user@example.com`_).
-
-    !!! tip "Verify alias resolves correctly"
-
-        You can run `postmap -q <alias> <table>` in the container to verify an alias resolves to the expected target. If the target is also an alias, the command will not expand that alias to resolve the actual recipient(s).
-
-        For the `FILE` provisioner, an example would be: `postmap -q alias1@example.com /etc/postfix/virtual`. For the `LDAP` provisioner you'd need to adjust the table path.
-
-    !!! info "Side effect - Dovecot Quotas (`ENABLE_QUOTAS=1`)"
-
-        As a side effect of the alias workaround for the `FILE` provisioner with this feature, aliases can be used for account login. This is not intentional.
-
-### Quotas
-
-!!! info
-
-    Enables mail clients with the capability to query a mailbox for disk-space used and capacity limit.
-
-    - This feature is enabled by default, opt-out via [`ENABLE_QUOTAS=0`][docs::env::enable-quotas]
-    - **Not implemented** for the LDAP provisioner (_PR welcome! View the [feature request for implementation advice][gh-issue::dms-feature-request::dovecot-quotas-ldap]_)
-
-??? tip "How are quotas useful?"
-
-    Without quota limits for disk storage, a mailbox could fill up the available storage which would cause delivery failures to all mailboxes.
-
-    Quotas help by preventing that abuse, so that only a mailbox exceeding the assigned quota experiences a delivery failure instead of negatively impacting others (_provided disk space is available_).
-
-??? abstract "Technical Details"
-
-    The [Dovecot Quotas feature][gh-pr::dms-feature::dovecot-quotas] is configured by enabling the [Dovecot `imap-quota` plugin][dovecot-docs::plugin::imap-quota] and using the [`count` quota backend][dovecot-docs::config::quota-backend-count].
-
-    ---
-
-    **Dovecot workaround for Postfix aliases**
-
-    When mail is delivered to DMS, Postfix will query Dovecot with the recipient(s) to verify quota has not been exceeded.
-
-    This allows early rejection of mail arriving to DMS, preventing a spammer from taking advantage of a [backscatter][wikipedia::backscatter] source if the mail was accepted by Postfix, only to later be rejected by Dovecot for storage when the quota limit was already reached.
-
-    However, Postfix does not resolve aliases until after the incoming mail is accepted.
-
-    1. Postfix queries Dovecot (_a [`check_policy_service` restriction tied to the Dovecot `quota-status` service][dms::workaround::dovecot-quotas::notes-1]_) with the recipient (_the alias_).
-    2. `dovecot: auth: passwd-file(alias@example.com): unknown user` is logged, Postfix is then informed that the recipient mailbox is not full even if it actually was (_since no such user exists in the Dovecot UserDB_).
-    3. However, when the real mailbox address that the alias would later resolve into does have a quota that exceeded the configured limit, Dovecot will refuse the mail delivery from Postfix which introduces a backscatter source for spammers.
-
-    As a [workaround to this problem with the `ENABLE_QUOTAS=1` feature][dms::workaround::dovecot-quotas::summary], DMS will add aliases as fake users into Dovecot UserDB (_that are configured with the same data as the real address the alias would resolve to, thus sharing the same mailbox location and quota limit_). This allows Postfix to properly be aware of an aliased mailbox having exceeded the allowed quota.
-
-    **NOTE:** This workaround **only supports** aliases to a single target recipient of a real account address / mailbox.
-
-    - Additionally, aliases that resolve to another alias or to an external address would both fail the UserDB lookup, unable to determine if enough storage is available.
-    - A proper fix would [implement a Postfix policy service][dms::workaround::dovecot-quotas::notes-2] that could correctly resolve aliases to valid entries in the Dovecot UserDB, querying the `quota-status` service and returning that response to Postfix.
-
-## Sub-addressing
-
-!!! info
-
-    [Subaddressing][wikipedia::subaddressing] (_aka **Plus Addressing** or **Address Tags**_) is a feature that allows you to receive mail to an address which includes a tag appended to the `local-part` of a valid account address.
-
-    - A subaddress has a tag delimiter (_default: `+`_), followed by the tag: `<local-part>+<tag>@<domain-part>`
-    - The subaddress `user+github@example.com` would deliver mail to the same mailbox as `user@example.com`.
-    - Tags are dynamic. Anything between the `+` and `@` is understood as the tag, no additional configuration required.
-    - Only the first occurence of the tag delimiter is recognized. Any additional occurences become part of the tag value itself.
-
-??? tip "When is subaddressing useful?"
-
-    A common use-case is to use a unique tag for each service you register your email address with.
-
-    - Routing delivery to different folders in your mailbox based on the tag (_via a [Sieve filter][docs::sieve::subaddressing]_).
-    - Data leaks or bulk sales of email addresses.
-        - If spam / phishing mail you receive has not removed the tag, you will have better insight into where your address was compromised from.
-        - When the expected tag is missing, this additionally helps identify bad actors. Especially when mail delivery is routed to subfolders by tag.
-    - For more use-cases, view the end of [this article][web::subaddress-use-cases].
-
-??? tip "Changing the tag delimiter"
-
-    Add `recipient_delimiter = +` to these config override files (_replacing `+` with your preferred delimiter_):
-
-    - Postfix: `docker-data/dms/config/postfix-main.cf`
-    - Dovecot: `docker-data/dms/config/dovecot.cf`
-
-??? tip "Opt-out of subaddressing"
-
-    Follow the advice to change the tag delimiter, but instead set an empty value (`recipient_delimiter =`).
-
-??? warning "Only for receiving, not sending"
-
-    Do not attempt to send mail from these tagged addresses, they are not equivalent to aliases.
-
-    This feature is only intended to be used when a mail client sends to a DMS managed recipient address. While DMS does not restrict the sender address you choose to send mail from (_provided `SPOOF_PROTECTION` has not been enabled_), it is often [forbidden by mail services][ms-exchange-docs::limitations].
-
-??? abstract "Technical Details"
-
-    The configured tag delimiter (`+`) allows both Postfix and Dovecot to recognize subaddresses. Without this feature configured, the subaddresses would be considered as separate mail accounts rather than routed to a common account address.
-
-    ---
-
-    Internally DMS has the tag delimiter configured by:
-
-    - Applying the Postfix `main.cf` setting: [`recipient_delimiter = +`][postfix-docs::recipient-delimiter]
-    - Dovecot has the equivalent setting set as `+` by default: [`recipient_delimiter = +`][dovecot-docs::config::recipient-delimiter]
-
-## Technical Overview
-
-!!! info
-
-    This section provides insight for understanding how Postfix and Dovecot services are involved. It is intended as a reference for maintainers and contributors.
-
-    - **Postfix** - Handles when mail is delivered (inbound) to DMS, or sent (outbound) from DMS.
-    - **Dovecot** - Manages access and storage for mail delivered to the DMS account mailboxes of your users.
-
-??? abstract "Technical Details - Postfix (Inbound vs Outbound)"
-
-    Postfix needs to know how to handle inbound and outbound mail by asking these queries:
-
-    === "Inbound"
-
-        - What mail domains is DMS responsible for handling? (_for accepting mail delivered_)
-        - What are valid mail addresses for those mail domains? (_reject delivery for users that don't exist_)
-        - Are there any aliases to redirect mail to 1 or more users, or forward to externally?
-
-    === "Outbound"
-
-        - When `SPOOF_PROTECTION=1`, how should DMS restrict the sender address? (_eg: Users may only send mail from their associated mailbox address_)
-
-??? abstract "Technical Details - Dovecot (Authentication)"
-
-    Dovecot additionally handles authenticating user accounts for sending and retrieving mail:
-
-    - Over the ports for IMAP and POP3 connections (_110, 143, 993, 995_).
-    - As the default configured SASL provider, which Postfix delegates user authentication through (_for the submission(s) ports 465 & 587_). Saslauthd can be configured as an alternative SASL provider.
-
-    Dovecot splits all authentication lookups into two categories:
-
-    - A [PassDB][dovecot::docs::passdb] lookup most importantly authenticates the user. It may also provide any other necessary pre-login information.
-    - A [UserDB][dovecot::docs::userdb] lookup retrieves post-login information specific to a user.
-
-[docs::env::account-provisioner]: ../environment.md#account_provisioner
-[docs::account-provisioner::file]: ./provisioner/file.md
-[docs::account-provisioner::ldap]: ./provisioner/ldap.md
-[docs::account-auth::oauth2]: ./supplementary/oauth2.md
-[docs::account-auth::master-accounts]: ./supplementary/master-accounts.md
-[docs::examples::auth-lua]: ../../examples/use-cases/auth-lua.md
-[email-syntax::valid-charset-format]: https://stackoverflow.com/questions/2049502/what-characters-are-allowed-in-an-email-address/2049510#2049510
-
-[postfix-docs::virtual-alias]: http://www.postfix.org/VIRTUAL_README.html#virtual_alias
-[postfix-docs::recipient-delimiter]: http://www.postfix.org/postconf.5.html#recipient_delimiter
-[dovecot-docs::config::recipient-delimiter]: https://doc.dovecot.org/settings/core/#core_setting-recipient_delimiter
-[postfix::delivery-agent::local]: https://www.postfix.org/local.8.html
-[postfix::delivery-agent::virtual]: https://www.postfix.org/virtual.8.html
-[postfix::config-table::local-alias]: https://www.postfix.org/aliases.5.html
-[postfix::config-table::virtual-alias]: https://www.postfix.org/virtual.5.html
-
-[docs::env::enable-quotas]: ../environment.md#enable_quotas
-[gh-issue::dms-feature-request::dovecot-quotas-ldap]: https://github.com/docker-mailserver/docker-mailserver/issues/2957
-[dovecot-docs::config::quota-backend-count]: https://doc.dovecot.org/configuration_manual/quota/quota_count/#quota-backend-count
-[dovecot-docs::plugin::imap-quota]: https://doc.dovecot.org/settings/plugin/imap-quota-plugin/
-[gh-pr::dms-feature::dovecot-quotas]: https://github.com/docker-mailserver/docker-mailserver/pull/1469
-[wikipedia::backscatter]: https://en.wikipedia.org/wiki/Backscatter_%28email%29
-[dms::workaround::dovecot-quotas::notes-1]: https://github.com/docker-mailserver/docker-mailserver/issues/2091#issuecomment-954298788
-[dms::workaround::dovecot-quotas::notes-2]: https://github.com/docker-mailserver/docker-mailserver/pull/2248#issuecomment-953754532
-[dms::workaround::dovecot-quotas::summary]: https://github.com/docker-mailserver/docker-mailserver/pull/2248#issuecomment-955088677
-
-[docs::sieve::subaddressing]: ../advanced/mail-sieve.md#subaddress-mailbox-routing
-[web::subaddress-use-cases]: https://www.codetwo.com/admins-blog/plus-addressing
-[wikipedia::subaddressing]: https://en.wikipedia.org/wiki/Email_address#Sub-addressing
-[ms-exchange-docs::limitations]: https://learn.microsoft.com/en-us/exchange/recipients-in-exchange-online/plus-addressing-in-exchange-online#using-plus-addresses
-
-[dovecot::docs::passdb]: https://doc.dovecot.org/configuration_manual/authentication/password_databases_passdb
-[dovecot::docs::userdb]: https://doc.dovecot.org/configuration_manual/authentication/user_databases_userdb

docs/content/config/account-management/provisioner/file.md

@@ -1,206 +0,0 @@
----
-title: 'Account Management | Provisioner (File)'
----
-
-# Provisioner - File
-
-## Management via the `setup` CLI
-
-The best way to manage DMS accounts and related config files is through our `setup` CLI provided within the container.
-
-!!! example "Using the `setup` CLI"
-
-    Try the following within the DMS container (`docker exec -it <CONTAINER NAME> bash`):
-
-    - Add an account: `setup email add <EMAIL ADDRESS>`
-    - Add an alias: `setup alias add <FROM ALIAS> <TO TARGET ADDRESS>`
-    - Learn more about the available subcommands via: `setup help`
-
-    ```bash
-    # Starts a basic DMS instance and then shells into the container to use the `setup` CLI:
-    docker run --rm -itd --name dms --hostname mail.example.com mailserver/docker-mailserver
-    docker exec -it dms bash
-
-    # Create an account:
-    setup email add hello@example.com your-password-here
-
-    # Create an alias:
-    setup alias add your-alias-here@example.com hello@example.com
-
-    # Limit the mailbox capacity to 10 MiB:
-    setup quota set hello@example.com 10M
-    ```
-
-    ??? tip "Secure password input"
-
-        When you don't provide a password to the command, you will be prompted for one. This avoids the password being captured in your shell history.
-
-        ```bash
-        # As you input your password it will not update.
-        # Press the ENTER key to apply the hidden password input.
-        $ setup email add hello@example.com
-        Enter Password:
-        Confirm Password:
-        ```
-
-!!! note "Account removal via `setup email del`"
-
-    When you remove a DMS account with this command, it will also remove any associated aliases and quota.
-
-    The command will also prompt for deleting the account mailbox from disk, or can be forced with the `-y` flag.
-
-## Config Reference
-
-These config files belong to the [Config Volume][docs::volumes::config].
-
-### Accounts
-
-!!! info
-
-    **Config file:** `docker-data/dms/config/postfix-accounts.cf`
-
-    ---
-
-    The config format is line-based with two fields separated by the delimiter `|`:
-
-    - **User:** The primary email address for the account mailbox to use.
-    - **Password:** A SHA512-CRYPT hash of the account password (_in this example it is `secret`_).
-
-    ??? tip "Password hash without the `setup email add` command"
-
-        A compatible password hash can be generated with:
-
-        ```bash
-        doveadm pw -s SHA512-CRYPT -u hello@example.com -p secret
-        ```
-
-!!! example "`postfix-accounts.cf` config file"
-
-    In this example DMS manages mail for the domain `example.com`:
-
-    ```cf title="postfix-accounts.cf"
-    hello@example.com|{SHA512-CRYPT}$6$W4rxRQwI6HNMt9n3$riCi5/OqUxnU8eZsOlZwoCnrNgu1gBGPkJc.ER.LhJCu7sOg9i1kBrRIistlBIp938GdBgMlYuoXYUU5A4Qiv0
-    ```
-
-    ---
-
-    **Dovecot "extra fields"**
-
-    [Appending a third column will customize "extra fields"][gh-issue::provisioner-file::accounts-extra-fields] when converting account data into a Dovecot UserDB entry.
-
-    DMS is not aware of these customizations beyond carrying them over, expect potential for bugs when this feature breaks any assumed conventions used in the scripts (_such as changing the mailbox path or type_).
-
-!!! note
-
-    Account creation will normalize the provided email address to lowercase, as DMS does not support multiple case-sensitive address variants.
-
-    The email address chosen will also represent the _login username_ credential for mail clients to authenticate with.
-
-### Aliases
-
-!!! info
-
-    **Config file:** `docker-data/dms/config/postfix-virtual.cf`
-
-    ---
-
-    The config format is line-based with key value pairs (**alias** --> **target address**), with white-space as a delimiter.
-
-!!! example "`postfix-virtual.cf` config file"
-
-    In this example DMS manages mail for the domain `example.com`:
-
-    ```cf-extra title="postfix-virtual.cf"
-    # Alias delivers to an existing account:
-    alias1@example.com hello@example.com
-
-    # Alias forwards to an external email address:
-    alias2@example.com external-account@gmail.com
-    ```
-
-??? warning "Known Issues"
-
-    **`setup` CLI prevents an alias and account sharing an address:**
-
-    You cannot presently add a new account (`setup email add`) or alias (`setup alias add`) with an address which already exists as an alias or account in DMS.
-
-    This [restriction was enforced][gh-issue::bugs::account-alias-overlap] due to [problems it could cause][gh-issue::bugs::account-alias-overlap-problem], although there are [use-cases where you may legitimately require this functionality][gh-issue::feature-request::allow-account-alias-overlap].
-
-    For now you must manually edit the `postfix-virtual.cf` file as a workaround. There are no run-time checks outside of the `setup` CLI related to this restriction.
-
-    ---
-
-    **Wildcard catch-all support (`@example.com`):**
-
-    While this type of alias without a local-part is supported, you must keep in mind that aliases in Postfix have a higher precedence than a real address associated to a DMS account.
-
-    As a result, the wildcard is matched first and will direct mail for that entire domain to the alias target address. To work around this, [you will need an alias for each non-alias address of that domain][gh-issue::bugs::wildcard-catchall].
-
-    Additionally, Postfix will read the alias config and choose the alias value that matches the recipient address first. Ensure your more specific aliases for the domain are declared above the wildcard alias in the config file.
-
-    ---
-
-    **Aliasing to another alias or multiple recipients:**
-
-    [While aliasing to multiple recipients is possible][gh-discussions::no-support::alias-multiple-targets], DMS does not officially support that.
-
-    - You may experience issues when our feature integrations don't expect more than one target per alias.
-    - These concerns also apply to the usage of nested aliases (_where the recipient target provided is to an alias instead of a real address_). An example is the [incompatibility with `setup alias add`][gh-issue::bugs::alias-nested].
-
-#### Configuring RegEx aliases
-
-!!! info
-
-    **Config file:** `docker-data/dms/config/postfix-regexp.cf`
-
-    ---
-
-    This config file is similar to the above `postfix-virtual.cf`, but the alias value is instead configured with a regex pattern.
-
-    There is **no `setup` CLI support** for this feature, it is config only.
-
-!!! example "`postfix-regexp.cf` config file"
-
-    Deliver all mail for `test` users to `qa@example.com` instead:
-
-    ```cf-extra title="postfix-regexp.cf"
-    # Remember to escape regex tokens like `.` => `\.`, otherwise
-    # your alias pattern may be more permissive than you intended:
-    /^test[0-9][0-9]*@example\.com/ qa@example.com
-    ```
-
-??? abstract "Technical Details"
-
-    `postfix-virtual.cf` has precedence, `postfix-regexp.cf` will only be checked if no alias match was found in `postfix-virtual.cf`.
-
-    These files are both copied internally to `/etc/postfix/` and configured in `main.cf` for the `virtual_alias_maps` setting. As `postfix-virtual.cf` is declared first for that setting, it will be processed before using `postfix-regexp.cf` as a fallback.
-
-### Quotas
-
-!!! info
-
-    **Config file:** `docker-data/dms/config/dovecot-quotas.cf`
-
-    ----
-
-    The config format is line-based with two fields separated by the delimiter `:`:
-
-    - **Dovecot UserDB account:** The user DMS account. It should have a matching field in `postfix-accounts.cf`.
-    - **Quota limit:** Expressed in bytes (_binary unit suffix is supported: `M` => `MiB`, `G` => `GiB`_).
-
-!!! example "`dovecot-quotas.cf` config file"
-
-    For the account with the mailbox address of `hello@example.com`, it may not exceed 5 GiB in storage:
-
-    ```cf-extra title="dovecot-quotas.cf"
-    hello@example.com:5G
-    ```
-
-[docs::volumes::config]: ../../advanced/optional-config.md#volumes-config
-[gh-issue::provisioner-file::accounts-extra-fields]: https://github.com/docker-mailserver/docker-mailserver/issues/4117
-[gh-issue::feature-request::allow-account-alias-overlap]: https://github.com/docker-mailserver/docker-mailserver/issues/3528
-[gh-issue::bugs::account-alias-overlap-problem]: https://github.com/docker-mailserver/docker-mailserver/issues/3350#issuecomment-1550528898
-[gh-issue::bugs::account-alias-overlap]: https://github.com/docker-mailserver/docker-mailserver/issues/3022#issuecomment-1807816689
-[gh-issue::bugs::wildcard-catchall]: https://github.com/docker-mailserver/docker-mailserver/issues/3022#issuecomment-1610452561
-[gh-issue::bugs::alias-nested]: https://github.com/docker-mailserver/docker-mailserver/issues/3622#issuecomment-1794504849
-[gh-discussions::no-support::alias-multiple-targets]: https://github.com/orgs/docker-mailserver/discussions/3805#discussioncomment-8215417

docs/content/config/account-management/supplementary/master-accounts.md

@@ -1,70 +0,0 @@
----
-title: 'Account Management | Master Accounts (Dovecot)'
-hide:
-  - toc # Hide Table of Contents for this page
----
-
-This feature is useful for administrative tasks like hot backups.
-
-!!! note
-
-    This feature is presently [not supported with `ACCOUNT_PROVISIONER=LDAP`][dms::feature::dovecot-master-accounts::caveat-ldap].
-
-!!! info
-
-    A _Master Account_:
-
-    - Can login as any user (DMS account) and access their mailbox.
-    - Is not associated to a separate DMS account, nor is it a DMS account itself.
-
-    ---
-
-    **`setup` CLI support**
-
-    Use the `setup dovecot-master <add|update|del|list>` commands. These are roughly equivalent to the `setup email` subcommands.
-
-    ---
-
-    **Config file:** `docker-data/dms/config/dovecot-masters.cf`
-
-    The config format is the same as [`postfix-accounts.cf` for `ACCOUNT_PROVISIONER=FILE`][docs::account-management::file::accounts].
-
-    The only difference is the account field has no `@domain-part` suffix, it is only a username.
-
-??? abstract "Technical Details"
-
-    [The _Master Accounts_ feature][dms::feature::dovecot-master-accounts] in DMS configures the [Dovecot Master Users][dovecot-docs::auth::master-users] feature with the Dovecot setting [`auth_master_user_separator`][dovecot-docs::config::auth-master-user-separator] (_where the default value is `*`_).
-
-## Login via Master Account
-
-!!! info
-
-    To login as another DMS account (`user@example.com`) with POP3 or IMAP, use the following credentials format:
-
-    - Username: `<LOGIN USERNAME>*<MASTER USER>` (`user@example.com*admin`)
-    - Password: `<MASTER PASSWORD>`
-
-!!! example "Verify login functionality"
-
-    In the DMS container, you can verify with the `testsaslauthd` command:
-
-    ```bash
-    # Prerequisites:
-    # A regular DMS account to test login through a Master Account:
-    setup email add user@example.com secret
-    # Add a new Master Account:
-    setup dovecot-master add admin top-secret
-    ```
-
-    ```bash
-    # Login with credentials format as described earlier:
-    testsaslauthd -u 'user@example.com*admin' -p 'top-secret'
-    ```
-
-    Alternatively, any mail client should be able to login the equivalent credentials.
-
-[dms::feature::dovecot-master-accounts]: https://github.com/docker-mailserver/docker-mailserver/pull/2535
-[dms::feature::dovecot-master-accounts::caveat-ldap]: https://github.com/docker-mailserver/docker-mailserver/pull/2535#issuecomment-1118056745
-[dovecot-docs::auth::master-users]: https://doc.dovecot.org/configuration_manual/authentication/master_users/
-[dovecot-docs::config::auth-master-user-separator]: https://doc.dovecot.org/settings/core/#core_setting-auth_master_user_separator
-[docs::account-management::file::accounts]: ../provisioner/file.md#accounts

docs/content/config/account-management/supplementary/oauth2.md

@@ -1,145 +0,0 @@
----
-title: 'Account Management | OAuth2 Support'
-hide:
-  - toc # Hide Table of Contents for this page
----
-
-# Authentication - OAuth2 / OIDC
-
-This feature enables support for delegating DMS account authentication through to an external _Identity Provider_ (IdP).
-
-!!! warning "Receiving mail requires a DMS account to exist"
-
-    If you expect DMS to receive mail, you must provision an account into DMS in advance. Otherwise DMS has no awareness of your externally manmaged users and will reject delivery.
-
-    There are [plans to implement support to provision users through a SCIM 2.0 API][dms-feature-request::scim-api]. An IdP that can operate as a SCIM Client (eg: Authentik) would then integrate with DMS for user provisioning. Until then you must keep your user accounts in sync manually via your configured [`ACCOUNT_PROVISIONER`][docs::env::account-provisioner].
-
-??? info "How the feature works"
-
-    1. A **mail client must have support** to acquire an OAuth2 token from your IdP (_however many clients lack generic OAuth2 / OIDC provider support_).
-    2. The mail client then provides that token as the user password via the login mechanism `XOAUTH2` or `OAUTHBEARER`.
-    3. DMS (Dovecot) will then check the validity of that token against the Authentication Service it was configured with.
-    4. If the response returned is valid for the user account, authentication is successful.
-
-    [**XOAUTH2**][google::xoauth2-docs] (_Googles widely adopted implementation_) and **OAUTHBEARER** (_the newer variant standardized by [RFC 7628][rfc::7628] in 2015_) are supported as standards for verifying that a OAuth Bearer Token (_[RFC 6750][rfc::6750] from 2012_) is valid at the identity provider that created the token. The token itself in both cases is expected to be can an opaque _Access Token_, but it is possible to use a JWT _ID Token_ (_which encodes additional information into the token itself_).
-
-    A mail client like Thunderbird has limited OAuth2 / OIDC support. The software maintains a hard-coded list of providers supported. Roundcube is a webmail client that does have support for generic providers, allowing you to integrate with a broader range of IdP services.
-
-    ---
-
-    **Documentation for this feature is WIP**
-
-    See the [initial feature support][dms-feature::oauth2-pr] and [existing issues][dms-feature::oidc-issues] for guidance that has not yet been documented officially.
-
-??? tip "Verify authentication works"
-
-    If you have a compatible mail client you can verify login through that.
-
-    ---
-
-    ??? example "CLI - Verify with `curl`"
-
-        ```bash
-        # Shell into your DMS container:
-        docker exec -it dms bash
-
-        # Adjust these variables for the methods below to use:
-        export AUTH_METHOD='OAUTHBEARER' USER_ACCOUNT='hello@example.com' ACCESS_TOKEN='DMS_YWNjZXNzX3Rva2Vu'
-
-        # Authenticate via IMAP (Dovecot):
-        curl --silent --url 'imap://localhost:143' \
-            --login-options "AUTH=${AUTH_METHOD}" --user "${USER_ACCOUNT}" --oauth2-bearer "${ACCESS_TOKEN}" \
-            --request 'LOGOUT' \
-            && grep "dovecot: imap-login: Login: user=<${USER_ACCOUNT}>, method=${AUTH_METHOD}" /var/log/mail/mail.log
-
-        # Authenticate via SMTP (Postfix), sending a mail with the same sender(from) and recipient(to) address:
-        # NOTE: `curl` seems to require `--upload-file` with some mail content provided to test SMTP auth.
-        curl --silent --url 'smtp://localhost:587' \
-            --login-options "AUTH=${AUTH_METHOD}" --user "${USER_ACCOUNT}" --oauth2-bearer "${ACCESS_TOKEN}" \
-            --mail-from "${USER_ACCOUNT}" --mail-rcpt "${USER_ACCOUNT}" --upload-file - <<< 'RFC 5322 content - not important' \
-            && grep "postfix/submission/smtpd.*, sasl_method=${AUTH_METHOD}, sasl_username=${USER_ACCOUNT}" /var/log/mail/mail.log
-        ```
-
-        ---
-
-        **Troubleshooting:**
-
-        - Add `--verbose` to the curl options. This will output the protocol exchange which includes if authentication was successful or failed.
-        - The above example chains the `curl` commands with `grep` on DMS logs (_for Dovecot and Postfix services_). When not running `curl` from the DMS container, ensure you check the logs correctly, or inspect the `--verbose` output instead.
-
-    !!! warning "`curl` bug with `XOAUTH2`"
-
-        [Older releases of `curl` have a bug with `XOAUTH2` support][gh-issue::curl::xoauth2-bug] since `7.80.0` (Nov 2021) but fixed from `8.6.0` (Jan 2024). It treats `XOAUTH2` as `OAUTHBEARER`.
-
-        If you use `docker exec` to run `curl` from within DMS, the current DMS v14 release (_Debian 12 with curl `7.88.1`_) is affected by this bug.
-
-## Config Examples
-
-### Authentik with Roundcube
-
-This example assumes you have already set up:
-
-- A working DMS server
-- An Authentik server ([documentation][authentik::docs::install])
-- A Roundcube server ([docker image][roundcube::dockerhub-image] or [bare metal install][roundcube::docs::install])
-
-!!! example "Setup Instructions"
-
-    === "1. Docker Mailserver"
-
-        Update your Docker Compose ENV config to include:
-
-        ```env title="compose.yaml"
-        services:
-          mailserver:
-            env:
-              # Enable the feature:
-              - ENABLE_OAUTH2=1
-              # Specify the user info endpoint URL of the oauth2 server for token inspection:
-              - OAUTH2_INTROSPECTION_URL=https://authentik.example.com/application/o/userinfo/
-        ```
-
-    === "2. Authentik"
-
-        1. Create a new OAuth2 provider.
-        2. Note the client id and client secret. Roundcube will need this.
-        3. Set the allowed redirect url to the equivalent of `https://roundcube.example.com/index.php/login/oauth` for your RoundCube instance.
-
-    === "3. Roundcube"
-
-        Add the following to `oauth2.inc.php` ([documentation][roundcube::docs::config]):
-
-        ```php
-        $config['oauth_provider'] = 'generic';
-        $config['oauth_provider_name'] = 'Authentik';
-        $config['oauth_client_id'] = '<insert client id here>';
-        $config['oauth_client_secret'] = '<insert client secret here>';
-        $config['oauth_auth_uri'] = 'https://authentik.example.com/application/o/authorize/';
-        $config['oauth_token_uri'] = 'https://authentik.example.com/application/o/token/';
-        $config['oauth_identity_uri'] = 'https://authentik.example.com/application/o/userinfo/';
-
-        // Optional: disable SSL certificate check on HTTP requests to OAuth server. For possible values, see:
-        // http://docs.guzzlephp.org/en/stable/request-options.html#verify
-        $config['oauth_verify_peer'] = false;
-
-        $config['oauth_scope'] = 'email openid profile';
-        $config['oauth_identity_fields'] = ['email'];
-
-        // Boolean: automatically redirect to OAuth login when opening Roundcube without a valid session
-        $config['oauth_login_redirect'] = false;
-        ```
-
-[dms-feature::oauth2-pr]: https://github.com/docker-mailserver/docker-mailserver/pull/3480
-[dms-feature::oidc-issues]: https://github.com/docker-mailserver/docker-mailserver/issues?q=label%3Afeature%2Fauth-oidc
-[docs::env::account-provisioner]: ../../environment.md#account_provisioner
-[dms-feature-request::scim-api]: https://github.com/docker-mailserver/docker-mailserver/issues/4090
-
-[google::xoauth2-docs]: https://developers.google.com/gmail/imap/xoauth2-protocol#the_sasl_xoauth2_mechanism
-[rfc::6750]: https://datatracker.ietf.org/doc/html/rfc6750
-[rfc::7628]: https://datatracker.ietf.org/doc/html/rfc7628
-[gh-issue::curl::xoauth2-bug]: https://github.com/curl/curl/issues/10259#issuecomment-1907192556
-
-[authentik::docs::install]: https://goauthentik.io/docs/installation/
-[roundcube::dockerhub-image]: https://hub.docker.com/r/roundcube/roundcubemail
-[roundcube::docs::install]: https://github.com/roundcube/roundcubemail/wiki/Installation
-[roundcube::docs::config]: https://github.com/roundcube/roundcubemail/wiki/Configuration

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

@@ -1,10 +1,10 @@
 ---
-title: 'Account Management | Provisioner (LDAP)'
+title: 'Advanced | LDAP Authentication'
 ---
 
 ## Introduction
 
-Getting started with ldap and DMS we need to take 3 parts in account:
+Getting started with ldap and `docker-mailserver` we need to take 3 parts in account:
 
 - `postfix` for incoming & outgoing email
 - `dovecot` for accessing mailboxes
@@ -26,7 +26,7 @@ Those variables contain the LDAP lookup filters for postfix, using `%s` as the p
     - Technically, there is no difference between `ALIAS` and `GROUP`, but ideally you should use `ALIAS` for personal aliases for a singular person (like `ceo@example.org`) and `GROUP` for multiple people (like `hr@example.org`).
 - ...for outgoing email, the sender address is put through the `SENDERS` filter, and only if the authenticated user is one of the returned entries, the email can be sent.
     - This only applies if `SPOOF_PROTECTION=1`.
-    - If the `SENDERS` filter is missing, the `USER`, `ALIAS` and `GROUP` filters will be used in a disjunction (OR).
+    - If the `SENDERS` filter is missing, the `USER`, `ALIAS` and `GROUP` filters will be used in in a disjunction (OR).
     - To for example allow users from the `admin` group to spoof any sender email address, and to force everyone else to only use their personal mailbox address for outgoing email, you can use something like this: `(|(memberOf=cn=admin,*)(mail=%s))`
 
 ???+ example
@@ -34,14 +34,13 @@ Those variables contain the LDAP lookup filters for postfix, using `%s` as the p
     A really simple `LDAP_QUERY_FILTER` configuration, using only the _user filter_ and allowing only `admin@*` to spoof any sender addresses.
 
     ```yaml
-    - LDAP_START_TLS=yes
-    - ACCOUNT_PROVISIONER=LDAP
+    - ENABLE_LDAP=1
     - LDAP_SERVER_HOST=ldap.example.org
     - LDAP_SEARCH_BASE=dc=example,dc=org"
     - LDAP_BIND_DN=cn=admin,dc=example,dc=org
     - LDAP_BIND_PW=mypassword
     - SPOOF_PROTECTION=1
-
+    
     - LDAP_QUERY_FILTER_DOMAIN=(mail=*@%s)
     - LDAP_QUERY_FILTER_USER=(mail=%s)
     - LDAP_QUERY_FILTER_ALIAS=(|) # doesn't match anything
@@ -56,7 +55,7 @@ These variables specify the LDAP filters that dovecot uses to determine if a use
 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).
+- `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 behaviour 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:
 
@@ -97,7 +96,7 @@ Set this to `yes` to enable authentication binds ([more details in the dovecot d
 
 ### `SASLAUTHD_LDAP_FILTER`
 
-This filter is used for `saslauthd`, which is called by postfix when someone is authenticating through SMTP (assuming that `SASLAUTHD_MECHANISMS=ldap` is being used). Note that you'll need to set up the LDAP server for saslauthd separately from postfix.
+This filter is used for `saslauthd`, which is called by postfix when someone is authenticating through SMTP (assuming that `SASLAUTHD_MECHANISMS=ldap` is being used). Note that you'll need to set up the LDAP server for saslauthd seperately from postfix.
 
 The filter variables are explained in detail [in the `LDAP_SASLAUTHD` file](https://github.com/winlibs/cyrus-sasl/blob/master/saslauthd/LDAP_SASLAUTHD#L121), but unfortunately, this method doesn't really support domains right now - that means that `%U` is the only token that makes sense in this variable.
 
@@ -129,7 +128,7 @@ To enable LDAP over StartTLS (on port 389), you need to set the following enviro
 
 ## Active Directory Configurations (Tested with Samba4 AD Implementation)
 
-In addition to LDAP explanation above, when Docker Mailserver is intended to be used with Active Directory (or the equivalent implementations like Samba4 AD DC) the following points should be taken into consideration:
+In addition to LDAP explanation above, when Docker Mailserver is intended to be used with Active Directory (or the equivelant implementations like Samba4 AD DC) the following points should be taken into consideration:
 
 - Samba4 Active Directory requires a **secure connection** to the domain controller (DC), either via SSL/TLS (LDAPS) or via StartTLS.
 - The username equivalent in Active Directory is: `sAMAccountName`.
@@ -139,7 +138,7 @@ In addition to LDAP explanation above, when Docker Mailserver is intended to be
 
 The configuration shown to get the Group to work is from [here](https://doc.zarafa.com/trunk/Administrator_Manual/en-US/html/_MTAIntegration.html) and [here](https://kb.kopano.io/display/WIKI/Postfix).
 
-```bash
+```
 # user-patches.sh
 
 ...
@@ -150,7 +149,7 @@ grep -q '^special_result_attribute = member$' /etc/postfix/ldap-groups.cf || ech
 
 - In `/etc/ldap/ldap.conf`, if the `TLS_REQCERT` is `demand` / `hard` (default), the CA certificate used to verify the LDAP server certificate must be recognized as a trusted CA. This can be done by volume mounting the `ca.crt` file and updating the trust store via a `user-patches.sh` script:
 
-```bash
+```
 # user-patches.sh
 
 ...
@@ -161,7 +160,7 @@ update-ca-certificates
 
 The changes on the configurations necessary to work with Active Directory (**only changes are listed, the rest of the LDAP configuration can be taken from the other examples** shown in this documentation):
 
-```yaml
+```
 # If StartTLS is the chosen method to establish a secure connection with Active Directory.
 - LDAP_START_TLS=yes
 - SASLAUTHD_LDAP_START_TLS=yes
@@ -188,11 +187,13 @@ The changes on the configurations necessary to work with Active Directory (**onl
 ???+ example "Basic Setup"
 
     ```yaml
+    version: '3.8'
     services:
       mailserver:
-        image: ghcr.io/docker-mailserver/docker-mailserver:latest
+        image: docker.io/mailserver/docker-mailserver:latest
         container_name: mailserver
-        hostname: mail.example.com
+        hostname: mail
+        domainname: example.com
 
         ports:
           - "25:25"
@@ -214,7 +215,7 @@ The changes on the configurations necessary to work with Active Directory (**onl
           - ENABLE_POSTGREY=1
 
           # >>> Postfix LDAP Integration
-          - ACCOUNT_PROVISIONER=LDAP
+          - ENABLE_LDAP=1
           - LDAP_SERVER_HOST=ldap.example.org
           - LDAP_BIND_DN=cn=admin,ou=users,dc=example,dc=org
           - LDAP_BIND_PW=mypassword
@@ -239,6 +240,8 @@ The changes on the configurations necessary to work with Active Directory (**onl
           - SASLAUTHD_LDAP_FILTER=(&(mail=%U@example.org)(objectClass=inetOrgPerson))
           # <<< SASL LDAP Authentication
 
+          - ONE_DIR=1
+          - DMS_DEBUG=0
           - SSL_TYPE=letsencrypt
           - PERMIT_DOCKER=host
 
@@ -249,11 +252,14 @@ The changes on the configurations necessary to work with Active Directory (**onl
 ??? example "Kopano / Zarafa"
 
     ```yaml
+    version: '3.8'
+
     services:
       mailserver:
-        image: ghcr.io/docker-mailserver/docker-mailserver:latest
+        image: docker.io/mailserver/docker-mailserver:latest
         container_name: mailserver
-        hostname: mail.example.com
+        hostname: mail
+        domainname: example.com
 
         ports:
           - "25:25"
@@ -282,7 +288,7 @@ The changes on the configurations necessary to work with Active Directory (**onl
           # <<< SASL Authentication
 
           # >>> Postfix Ldap Integration
-          - ACCOUNT_PROVISIONER=LDAP
+          - ENABLE_LDAP=1
           - LDAP_SERVER_HOST=<yourLdapContainer/yourLdapServer>
           - LDAP_SEARCH_BASE=dc=mydomain,dc=loc
           - LDAP_BIND_DN=cn=Administrator,cn=Users,dc=mydomain,dc=loc
@@ -294,9 +300,12 @@ The changes on the configurations necessary to work with Active Directory (**onl
           # <<< Postfix Ldap Integration
 
           # >>> Kopano Integration
+          - ENABLE_POSTFIX_VIRTUAL_TRANSPORT=1
           - POSTFIX_DAGENT=lmtp:kopano:2003
           # <<< Kopano Integration
 
+          - ONE_DIR=1
+          - DMS_DEBUG=0
           - SSL_TYPE=letsencrypt
           - PERMIT_DOCKER=host
 
@@ -304,5 +313,5 @@ The changes on the configurations necessary to work with Active Directory (**onl
           - NET_ADMIN
     ```
 
-[docs-environment]: ../../environment.md
-[docs-userpatches]: ../../advanced/override-defaults/user-patches.md
+[docs-environment]: ../environment.md
+[docs-userpatches]: ./override-defaults/user-patches.md

docs/content/config/advanced/full-text-search.md

@@ -6,7 +6,7 @@ title: 'Advanced | Full-Text Search'
 
 Full-text search allows all messages to be indexed, so that mail clients can quickly and efficiently search messages by their full text content. Dovecot supports a variety of community supported [FTS indexing backends](https://doc.dovecot.org/configuration_manual/fts/).
 
-DMS comes pre-installed with two plugins that can be enabled with a dovecot config file.
+`docker-mailserver` comes pre-installed with two plugins that can be enabled with a dovecot config file.
 
 Please be aware that indexing consumes memory and takes up additional disk space.
 
@@ -16,7 +16,7 @@ The [dovecot-fts-xapian](https://github.com/grosjo/fts-xapian) plugin makes use
 
 The indexes will be stored as a subfolder named `xapian-indexes` inside your local `mail-data` folder (_`/var/mail` internally_). With the default settings, 10GB of email data may generate around 4GB of indexed data.
 
-While indexing is memory intensive, you can configure the plugin to limit the amount of memory consumed by the index workers. With Xapian being small and fast, this plugin is a good choice for low memory environments (2GB).
+While indexing is memory intensive, you can configure the plugin to limit the amount of memory consumed by the index workers. With Xapian being small and fast, this plugin is a good choice for low memory environments (2GB) as compared to Solr.
 
 #### Setup
 
@@ -55,14 +55,16 @@ While indexing is memory intensive, you can configure the plugin to limit the am
 
     adjust the settings to tune for your desired memory limits, exclude folders and enable searching text inside of attachments
 
-2. Update `compose.yaml` to load the previously created dovecot plugin config file:
+2. Update `docker-compose.yml` to load the previously created dovecot plugin config file:
 
     ```yaml
+      version: '3.8'
       services:
         mailserver:
-          image: ghcr.io/docker-mailserver/docker-mailserver:latest
+          image: docker.io/mailserver/docker-mailserver:latest
           container_name: mailserver
-          hostname: mail.example.com
+          hostname: mail
+          domainname: example.com
           env_file: mailserver.env
           ports:
             - "25:25"    # SMTP  (explicit TLS => STARTTLS)
@@ -81,64 +83,74 @@ While indexing is memory intensive, you can configure the plugin to limit the am
           stop_grace_period: 1m
           cap_add:
             - NET_ADMIN
+            - SYS_PTRACE
     ```
 
 3. Recreate containers:
 
     ```
-    docker compose down
-    docker compose up -d
+    docker-compose down
+    docker-compose up -d
     ```
 
 4. Initialize indexing on all users for all mail:
 
     ```
-    docker compose exec mailserver doveadm index -A -q \*
+    docker-compose exec mailserver doveadm index -A -q \*
     ```
 
 5. Run the following command in a daily cron job:
 
     ```
-    docker compose exec mailserver doveadm fts optimize -A
-    ```
-    Or like the [Spamassassin example][docs-faq-sa-learn-cron] shows, you can instead use `cron` from within DMS to avoid potential errors if the mail server is not running:
-
-??? example
-
-    Create a _system_ cron file:
-
-    ```sh
-    # in the compose.yaml root directory
-    mkdir -p ./docker-data/dms/cron # if you didn't have this folder before
-    touch ./docker-data/dms/cron/fts_xapian
-    chown root:root ./docker-data/dms/cron/fts_xapian
-    chmod 0644 ./docker-data/dms/cron/fts_xapian
+    docker-compose exec mailserver doveadm fts optimize -A
     ```
 
-    Edit the system cron file `nano ./docker-data/dms/cron/fts_xapian`, and set an appropriate configuration:
+### Solr
 
-    ```conf
-    # Adding `MAILTO=""` prevents cron emailing notifications of the task outcome each run
-    MAILTO=""
-    #
-    # m h dom mon dow user command
-    #
-    # Everyday 4:00AM, optimize index files
-    0  4 * * * root  doveadm fts optimize -A
-    ```
+The [dovecot-solr Plugin](https://wiki2.dovecot.org/Plugins/FTS/Solr) is used in conjunction with [Apache Solr](https://lucene.apache.org/solr/) running in a separate container. This is quite straightforward to setup using the following instructions.
 
-    Then with `compose.yaml`:
+Solr is a mature and fast indexing backend that runs on the JVM. The indexes are relatively compact compared to the size of your total email. 
+
+However, Solr also requires a fair bit of RAM. While Solr is [highly tuneable](https://solr.apache.org/guide/7_0/query-settings-in-solrconfig.html), it may require a bit of testing to get it right.
+
+#### Setup
+
+1. `docker-compose.yml`:
 
     ```yaml
-    services:
-      mailserver:
-        image: ghcr.io/docker-mailserver/docker-mailserver:latest
+      solr:
+        image: lmmdock/dovecot-solr:latest
         volumes:
-          - ./docker-data/dms/cron/fts_xapian:/etc/cron.d/fts_xapian
+          - ./docker-data/dms/config/dovecot/solr-dovecot:/opt/solr/server/solr/dovecot
+        restart: always
+
+      mailserver:
+        depends_on:
+          - solr
+        image: docker.io/mailserver/docker-mailserver:latest
+        ...
+        volumes:
+          ...
+          - ./docker-data/dms/config/dovecot/10-plugin.conf:/etc/dovecot/conf.d/10-plugin.conf:ro
+        ...
     ```
 
+2. `./docker-data/dms/config/dovecot/10-plugin.conf`:
+
+    ```conf
+    mail_plugins = $mail_plugins fts fts_solr
+
+    plugin {
+      fts = solr
+      fts_autoindex = yes
+      fts_solr = url=http://solr:8983/solr/dovecot/
+    }
+    ```
+
+3. Recreate containers: `docker-compose down ; docker-compose up -d`
+
+4. Flag all user mailbox FTS indexes as invalid, so they are rescanned on demand when they are next searched: `docker-compose exec mailserver doveadm fts rescan -A`
+
 #### Further Discussion
 
 See [#905](https://github.com/docker-mailserver/docker-mailserver/issues/905)
-
-[docs-faq-sa-learn-cron]: ../../faq.md#how-can-i-make-spamassassin-better-recognize-spam

docs/content/config/advanced/ipv6.md

@@ -2,216 +2,47 @@
 title: 'Advanced | IPv6'
 ---
 
-!!! bug "Ample Opportunities for Issues"
+## Background
 
-    Numerous bug reports have been raised in the past about IPv6. Please make sure your setup around DMS is correct when using IPv6!
+If your container host supports IPv6, then `docker-mailserver` will automatically accept IPv6 connections by way of the docker host's IPv6. However, incoming mail will fail SPF checks because they will appear to come from the IPv4 gateway that docker is using to proxy the IPv6 connection (`172.20.0.1` is the gateway).
 
-## IPv6 networking problems with Docker defaults
+This can be solved by supporting IPv6 connections all the way to the `docker-mailserver` container.
 
-### What can go wrong?
+## Setup steps
 
-If your host system supports IPv6 and an `AAAA` DNS record exists to direct IPv6 traffic to DMS, you may experience issues when an IPv6 connection is made:
+```diff
++++ b/serv/docker-compose.yml
+@@ -1,4 +1,4 @@
+-version: '2'
++version: '2.1'
 
-- The original client IP is replaced with the gateway IP of a docker network.
-- Connections fail or hang.
+@@ -32,6 +32,16 @@ services:
 
-The impact of losing the real IP of the client connection can negatively affect DMS:
++  ipv6nat:
++    image: robbertkl/ipv6nat
++    restart: always
++    network_mode: "host"
++    cap_add:
++      - NET_ADMIN
++      - SYS_MODULE
++    volumes:
++      - /var/run/docker.sock:/var/run/docker.sock:ro
++      - /lib/modules:/lib/modules:ro
 
-- Users unable to login (_Fail2Ban action triggered by repeated login failures all seen as from the same internal Gateway IP_)
-- Mail inbound to DMS is rejected (_[SPF verification failure][gh-issue-1438-spf], IP mismatch_)
-- Delivery failures from [sender reputation][sender-score] being reduced (_due to [bouncing inbound mail][gh-issue-3057-bounce] from rejected IPv6 clients_)
-- Some services may be configured to trust connecting clients within the containers subnet, which includes the Gateway IP. This can risk bypassing or relaxing security measures, such as exposing an [open relay][wikipedia-openrelay].
+@@ -306,4 +316,13 @@ networks:
 
-### Why does this happen?
-
-When the host network receives a connection to a containers published port, it is routed to the containers internal network managed by Docker (_typically a bridge network_).
-
-By default, the Docker daemon only assigns IPv4 addresses to containers, thus it will only accept IPv4 connections (_unless a `docker-proxy` process is listening, which the default daemon setting `userland-proxy: true` enables_). With the daemon setting `userland-proxy: true` (default), IPv6 connections from the host can also be accepted and routed to containers (_even when they only have IPv4 addresses assigned_). `userland-proxy: false` will require the container to have atleast an IPv6 address assigned.
-
-This can be problematic for IPv6 host connections when internally the container is no longer aware of the original client IPv6 address, as it has been proxied through the IPv4 or IPv6 gateway address of it's connected network (_eg: `172.17.0.1` - Docker allocates networks from a set of [default subnets][docker-subnets]_).
-
-This can be fixed by enabling a Docker network to assign IPv6 addresses to containers, along with some additional configuration. Alternatively you could configure the opposite to prevent IPv6 connections being made.
-
-## Prevent IPv6 connections
-
-- Avoiding an `AAAA` DNS record for your DMS FQDN would prevent resolving an IPv6 address to connect to.
-- You can also use `userland-proxy: false`, which will fail to establish a remote connection to DMS (_provided no IPv6 address was assigned_).
-
-!!! tip "With UFW or Firewalld"
-
-    When one of these firewall frontends are active, remote clients should fail to connect instead of being masqueraded as the docker network gateway IP. Keep in mind that this only affects remote clients, it does not affect local IPv6 connections originating within the same host.
-
-## Enable proper IPv6 support
-
-You can enable IPv6 support in Docker for container networks, however [compatibility concerns][docs-compat] may affect your success.
-
-The [official Docker documentation on enabling IPv6][docker-docs-enable-ipv6] has been improving and is a good resource to reference.
-
-Enable `ip6tables` support so that Docker will manage IPv6 networking rules as well. This will allow for IPv6 NAT to work like the existing IPv4 NAT already does for your containers, avoiding the above issue with external connections having their IP address seen as the container network gateway IP (_provided an IPv6 address is also assigned to the container_).
-
-!!! example "Configure the following in `/etc/docker/daemon.json`"
-
-    ```json
-    {
-      "ip6tables": true,
-      "experimental" : true,
-      "userland-proxy": true
-    }
-    ```
-
-    - `experimental: true` is currently required for `ip6tables: true` to work.
-    - `userland-proxy` setting [can potentially affect connection behavior][gh-pull-3244-proxy] for local connections.
-
-    Now restart the daemon if it's running: `systemctl restart docker`.
-
-Next, configure a network with an IPv6 subnet for your container with any of these examples:
-
-???+ example "Create an IPv6 ULA subnet"
-
-    ??? info "About these examples"
-
-        These examples are focused on a [IPv6 ULA subnet][wikipedia-ipv6-ula] which is suitable for most users as described in the next section.
-
-        - You may prefer a subnet size smaller than `/64` (eg: `/112`, which still provides over 65k IPv6 addresses), especially if instead configuring for an IPv6 GUA subnet.
-        - The network will also implicitly be assigned an IPv4 subnet (_from the Docker daemon config `default-address-pools`_).
-
-    === "User-defined Network"
-
-        The preferred approach is with [user-defined networks][docker-docs-ipv6-create-custom] via `compose.yaml` (recommended) or CLI with `docker network create`:
-
-        === "Compose"
-
-            Create the network in `compose.yaml` and attach a service to it:
-
-            ```yaml title="compose.yaml"
-            services:
-              mailserver:
-                networks:
-                  - dms-ipv6
-
-            networks:
-              dms-ipv6:
-                enable_ipv6: true
-                ipam:
-                  config:
-                    - subnet: fd00:cafe:face:feed::/64
-            ```
-
-            ??? tip "Override the implicit `default` network"
-
-                You can optionally avoid the service assignment by [overriding the `default` user-defined network that Docker Compose generates][docker-docs-network-compose-default]. Just replace `dms-ipv6` with `default`.
-
-                The Docker Compose `default` bridge is not affected by settings for the default `bridge` (aka `docker0`) in `/etc/docker/daemon.json`.
-
-            ??? tip "Using the network outside of this `compose.yaml`"
-
-                To reference this network externally (_from other compose files or `docker run`_), assign the [networks `name` key in `compose.yaml`][docker-docs-network-external].
-
-        === "CLI"
-
-            Create the network via a CLI command (_which can then be used with `docker run --network dms-ipv6`_):
-
-            ```bash
-            docker network create --ipv6 --subnet fd00:cafe:face:feed::/64 dms-ipv6
-            ```
-
-            Optionally reference it from one or more `compose.yaml` files:
-
-            ```yaml title="compose.yaml"
-            services:
-              mailserver:
-                networks:
-                  - dms-ipv6
-
-            networks:
-              dms-ipv6:
-                external: true
-            ```
-
-    === "Default Bridge (daemon)"
-
-        !!! warning "This approach is discouraged"
-
-            The [`bridge` network is considered legacy][docker-docs-network-bridge-legacy].
-
-        Add these two extra IPv6 settings to your daemon config. They only apply to the [default `bridge` docker network][docker-docs-ipv6-create-default] aka `docker0` (_which containers are attached to by default when using `docker run`_).
-
-        ```json title="/etc/docker/daemon.json"
-        {
-          "ipv6": true,
-          "fixed-cidr-v6": "fd00:cafe:face:feed::/64",
-        }
-        ```
-
-        Compose projects can also use this network via `network_mode`:
-
-        ```yaml title="compose.yaml"
-        services:
-          mailserver:
-            network_mode: bridge
-        ```
-
-!!! danger "Do not use `2001:db8:1::/64` for your private subnet"
-
-    The `2001:db8` address prefix is [reserved for documentation][wikipedia-ipv6-reserved]. Avoid creating a subnet with this prefix.
-
-    Presently this is used in examples for Dockers IPv6 docs as a placeholder, while mixed in with private IPv4 addresses which can be misleading.
-
-### Configuring an IPv6 subnet
-
-If you've [configured IPv6 address pools in `/etc/docker/daemon.json`][docker-docs-ipv6-supernets], you do not need to specify a subnet explicitly. Otherwise if you're unsure what value to provide, here's a quick guide (_Tip: Prefer IPv6 ULA, it's the least hassle_):
-
-- `fd00:cafe:face:feed::/64` is an example of a [IPv6 ULA subnet][wikipedia-ipv6-ula]. ULA addresses are akin to the [private IPv4 subnets][wikipedia-ipv4-private] you may already be familiar with. You can use that example, or choose your own ULA address. This is a good choice for getting Docker containers to their have networks support IPv6 via NAT like they already do by default with IPv4.
-- IPv6 without NAT, using public address space like your server is assigned belongs to an [IPv6 GUA subnet][wikipedia-ipv6-gua].
-    - Typically these will be a `/64` block assigned to your host, but this varies by provider.
-    - These addresses do not need to publish ports of a container to another IP to be publicly reached (_thus `ip6tables: true` is not required_), you will want a firewall configured to manage which ports are accessible instead as no NAT is involved. Note that this may not be desired if the container should also be reachable via the host IPv4 public address.
-    - You may want to subdivide the `/64` into smaller subnets for Docker to use only portions of the `/64`. This can reduce some routing features, and [require additional setup / management via a NDP Proxy][gh-pull-3244-gua] for your public interface to know of IPv6 assignments managed by Docker and accept external traffic.
-
-### Verify remote IP is correct
-
-With Docker CLI or Docker Compose, run a `traefik/whoami` container with your IPv6 docker network and port 80 published. You can then send a curl request (or via address in the browser) from another host (as your remote client) with an IPv6 network, the `RemoteAddr` value returned should match your client IPv6 address.
-
-```bash
-docker run --rm -d --network dms-ipv6 -p 80:80 traefik/whoami
-# On a different host, replace `2001:db8::1` with your DMS host IPv6 address
-curl --max-time 5 http://[2001:db8::1]:80
++  default:
++    driver: bridge
++    enable_ipv6: true
++    ipam:
++      driver: default
++      config:
++        - subnet: fd00:0123:4567::/48
++          gateway: fd00:0123:4567::1
 ```
 
-!!! warning "IPv6 gateway IP"
+## Further Discussion
 
-    If instead of the remote IPv6 address, you may notice the gateway IP for the IPv6 subnet your DMS container belongs to.
+See [#1438][github-issue-1438]
 
-    This will happen when DMS has an IPv6 IP address assigned, for the same reason as with IPv4, `userland-proxy: true`. It indicates that your `daemon.json` has not been configured correctly or had the updated config applied for `ip6tables :true` + `experimental: true`. Make sure you used `systemctl restart docker` after updating `daemon.json`.
-
-!!! info "IPv6 ULA address priority"
-
-    DNS lookups that have records for both IPv4 and IPv6 addresses (_eg: `localhost`_) may prefer IPv4 over IPv6 (ULA) for private addresses, whereas for public addresses IPv6 has priority. This shouldn't be anything to worry about, but can come across as a surprise when testing your IPv6 setup on the same host instead of from a remote client.
-
-    The preference can be controlled with [`/etc/gai.conf`][networking-gai], and appears was configured this way based on [the assumption that IPv6 ULA would never be used with NAT][networking-gai-blog]. It should only affect the destination resolved for outgoing connections, which for IPv6 ULA should only really affect connections between your containers / host. In future [IPv6 ULA may also be prioritized][networking-gai-rfc].
-
-[docker-subnets]: https://straz.to/2021-09-08-docker-address-pools/#what-are-the-default-address-pools-when-no-configuration-is-given-vanilla-pools
-[sender-score]: https://senderscore.org/assess/get-your-score/
-[gh-issue-1438-spf]: https://github.com/docker-mailserver/docker-mailserver/issues/1438
-[gh-issue-3057-bounce]: https://github.com/docker-mailserver/docker-mailserver/pull/3057#issuecomment-1416700046
-[wikipedia-openrelay]: https://en.wikipedia.org/wiki/Open_mail_relay
-
-[docs-compat]: ../debugging.md#compatibility
-
-[gh-pull-3244-proxy]: https://github.com/docker-mailserver/docker-mailserver/pull/3244#issuecomment-1603436809
-[docker-docs-enable-ipv6]: https://docs.docker.com/config/daemon/ipv6/
-[docker-docs-ipv6-create-custom]: https://docs.docker.com/config/daemon/ipv6/#create-an-ipv6-network
-[docker-docs-ipv6-create-default]: https://docs.docker.com/config/daemon/ipv6/#use-ipv6-for-the-default-bridge-network
-[docker-docs-ipv6-supernets]: https://docs.docker.com/config/daemon/ipv6/#dynamic-ipv6-subnet-allocation
-[docker-docs-network-external]: https://docs.docker.com/compose/compose-file/06-networks/#name
-[docker-docs-network-compose-default]: https://docs.docker.com/compose/networking/#configure-the-default-network
-[docker-docs-network-bridge-legacy]: https://docs.docker.com/network/drivers/bridge/#use-the-default-bridge-network
-
-[wikipedia-ipv6-reserved]: https://en.wikipedia.org/wiki/IPv6_address#Documentation
-[wikipedia-ipv4-private]: https://en.wikipedia.org/wiki/Private_network#Private_IPv4_addresses
-[wikipedia-ipv6-ula]: https://en.wikipedia.org/wiki/Unique_local_address
-[wikipedia-ipv6-gua]: https://en.wikipedia.org/wiki/IPv6#Global_addressing
-[gh-pull-3244-gua]: https://github.com/docker-mailserver/docker-mailserver/pull/3244#issuecomment-1528984894
-
-[networking-gai]: https://linux.die.net/man/5/gai.conf
-[networking-gai-blog]: https://thomas-leister.de/en/lxd-prefer-ipv6-outgoing/
-[networking-gai-rfc]:https://datatracker.ietf.org/doc/html/draft-ietf-v6ops-ula
+[github-issue-1438]: https://github.com/docker-mailserver/docker-mailserver/issues/1438

docs/content/config/advanced/mail-fetchmail.md

@@ -2,7 +2,7 @@
 title: 'Advanced | Email Gathering with Fetchmail'
 ---
 
-To enable the [fetchmail][fetchmail-website] service to retrieve e-mails, set the environment variable `ENABLE_FETCHMAIL` to `1`. Your `compose.yaml` file should look like following snippet:
+To enable the [fetchmail][fetchmail-website] service to retrieve e-mails set the environment variable `ENABLE_FETCHMAIL` to `1`. Your `docker-compose.yml` file should look like following snippet:
 
 ```yaml
 environment:
@@ -10,7 +10,7 @@ environment:
   - FETCHMAIL_POLL=300
 ```
 
-Generate a file called `fetchmail.cf` and place it in the `docker-data/dms/config/` folder. Your DMS folder should look like this example:
+Generate a file called `fetchmail.cf` and place it in the `docker-data/dms/config/` folder. Your `docker-mailserver` folder should look like this example:
 
 ```txt
 ├── docker-data/dms/config
@@ -18,135 +18,108 @@ Generate a file called `fetchmail.cf` and place it in the `docker-data/dms/confi
 │   ├── fetchmail.cf
 │   ├── postfix-accounts.cf
 │   └── postfix-virtual.cf
-└── compose.yaml
+├── docker-compose.yml
+└── README.md
 ```
 
 ## Configuration
 
-Configuration options for `fetchmail.cf` are covered at the [official fetchmail docs][fetchmail-docs-config] (_see the section "The run control file" and the table with "keyword" column for all settings_).
+A detailed description of the configuration options can be found in the [online version of the manual page][fetchmail-docs].
 
-!!! example "Basic `fetchmail.cf` configuration"
+### IMAP Configuration
 
-    Retrieve mail from `remote-user@somewhere.com` and deliver it to `dms-user@example.com`:
+!!! example
 
     ```fetchmailrc
-    poll 'mail.somewhere.com'
-    proto imap
-    user 'remote-user'
-    pass 'secret'
-    is 'dms-user@example.com'
+    poll 'imap.gmail.com' proto imap
+      user 'username'
+      pass 'secret'
+      is 'user1@example.com'
+      ssl
     ```
 
-    - `poll` sets the remote mail server to connect to retrieve mail from.
-    - `proto` lets you connect via IMAP or POP3.
-    - `user` and `pass` provide the login credentials for the remote mail service account to access.
-    - `is` configures where the fetched mail will be sent to (_eg: your local DMS account in `docker-data/dms/config/postfix-accounts.cf`_).
+### POP3 Configuration
 
-    ---
+!!! example
 
-    ??? warning "`proto imap` will still delete remote mail once fetched"
-
-        This is due to a separate default setting `no keep`. Adding the setting `keep` to your config on a new line will prevent deleting the remote copy.
-
-??? example "Multiple users or remote servers"
-
-    The official docs [config examples][fetchmail-config-examples] show a common convention to indent settings on subsequent lines for visually grouping per server.
-
-    === "Minimal syntax"
-
-        ```fetchmailrc
-        poll 'mail.somewhere.com' proto imap
-          user 'john.doe' pass 'secret' is 'johnny@example.com'
-          user 'jane.doe' pass 'secret' is 'jane@example.com'
-
-        poll 'mail.somewhere-else.com' proto pop3
-          user 'john.doe@somewhere-else.com' pass 'secret' is 'johnny@example.com'
-        ```
-
-    === "With optional syntax"
-
-        - `#` for adding comments.
-        - The config file may include "noise" keywords to improve readability.
-
-        ```fetchmailrc
-        # Retrieve mail for users `john.doe` and `jane.doe` via IMAP at this remote mail server:
-        poll 'mail.somewhere.com' with proto imap wants:
-          user 'john.doe' with pass 'secret', is 'johnny@example.com' here
-          user 'jane.doe' with pass 'secret', is 'jane@example.com' here
-
-        # Also retrieve mail from this mail server (but via POP3).
-        # NOTE: This could also be all on a single line, or with each key + value as a separate line.
-        # Notice how the remote username includes a full email address,
-        # Some mail servers like DMS use the full email address as the username:
-        poll 'mail.somewhere-else.com' with proto pop3 wants:
-          user 'john.doe@somewhere-else.com' with pass 'secret', is 'johnny@example.com' here
-        ```
-
-!!! tip "`FETCHMAIL_POLL` ENV: Override default polling interval"
-
-    By default the fetchmail service will check every 5 minutes for new mail at the configured mail accounts.
-
-    ```yaml
-    environment:
-      # The fetchmail polling interval in seconds:
-      FETCHMAIL_POLL: 60
+    ```fetchmailrc
+    poll 'pop3.gmail.com' proto pop3
+      user 'username'
+      pass 'secret'
+      is 'user2@example.com'
+      ssl
     ```
 
+!!! caution
+
+    Don’t forget the last line! (_eg: `is 'user1@example.com'`_). After `is`, you have to specify an email address from the configuration file: `docker-data/dms/config/postfix-accounts.cf`.
+
+More details how to configure fetchmail can be found in the [fetchmail man page in the chapter “The run control file”][fetchmail-docs-run].
+
+### Polling Interval
+
+By default the fetchmail service searches every 5 minutes for new mails on your external mail accounts. You can override this default value by changing the ENV variable `FETCHMAIL_POLL`:
+
+```yaml
+environment:
+  - FETCHMAIL_POLL=60
+```
+
+You must specify a numeric argument which is a polling interval in seconds. The example above polls every minute for new mails.
+
 ## Debugging
 
-To debug your `fetchmail.cf` configuration run this `setup debug` command:
+To debug your `fetchmail.cf` configuration run this command:
 
 ```sh
-docker exec -it dms-container-name setup debug fetchmail
+./setup.sh debug fetchmail
 ```
 
-??? example "Sample output of `setup debug fetchmail`"
+For more informations about the configuration script `setup.sh` [read the corresponding docs][docs-setup].
 
-    ```log
-    fetchmail: 6.3.26 querying outlook.office365.com (protocol POP3) at Mon Aug 29 22:11:09 2016: poll started
-    Trying to connect to 132.245.48.18/995...connected.
-    fetchmail: Server certificate:
-    fetchmail: Issuer Organization: Microsoft Corporation
-    fetchmail: Issuer CommonName: Microsoft IT SSL SHA2
-    fetchmail: Subject CommonName: outlook.com
-    fetchmail: Subject Alternative Name: outlook.com
-    fetchmail: Subject Alternative Name: *.outlook.com
-    fetchmail: Subject Alternative Name: office365.com
-    fetchmail: Subject Alternative Name: *.office365.com
-    fetchmail: Subject Alternative Name: *.live.com
-    fetchmail: Subject Alternative Name: *.internal.outlook.com
-    fetchmail: Subject Alternative Name: *.outlook.office365.com
-    fetchmail: Subject Alternative Name: outlook.office.com
-    fetchmail: Subject Alternative Name: attachment.outlook.office.net
-    fetchmail: Subject Alternative Name: attachment.outlook.officeppe.net
-    fetchmail: Subject Alternative Name: *.office.com
-    fetchmail: outlook.office365.com key fingerprint: 3A:A4:58:42:56:CD:BD:11:19:5B:CF:1E:85:16:8E:4D
-    fetchmail: POP3< +OK The Microsoft Exchange POP3 service is ready. [SABFADEAUABSADAAMQBDAEEAMAAwADAANwAuAGUAdQByAHAAcgBkADAAMQAuAHAAcgBvAGQALgBlAHgAYwBoAGEAbgBnAGUAbABhAGIAcwAuAGMAbwBtAA==]
-    fetchmail: POP3> CAPA
-    fetchmail: POP3< +OK
-    fetchmail: POP3< TOP
-    fetchmail: POP3< UIDL
-    fetchmail: POP3< SASL PLAIN
-    fetchmail: POP3< USER
-    fetchmail: POP3< .
-    fetchmail: POP3> USER user1@outlook.com
-    fetchmail: POP3< +OK
-    fetchmail: POP3> PASS *
-    fetchmail: POP3< +OK User successfully logged on.
-    fetchmail: POP3> STAT
-    fetchmail: POP3< +OK 0 0
-    fetchmail: No mail for user1@outlook.com at outlook.office365.com
-    fetchmail: POP3> QUIT
-    fetchmail: POP3< +OK Microsoft Exchange Server 2016 POP3 server signing off.
-    fetchmail: 6.3.26 querying outlook.office365.com (protocol POP3) at Mon Aug 29 22:11:11 2016: poll completed
-    fetchmail: normal termination, status 1
-    ```
+Here a sample output of `./setup.sh debug fetchmail`:
 
-!!! tip "Troubleshoot with this reference `compose.yaml`"
-
-    [A minimal `compose.yaml` example][fetchmail-compose-example] demonstrates how to run two instances of DMS locally, with one instance configured with `fetchmail.cf` and the other to simulate a remote mail server to fetch from.
+```log
+fetchmail: 6.3.26 querying outlook.office365.com (protocol POP3) at Mon Aug 29 22:11:09 2016: poll started
+Trying to connect to 132.245.48.18/995...connected.
+fetchmail: Server certificate:
+fetchmail: Issuer Organization: Microsoft Corporation
+fetchmail: Issuer CommonName: Microsoft IT SSL SHA2
+fetchmail: Subject CommonName: outlook.com
+fetchmail: Subject Alternative Name: outlook.com
+fetchmail: Subject Alternative Name: *.outlook.com
+fetchmail: Subject Alternative Name: office365.com
+fetchmail: Subject Alternative Name: *.office365.com
+fetchmail: Subject Alternative Name: *.live.com
+fetchmail: Subject Alternative Name: *.internal.outlook.com
+fetchmail: Subject Alternative Name: *.outlook.office365.com
+fetchmail: Subject Alternative Name: outlook.office.com
+fetchmail: Subject Alternative Name: attachment.outlook.office.net
+fetchmail: Subject Alternative Name: attachment.outlook.officeppe.net
+fetchmail: Subject Alternative Name: *.office.com
+fetchmail: outlook.office365.com key fingerprint: 3A:A4:58:42:56:CD:BD:11:19:5B:CF:1E:85:16:8E:4D
+fetchmail: POP3< +OK The Microsoft Exchange POP3 service is ready. [SABFADEAUABSADAAMQBDAEEAMAAwADAANwAuAGUAdQByAHAAcgBkADAAMQAuAHAAcgBvAGQALgBlAHgAYwBoAGEAbgBnAGUAbABhAGIAcwAuAGMAbwBtAA==]
+fetchmail: POP3> CAPA
+fetchmail: POP3< +OK
+fetchmail: POP3< TOP
+fetchmail: POP3< UIDL
+fetchmail: POP3< SASL PLAIN
+fetchmail: POP3< USER
+fetchmail: POP3< .
+fetchmail: POP3> USER user1@outlook.com
+fetchmail: POP3< +OK
+fetchmail: POP3> PASS *
+fetchmail: POP3< +OK User successfully logged on.
+fetchmail: POP3> STAT
+fetchmail: POP3< +OK 0 0
+fetchmail: No mail for user1@outlook.com at outlook.office365.com
+fetchmail: POP3> QUIT
+fetchmail: POP3< +OK Microsoft Exchange Server 2016 POP3 server signing off.
+fetchmail: 6.3.26 querying outlook.office365.com (protocol POP3) at Mon Aug 29 22:11:11 2016: poll completed
+fetchmail: normal termination, status 1
+```
 
+[docs-setup]: ../../config/setup.sh.md
 [fetchmail-website]: https://www.fetchmail.info
-[fetchmail-docs-config]: https://www.fetchmail.info/fetchmail-man.html#the-run-control-file
-[fetchmail-config-examples]: https://www.fetchmail.info/fetchmail-man.html#configuration-examples
-[fetchmail-compose-example]: https://github.com/orgs/docker-mailserver/discussions/3994#discussioncomment-9290570
+[fetchmail-docs]: https://www.fetchmail.info/fetchmail-man.html
+[fetchmail-docs-run]: https://www.fetchmail.info/fetchmail-man.html#31

docs/content/config/advanced/mail-forwarding/aws-ses.md

@@ -2,46 +2,29 @@
 title: 'Mail Forwarding | AWS SES'
 ---
 
-[Amazon SES (Simple Email Service)][aws-ses] provides a simple way for cloud based applications to send and receive email.
+[Amazon SES (Simple Email Service)](https://aws.amazon.com/ses/) is intended to provide a simple way for cloud based applications to send email and receive email. For the purposes of this project only sending email via SES is supported.  Older versions of docker-mailserver used `AWS_SES_HOST` and `AWS_SES_USERPASS` to configure sending, this has changed and the setup is mananged through [Configure Relay Hosts][docs-relay].
 
-!!! example "Configuration via ENV"
+You will need to create some [Amazon SES SMTP credentials](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/smtp-credentials.html). The SMTP credentials you create will be used to populate the `RELAY_USER` and `RELAY_PASSWORD` environment variables.
 
-    [Configure a relay host in DMS][docs::relay] to forward all your mail through AWS SES:
+The `RELAY_HOST` should match your [AWS SES region](https://docs.aws.amazon.com/general/latest/gr/ses.html), the `RELAY_PORT` will be 587.
 
-    - `RELAY_HOST` should match your [AWS SES region][aws-ses::region].
-    - `RELAY_PORT` should be set to [one of the supported AWS SES SMTP ports][aws-ses::smtp-ports] (_eg: 587 for STARTTLS_).
-    - `RELAY_USER` and `RELAY_PASSWORD` should be set to your [Amazon SES SMTP credentials][aws-ses::credentials].
+If all of your email is being forwarded through AWS SES, `DEFAULT_RELAY_HOST` should be set accordingly.
 
-    ```env
-    RELAY_HOST=email-smtp.us-west-2.amazonaws.com
-    RELAY_PORT=587
-    # Alternative to RELAY_HOST + RELAY_PORT which is compatible with LDAP:
-    DEFAULT_RELAY_HOST=[email-smtp.us-west-2.amazonaws.com]:587
+Example:
+```
+DEFAULT_RELAY_HOST=[email-smtp.us-west-2.amazonaws.com]:587
+```
 
-    RELAY_USER=aws-user
-    RELAY_PASSWORD=secret
-    ```
+!!! note
+    If you set up [AWS Easy DKIM](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-authentication-dkim-easy.html) you can safely skip setting up DKIM as the AWS SES will take care of signing your outgoing email.
 
-!!! tip
+To verify proper operation, send an email to some external account of yours and inspect the mail headers. You will also see the connection to SES in the mail logs. For example:
 
-    If you have set up [AWS Easy DKIM][aws-ses::easy-dkim], you can safely skip setting up DKIM as AWS SES will take care of signing your outbound mail.
+```log
+May 23 07:09:36 mail postfix/smtp[692]: Trusted TLS connection established to email-smtp.us-east-1.amazonaws.com[107.20.142.169]:25:
+TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)
+May 23 07:09:36 mail postfix/smtp[692]: 8C82A7E7: to=<someone@example.com>, relay=email-smtp.us-east-1.amazonaws.com[107.20.142.169]:25,
+delay=0.35, delays=0/0.02/0.13/0.2, dsn=2.0.0, status=sent (250 Ok 01000154dc729264-93fdd7ea-f039-43d6-91ed-653e8547867c-000000)
+```
 
-!!! note "Verify the relay host is configured correctly"
-
-    To verify proper operation, send an email to some external account of yours and inspect the mail headers.
-
-    You will also see the connection to SES in the mail logs:
-
-    ```log
-    postfix/smtp[692]: Trusted TLS connection established to email-smtp.us-west-1.amazonaws.com[107.20.142.169]:25:
-      TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)
-    postfix/smtp[692]: 8C82A7E7: to=<someone@example.com>, relay=email-smtp.us-west-1.amazonaws.com[107.20.142.169]:25,
-      delay=0.35, delays=0/0.02/0.13/0.2, dsn=2.0.0, status=sent (250 Ok 01000154dc729264-93fdd7ea-f039-43d6-91ed-653e8547867c-000000)
-    ```
-
-[docs::relay]: ./relay-hosts.md
-[aws-ses]: https://aws.amazon.com/ses/
-[aws-ses::credentials]: https://docs.aws.amazon.com/ses/latest/dg/smtp-credentials.html
-[aws-ses::smtp-ports]: https://docs.aws.amazon.com/ses/latest/dg/smtp-connect.html
-[aws-ses::region]: https://docs.aws.amazon.com/general/latest/gr/ses.html
-[aws-ses::easy-dkim]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-authentication-dkim-easy.html
+[docs-relay]: ./relay-hosts.md

docs/content/config/advanced/mail-forwarding/gmail-smtp.md

@@ -1,50 +0,0 @@
----
-title: 'Mail Forwarding | Configure Gmail as a relay host'
----
-
-This page provides a guide for configuring DMS to use [GMAIL as an SMTP relay host][gmail-smtp].
-
-!!! example "Configuration via ENV"
-
-    [Configure a relay host in DMS][docs::relay]. This example shows how the related ENV settings map to the Gmail service config:
-
-    - `RELAY_HOST` should be configured as [advised by Gmail][gmail-smtp::relay-host], there are two SMTP endpoints to choose:
-        - `smtp.gmail.com` (_for a personal Gmail account_)
-        - `smtp-relay.gmail.com` (_when using Google Workspace_)
-    - `RELAY_PORT` should be set to [one of the supported Gmail SMTP ports][gmail-smtp::relay-port] (_eg: 587 for STARTTLS_).
-    - `RELAY_USER` should be your gmail address (`user@gmail.com`).
-    - `RELAY_PASSWORD` should be your [App Password][gmail-smtp::app-password], **not** your personal gmail account password.
-
-    ```env
-    RELAY_HOST=smtp.gmail.com
-    RELAY_PORT=587
-    # Alternative to RELAY_HOST + RELAY_PORT which is compatible with LDAP:
-    DEFAULT_RELAY_HOST=[smtp.gmail.com]:587
-
-    RELAY_USER=username@gmail.com
-    RELAY_PASSWORD=secret
-    ```
-
-!!! tip
-    
-    - As per our main [relay host docs page][docs::relay], you may prefer to configure your credentials via `setup relay add-auth` instead of the `RELAY_USER` + `RELAY_PASSWORD` ENV.
-    - If you configure for `smtp-relay.gmail.com`, the `DEFAULT_RELAY_HOST` ENV should be all you need as shown in the above example. Credentials can be optional when using Google Workspace (`smtp-relay.gmail.com`), which supports restricting connections to trusted IP addresses.
-
-!!! note "Verify the relay host is configured correctly"
-
-    To verify proper operation, send an email to an external account of yours and inspect the mail headers.
-
-    You will also see the connection to the Gmail relay host (`smtp.gmail.com`) in the mail logs:
-
-    ```log
-    postfix/smtp[910]: Trusted TLS connection established to smtp.gmail.com[64.233.188.109]:587:
-      TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
-    postfix/smtp[910]: 4BCB547D9D: to=<username@gmail.com>, relay=smtp.gmail.com[64.233.188.109]:587,
-      delay=2.9, delays=0.01/0.02/1.7/1.2, dsn=2.0.0, status=sent (250 2.0.0 OK  17... - gsmtp)
-    ```
-
-[docs::relay]: ./relay-hosts.md
-[gmail-smtp]: https://support.google.com/a/answer/2956491
-[gmail-smtp::relay-host]: https://support.google.com/a/answer/176600
-[gmail-smtp::relay-port]: https://support.google.com/a/answer/2956491
-[gmail-smtp::app-password]: https://support.google.com/accounts/answer/185833

docs/content/config/advanced/mail-forwarding/relay-hosts.md

@@ -2,155 +2,88 @@
 title: 'Mail Forwarding | Relay Hosts'
 ---
 
-## What is a Relay Host?
+## Introduction
 
-An SMTP relay service (_aka relay host / [smarthost][wikipedia::smarthost]_) is an MTA that relays (_forwards_) mail on behalf of third-parties (_it does not manage the mail domains_).
+Rather than having Postfix deliver mail directly, you can configure Postfix to send mail via another mail relay (smarthost). Examples include [Mailgun](https://www.mailgun.com/), [Sendgrid](https://sendgrid.com/) and [AWS SES](https://aws.amazon.com/ses/).
 
-- Instead of DMS handling SMTP delivery directly itself (_via Postfix_), it can be configured to delegate delivery by sending all outbound mail through a relay service.
-- Examples of popular mail relay services: [AWS SES][smarthost::aws-ses], [Mailgun][smarthost::mailgun], [Mailjet][smarthost::mailjet], [SendGrid][smarthost::sendgrid]
+Depending on the domain of the sender, you may want to send via a different relay, or authenticate in a different way.
 
-!!! info "When can a relay service can be helpful?"
+## Basic Configuration
 
-    - Your network provider has blocked outbound connections on port 25 (_required for direct delivery_).
-    - To improve delivery success via better established reputation (trust) of a relay service.
+Basic configuration is done via environment variables:
 
-## Configuration
+- `RELAY_HOST`: _default host to relay mail through, `empty` (aka '', or no ENV set) will disable this feature_
+- `RELAY_PORT`: _port on default relay, defaults to port 25_
+- `RELAY_USER`: _username for the default relay_
+- `RELAY_PASSWORD`: _password for the default user_
 
-All mail sent outbound from DMS (_where the sender address is a DMS account or a virtual alias_) will be relayed through the configured relay host.
+Setting these environment variables will cause mail for all sender domains to be routed via the specified host, authenticating with the user/password combination.
 
-!!! info "Configuration via ENV"
+!!! warning
+    For users of the previous `AWS_SES_*` variables: please update your configuration to use these new variables, no other configuration is required.
 
-    Configure the default relayhost with either of these ENV:
+## Advanced Configuration
 
-    - Preferable (_LDAP compatible_): `DEFAULT_RELAY_HOST` (eg: `[mail.relay-service.com]:25`)
-    - `RELAY_HOST` (eg: `mail.relay-service.com`) + `RELAY_PORT` (default: 25)
+### Sender-dependent Authentication
 
-    Most relay services also require authentication configured:
+Sender dependent authentication is done in `docker-data/dms/config/postfix-sasl-password.cf`. You can create this file manually, or use:
 
-    - `RELAY_USER` + `RELAY_PASSWORD` provides credentials for authenticating with the default relayhost.
+```sh
+setup.sh relay add-auth <domain> <username> [<password>]
+```
 
-    !!! warning "Providing secrets via ENV"
+An example configuration file looks like this:
 
-        While ENV is convenient, the risk of exposing secrets is higher.
+```txt
+@domain1.com           relay_user_1:password_1
+@domain2.com           relay_user_2:password_2
+```
 
-        `setup relay add-auth` is a better alternative, which manages the credentials via a config file.
+If there is no other configuration, this will cause Postfix to deliver email through the relay specified in `RELAY_HOST` env variable, authenticating as `relay_user_1` when sent from `domain1.com` and authenticating as `relay_user_2` when sending from `domain2.com`.
 
-??? tip "Excluding specific sender domains from relay"
+!!! note
+    To activate the configuration you must either restart the container, or you can also trigger an update by modifying a mail account.
 
-    You can opt-out with: `setup relay exclude-domain <domain>`
+### Sender-dependent Relay Host
 
-    Outbound mail from senders of that domain will be sent normally (_instead of through the configured `RELAY_HOST`_).
+Sender dependent relay hosts are configured in `docker-data/dms/config/postfix-relaymap.cf`. You can create this file manually, or use:
 
-    !!! warning "When any relay host credentials are configured"
+```sh
+setup.sh relay add-domain <domain> <host> [<port>]
+```
 
-        It will still be expected that mail is sent over a secure connection with credentials provided.
+An example configuration file looks like this:
 
-        Thus this opt-out feature is rarely practical.
+```txt
+@domain1.com        [relay1.org]:587
+@domain2.com        [relay2.org]:2525
+```
 
-### Advanced Configuration
+Combined with the previous configuration in `docker-data/dms/config/postfix-sasl-password.cf`, this will cause Postfix to deliver mail sent from `domain1.com` via `relay1.org:587`, authenticating as `relay_user_1`, and mail sent from `domain2.com` via `relay2.org:2525` authenticating as `relay_user_2`.
 
-When mail is sent, there is support to change the relay service or the credentials configured based on the sender address domain used.
+!!! note
+    You still have to define `RELAY_HOST` to activate the feature
 
-We provide this support via two config files:
+### Excluding Sender Domains
 
-- Sender-dependent Relay Host: `docker-data/dms/config/postfix-relaymap.cf`
-- Sender-dependent Authentication: `docker-data/dms/config/postfix-sasl-password.cf`
+If you want mail sent from some domains to be delivered directly, you can exclude them from being delivered via the default relay by adding them to `docker-data/dms/config/postfix-relaymap.cf` with no destination. You can also do this via:
 
-!!! tip "Configure with our `setup relay` commands"
+```sh
+setup.sh relay exclude-domain <domain>
+```
 
-    While you can edit those configs directly, DMS provides these helpful config management commands:
+Extending the configuration file from above:
 
-    ```cli-syntax
-    # Configure a sender domain to use a specific relay host:
-    setup relay add-domain <domain> <host> [<port>]
+```txt
+@domain1.com        [relay1.org]:587
+@domain2.com        [relay2.org]:2525
+@domain3.com
+```
 
-    # Configure relay host credentials for a sender domain to use:
-    setup relay add-auth <domain> <username> [<password>]
+This will cause email sent from `domain3.com` to be delivered directly.
 
-    # Optionally avoid relaying from senders of this domain:
-    # NOTE: Only supported when configured with the `RELAY_HOST` ENV!
-    setup relay exclude-domain <domain>
-    ```
+#### References
 
-!!! example "Config file: `postfix-sasl-password.cf`"
+Thanks to the author of [this article][guide-relayhost-mailgun] for the inspiration. This is also worth reading to understand a bit more about how to set up Mailgun to work with this.
 
-    ```cf-extra title="docker-data/dms/config/postfix-sasl-password.cf"
-    @domain1.com        mailgun-user:secret
-    @domain2.com        sendgrid-user:secret
-
-    # NOTE: This must have an exact match with the relay host in `postfix-relaymap.cf`,
-    # `/etc/postfix/relayhost_map`, or the `DEFAULT_RELAY_HOST` ENV.
-    # NOTE: Not supported via our setup CLI, but valid config for Postfix.
-    [email-smtp.us-west-2.amazonaws.com]:2587 aws-user:secret
-    ```
-
-    When Postfix needs to lookup credentials for mail sent outbound, the above config will:
-
-    - Authenticate as `mailgun-user` for mail sent with a sender belonging to `@domain1.com`
-    - Authenticate as `sendgrid-user` for mail sent with a sender belonging to `@domain2.com`
-    - Authenticate as `aws-user` for mail sent through a configured AWS SES relay host (any sender domain).
-
-!!! example "Config file: `postfix-relaymap.cf`"
-
-    ```cf-extra title="docker-data/dms/config/postfix-relaymap.cf"
-    @domain1.com        [smtp.mailgun.org]:587
-    @domain2.com        [smtp.sendgrid.net]:2525
-
-    # Opt-out of relaying:
-    @domain3.com
-    ```
-
-    When Postfix sends mail outbound from these sender domains, the above config will:
-
-    - Relay mail through `[smtp.mailgun.org]:587` when mail is sent from a sender of `@domain1.com`
-    - Relay mail through `[smtp.sendgrid.net]:2525` when mail is sent from a sender of `@domain1.com`
-    - Mail with a sender from `@domain3.com` is not sent through a relay (_**Only applicable** when using `RELAY_HOST`_)
-
-### Technical Details
-
-- Both the supported ENV and config files for this feature have additional details covered in our ENV docs [Relay Host section][docs::env-relay].
-- For troubleshooting, a [minimal `compose.yaml` config with several DMS instances][dms-gh::relay-example] demonstrates this feature for local testing.
-- [Subscribe to this tracking issue][dms-gh::pr-3607] for future improvements intended for this feature.
-
-!!! abstract "Postfix Settings"
-
-    Internally this feature is implemented in DMS by [`relay.sh`][dms-repo::helpers-relay].
-
-    The `relay.sh` script manages configuring these Postfix settings:
-
-    ```cf-extra
-    # Send all outbound mail through this relay service:
-    relayhost = [smtp.relay-service.com]:587
-
-    # Credentials to use:
-    smtp_sasl_password_maps = texthash:/etc/postfix/sasl_passwd
-    # Alternative table type examples which do not require a separate file:
-    #smtp_sasl_password_maps = static:john.doe@relay-service.com:secret
-    #smtp_sasl_password_maps = inline:{ [smtp.relay-service.com]:587=john.doe@relay-service.com:secret }
-
-    ## Authentication support:
-    # Required to provide credentials to the relay service:
-    smtp_sasl_auth_enable = yes
-    # Enforces requiring credentials when sending mail outbound:
-    smtp_sasl_security_options = noanonymous
-    # Enforces a secure connection (TLS required) to the relay service:
-    smtp_tls_security_level = encrypt
-
-    ## Support for advanced requirements:
-    # Relay service(s) to use instead of direct delivery for specific sender domains:
-    sender_dependent_relayhost_maps = texthash:/etc/postfix/relayhost_map
-    # Support credentials to a relay service(s) that vary by relay host used or sender domain:
-    smtp_sender_dependent_authentication = yes
-    ```
-
-
-[smarthost::mailgun]: https://www.mailgun.com/
-[smarthost::mailjet]: https://www.mailjet.com
-[smarthost::sendgrid]: https://sendgrid.com/
-[smarthost::aws-ses]: https://aws.amazon.com/ses/
-[wikipedia::smarthost]: https://en.wikipedia.org/wiki/Smart_host
-
-[docs::env-relay]: ../../environment.md#relay-host
-[dms-repo::helpers-relay]: https://github.com/docker-mailserver/docker-mailserver/blob/v15.0.0/target/scripts/helpers/relay.sh
-[dms-gh::pr-3607]: https://github.com/docker-mailserver/docker-mailserver/issues/3607
-[dms-gh::relay-example]: https://github.com/docker-mailserver/docker-mailserver/issues/3842#issuecomment-1913380639
+[guide-relayhost-mailgun]: https://community.rackspace.com/products/f/email-products-forum/3897/how-to-setup-postfix-with-a-mailgun-smtp-relay-when-using-multiple-domains

docs/content/config/advanced/mail-getmail.md

@@ -1,118 +0,0 @@
----
-title: 'Advanced | Email Gathering with Getmail'
----
-
-To enable the [getmail][getmail-website] service to retrieve e-mails set the environment variable `ENABLE_GETMAIL` to `1`. Your `compose.yaml` file should include the following:
-
-```yaml
-environment:
-  - ENABLE_GETMAIL=1
-  - GETMAIL_POLL=5
-```
-
-In your DMS config volume (eg: `docker-data/dms/config/`), add a subdirectory `getmail/` for including your getmail config files (eg: `imap-example.cf`) for each remote account that you want to retrieve mail from and deliver to the mailbox of a DMS account.
-
-The content of these config files is documented in the next section with an IMAP and POP3 example to reference.
-
-The directory structure should look similar to this:
-
-```txt
-├── docker-data/dms/config
-│   ├── dovecot.cf
-│   ├── getmail
-│   │   ├── getmailrc_general.cf
-│   │   ├── remote-account1.cf
-│   │   ├── remote-account2.cf
-│   ├── postfix-accounts.cf
-│   └── postfix-virtual.cf
-├── docker-compose.yml
-└── README.md
-```
-
-## Configuration
-
-A detailed description of the configuration options can be found in the [online version of the manual page][getmail-docs].
-
-### Common Options
-
-The default options added to each `getmail` config are:
-
-```getmailrc
-[options]
-verbose = 0
-read_all = false
-delete = false
-max_messages_per_session = 500
-received = false
-delivered_to = false
-```
-
-The DMS integration for Getmail generates a `getmailrc` config that prepends the common options of the base config to each remote account config file (`*.cf`) found in the DMS Config Volume `getmail/` directory.
-
-!!! tip "Change the base options"
-
-    Add your own base config as `getmail/getmailrc_general.cf` into the DMS Config Volume. It will replace the DMS defaults shown above.
-
-??? example "IMAP Configuration"
-
-    This example will:
-
-    1. Connect to the remote IMAP server from Gmail.
-    2. Retrieve mail from the gmail account `alice` with password `notsecure`.
-    3. Store any mail retrieved from the remote mail-server into DMS for the `user1@example.com` account that DMS manages.
-
-    ```getmailrc
-    [retriever]
-    type = SimpleIMAPSSLRetriever
-    server = imap.gmail.com
-    username = alice
-    password = notsecure
-    [destination]
-    type = MDA_external
-    path = /usr/lib/dovecot/deliver
-    allow_root_commands = true
-    arguments =("-d","user1@example.com")
-    ```
-
-??? example "POP3 Configuration"
-
-    Just like the IMAP example above, but instead via POP3 protocol if you prefer that over IMAP.
-
-    ```getmailrc
-    [retriever]
-    type = SimplePOP3SSLRetriever
-    server = pop3.gmail.com
-    username = alice
-    password = notsecure
-    [destination]
-    type = MDA_external
-    path = /usr/lib/dovecot/deliver
-    allow_root_commands = true
-    arguments =("-d","user1@example.com")
-    ```
-
-### Polling Interval
-
-By default the `getmail` service checks external mail accounts for new mail every 5 minutes. That polling interval is configurable via the `GETMAIL_POLL` ENV variable, with a value in minutes (_default: 5, min: 1_):
-
-```yaml
-environment:
-  - GETMAIL_POLL=1
-```
-
-### XOAUTH2 Authentication
-
-It is possible to utilize the `getmail-gmail-xoauth-tokens` helper to provide authentication using `xoauth2` for [gmail (example 12)][getmail-docs-xoauth-12] or [Microsoft Office 365 (example 13)][getmail-docs-xoauth-13]
-
-[getmail-website]: https://www.getmail6.org
-[getmail-docs]: https://getmail6.org/configuration.html
-[getmail-docs-xoauth-12]: https://github.com/getmail6/getmail6/blob/1f95606156231f1e074ba62a9baa64f892a92ef8/docs/getmailrc-examples#L286
-[getmail-docs-xoauth-13]: https://github.com/getmail6/getmail6/blob/1f95606156231f1e074ba62a9baa64f892a92ef8/docs/getmailrc-examples#L351
-
-## Debugging
-
-To debug your `getmail` configurations, run this `setup debug` command:
-
-```sh
-docker exec -it dms-container-name setup debug getmail
-```

docs/content/config/advanced/mail-sieve.md

@@ -4,24 +4,16 @@ title: 'Advanced | Email Filtering with Sieve'
 
 ## User-Defined Sieve Filters
 
-!!! warning "Advice may be outdated"
+[Sieve](http://sieve.info/) allows to specify filtering rules for incoming emails that allow for example sorting mails into different folders depending on the title of an email.
+There are global and user specific filters which are filtering the incoming emails in the following order:
 
-    This section was contributed by the community some time ago and some configuration examples may be outdated.
-
-[Sieve][sieve-info] allows to specify filtering rules for incoming emails that allow for example sorting mails into different folders depending on the title of an email.
-
-!!! info "Global vs User order"
-
-    There are global and user specific filters which are filtering the incoming emails in the following order:
-
-    Global-before -> User specific -> Global-after
+- Global-before -> User specific -> Global-after
 
 Global filters are applied to EVERY incoming mail for EVERY email address.
+To specify a global Sieve filter provide a `docker-data/dms/config/before.dovecot.sieve` or a `docker-data/dms/config/after.dovecot.sieve` file with your filter rules.
+If any filter in this filtering chain discards an incoming mail, the delivery process will stop as well and the mail will not reach any following filters(e.g. global-before stops an incoming spam mail: The mail will get discarded and a user-specific filter won't get applied.)
 
-- To specify a global Sieve filter provide a `docker-data/dms/config/before.dovecot.sieve` or a `docker-data/dms/config/after.dovecot.sieve` file with your filter rules.
-- If any filter in this filtering chain discards an incoming mail, the delivery process will stop as well and the mail will not reach any following filters (e.g. global-before stops an incoming spam mail: The mail will get discarded and a user-specific filter won't get applied.)
-
-To specify a user-defined Sieve filter place a `.dovecot.sieve` file into a virtual user's mail folder (e.g. `/var/mail/example.com/user1/home/.dovecot.sieve`). If this file exists dovecot will apply the filtering rules.
+To specify a user-defined Sieve filter place a `.dovecot.sieve` file into a virtual user's mail folder e.g. `/var/mail/example.com/user1/.dovecot.sieve`. If this file exists dovecot will apply the filtering rules.
 
 It's even possible to install a user provided Sieve filter at startup during users setup: simply include a Sieve file in the `docker-data/dms/config/` path for each user login that needs a filter. The file name provided should be in the form `<user_login>.dovecot.sieve`, so for example for `user1@example.com` you should provide a Sieve file named `docker-data/dms/config/user1@example.com.dovecot.sieve`.
 
@@ -40,7 +32,6 @@ An example of a sieve filter that moves mails to a folder `INBOX/spam` depending
     ```
 
 !!! warning
-
     That folders have to exist beforehand if sieve should move them.
 
 Another example of a sieve filter that forward mails to a different address:
@@ -61,96 +52,14 @@ Just forward all incoming emails and do not save them locally:
     redirect "user2@not-example.com";
     ```
 
-You can also use external programs to filter or pipe (process) messages by adding executable scripts in `docker-data/dms/config/sieve-pipe` or `docker-data/dms/config/sieve-filter`.
-
-This can be used in lieu of a local alias file, for instance to forward an email to a webservice.
-
-- These programs can then be referenced by filename, by all users.
-- Note that the process running the scripts run as a privileged user.
-- For further information see [Dovecot's docs][dovecot-docs::sieve-pipe].
+You can also use external programs to filter or pipe (process) messages by adding executable scripts in `docker-data/dms/config/sieve-pipe` or `docker-data/dms/config/sieve-filter`. This can be used in lieu of a local alias file, for instance to forward an email to a webservice. These programs can then be referenced by filename, by all users. Note that the process running the scripts run as a privileged user. For further information see [Dovecot's wiki](https://wiki.dovecot.org/Pigeonhole/Sieve/Plugins/Pipe).
 
 ```sieve
 require ["vnd.dovecot.pipe"];
 pipe "external-program";
 ```
 
-For more examples or a detailed description of the Sieve language have a look at [the official site][sieve-info::examples]. Other resources are available on the internet where you can find several [examples][third-party::sieve-examples].
-
-[dovecot-docs::sieve-pipe]: https://doc.dovecot.org/configuration_manual/sieve/plugins/extprograms/#pigeonhole-plugin-extprograms
-[sieve-info]: http://sieve.info/
-[sieve-info::examples]: http://sieve.info/examplescripts
-[third-party::sieve-examples]: https://support.tigertech.net/sieve#sieve-example-rules-jmp
-
-## Automatic Sorting Based on Sub-addresses { #subaddress-mailbox-routing }
-
-When mail is delivered to your account, it is possible to organize storing mail into folders by the [subaddress (tag)][docs::accounts-subaddressing] used.
-
-!!! example "Example: `user+<tag>@example.com` to `INBOX/<Tag>`"
-
-    This example sorts mail into inbox folders by their tag:
-
-    ```sieve title="docker-data/dms/config/user@example.com.dovecot.sieve"
-    require ["envelope", "fileinto", "mailbox", "subaddress", "variables"];
-
-    # Check if the mail recipient address has a tag (:detail)
-    if envelope :detail :matches "to" "*" {
-      # Create a variable `tag`, with the the captured `to` value normalized (SoCIAL => Social)
-      set :lower :upperfirst "tag" "${1}";
-
-      # Store the mail into a folder with the tag name, nested under your inbox folder:
-      if mailboxexists "INBOX.${tag}" {
-        fileinto "INBOX.${tag}";
-      } else {
-        fileinto :create "INBOX.${tag}";
-      }
-    }
-    ```
-
-    When receiving mail for `user+social@example.com` it would be delivered into the `INBOX/Social` folder.
-
-??? tip "Only redirect mail for specific tags"
-
-    If you want to only handle specific tags, you could replace the envelope condition and tag assignment from the prior example with:
-
-    ```sieve title="docker-data/dms/config/user@example.com.dovecot.sieve"
-    # Instead of `:matches`, use the default comparator `:is` (exact match)
-    if envelope :detail "to" "social" {
-      set "tag" "Social";
-    ```
-
-    ```sieve title="docker-data/dms/config/user@example.com.dovecot.sieve"
-    # Alternatively you can also provide a list of values to match:
-    if envelope :detail "to" ["azure", "aws"] {
-      set "tag" "Cloud";
-    ```
-
-    ```sieve title="docker-data/dms/config/user@example.com.dovecot.sieve"
-    # Similar to `:matches`, except `:regex` provides enhanced pattern matching.
-    # NOTE: This example needs you to `require` the "regex" extension
-    if envelope :detail :regex "to" "^cloud-(azure|aws)$" {
-      # Normalize the captured azure/aws tag as the resolved value is no longer fixed:
-      set :lower :upperfirst "vendor" "${1}";
-      # If a `.` exists in the tag, it will create nested folders:
-      set "tag" "Cloud.${vendor}";
-    ```
-
-    **NOTE:** There is no need to lowercase the tag in the conditional as the [`to` value is a case-insensitive check][sieve-docs::envelope].
-
-??? abstract "Technical Details"
-
-    - Dovecot supports this feature via the _Sieve subaddress extension_ ([RFC 5233][rfc::5233::sieve-subaddress]).
-    - Only a single tag per subaddress is supported. Any additional tag delimiters are part of the tag value itself.
-    - The Dovecot setting [`recipient_delimiter`][dovecot-docs::config::recipient_delimiter] (default: `+`) configures the tag delimiter. This is where the `local-part` of the recipient address will split at, providing the `:detail` (tag) value for Sieve.
-
-    ---
-
-    `INBOX` is the [default namespace configured by Dovecot][dovecot-docs::namespace].
-
-    - If you omit the `INBOX.` prefix from the sieve script above, the mailbox (folder) for that tag is created at the top-level alongside your Trash and Junk folders.
-    - The `.` between `INBOX` and `${tag}` is important as a [separator to distinguish mailbox names][dovecot-docs::mailbox-names]. This can vary by mailbox format or configuration. DMS uses [`Maildir`][dovecot-docs::mailbox-formats::maildir] by default, which uses `.` as the separator.
-    - [`lmtp_save_to_detail_mailbox = yes`][dovecot-docs::config::lmtp_save_to_detail_mailbox] can be set in `/etc/dovecot/conf.d/20-lmtp.conf`:
-        - This implements the feature globally, except for the tag normalization and `INBOX.` prefix parts of the example script.
-        - However, if the sieve script is also present, the script has precedence and will handle this task instead when the condition is successful, otherwise falling back to the global feature.
+For more examples or a detailed description of the Sieve language have a look at [the official site](http://sieve.info/examplescripts). Other resources are available on the internet where you can find several [examples](https://support.tigertech.net/sieve#sieve-example-rules-jmp).
 
 ## Manage Sieve
 
@@ -158,31 +67,20 @@ The [Manage Sieve](https://doc.dovecot.org/admin_manual/pigeonhole_managesieve_s
 
 !!! example
 
-    ```yaml title="compose.yaml"
+    ```yaml
+    # docker-compose.yml
     ports:
       - "4190:4190"
     environment:
       - ENABLE_MANAGESIEVE=1
     ```
 
-All user defined sieve scripts that are managed by ManageSieve are stored in the user's home folder in `/var/mail/example.com/user1/home/sieve`. Just one Sieve script might be active for a user and is sym-linked to `/var/mail/example.com/user1/home/.dovecot.sieve` automatically.
+All user defined sieve scripts that are managed by ManageSieve are stored in the user's home folder in `/var/mail/example.com/user1/sieve`. Just one sieve script might be active for a user and is sym-linked to `/var/mail/example.com/user1/.dovecot.sieve` automatically.
 
 !!! note
-
-    ManageSieve makes sure to not overwrite an existing `.dovecot.sieve` file. If a user activates a new sieve script the old one is backed up and moved to the `sieve` folder.
+    ManageSieve makes sure to not overwrite an existing `.dovecot.sieve` file. If a user activates a new sieve script the old one is backuped and moved to the `sieve` folder.
 
 The extension is known to work with the following ManageSieve clients:
 
 - **[Sieve Editor](https://github.com/thsmi/sieve)**  a portable standalone application based on the former Thunderbird plugin.
-- **[Kmail](https://kontact.kde.org/components/kmail/)**  the mail client of [KDE](https://kde.org/)'s Kontact Suite.
-
-[docs::accounts-subaddressing]: ../account-management/overview.md#sub-addressing
-
-[dovecot-docs::namespace]: https://doc.dovecot.org/configuration_manual/namespace/
-[dovecot-docs::mailbox-names]: https://doc.dovecot.org/configuration_manual/sieve/usage/#mailbox-names
-[dovecot-docs::mailbox-formats::maildir]: https://doc.dovecot.org/admin_manual/mailbox_formats/maildir/#maildir-mbox-format
-[dovecot-docs::config::lmtp_save_to_detail_mailbox]: https://doc.dovecot.org/settings/core/#core_setting-lmtp_save_to_detail_mailbox
-[dovecot-docs::config::recipient_delimiter]: https://doc.dovecot.org/settings/core/#core_setting-recipient_delimiter
-
-[rfc::5233::sieve-subaddress]: https://datatracker.ietf.org/doc/html/rfc5233
-[sieve-docs::envelope]: https://thsmi.github.io/sieve-reference/en/test/core/envelope.html
+- **[Kmail](https://kontact.kde.org/components/kmail.html)**  the mail client of [KDE](https://kde.org/)'s Kontact Suite.

docs/content/config/advanced/maintenance/update-and-cleanup.md

@@ -2,52 +2,40 @@
 title: 'Maintenance | Update and Cleanup'
 ---
 
-[`containrrr/watchtower`][watchtower-dockerhub] is a service that monitors Docker images for updates, automatically applying them to running containers.
+## Automatic Update
 
-!!! example "Automatic image updates + cleanup"
+Docker images are handy but it can get a a hassle to keep them updated. Also when a repository is automated you want to get these images when they get out.
 
-    Run a `watchtower` container with access to `docker.sock`, enabling the service to manage Docker:
+One could setup a complex action/hook-based workflow using probes, but there is a nice, easy to use docker image that solves this issue and could prove useful: [`watchtower`](https://hub.docker.com/r/containrrr/watchtower).
 
-    ```yaml title="compose.yaml"
-    services:
-      watchtower:
-        image: containrrr/watchtower:latest
-        # Automatic cleanup (removes older image pulls from wasting disk space):
-        environment:
-          - WATCHTOWER_CLEANUP=true
-        volumes:
-          - /var/run/docker.sock:/var/run/docker.sock
-    ```
+A docker-compose example:
 
-!!! tip "The image tag used for a container is monitored for updates (eg: `:latest`, `:edge`, `:13`)"
+```yaml
+services:
+  watchtower:
+    restart: always
+    image: containrrr/watchtower:latest
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock
+```
 
-    The automatic update support is **only for updates to that specific image tag**.
+For more details, see the [manual](https://containrrr.github.io/watchtower/)
 
-    - Your container will not update to a new major version tag (_unless using `:latest`_).
-    - Omit the minor or patch portion of the semver tag to receive updates for the omitted portion (_eg: `13` will represent the latest minor + patch release of `v13`_).
+## Automatic Cleanup
 
-!!! tip "Updating only specific containers"
+When you are pulling new images in automatically, it would be nice to have them cleaned up as well. There is also a docker image for this: [`spotify/docker-gc`](https://hub.docker.com/r/spotify/docker-gc/).
 
-    By default the `watchtower` service will check every 24 hours for new image updates to pull, based on currently running containers (_**not restricted** to only those running within your `compose.yaml`_).
+A docker-compose example:
 
-    Images eligible for updates can configured with a [custom `command`][docker-docs-compose-command] that provides a list of container names, or via other supported options (eg: labels). This configuration is detailed in the [`watchtower` docs][watchtower-docs].
+```yaml
+services:
+  docker-gc:
+    restart: always
+    image: spotify/docker-gc:latest
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock
+```
 
-!!! info "Manual cleanup"
+For more details, see the [manual](https://github.com/spotify/docker-gc/blob/master/README.md)
 
-    `watchtower` also supports running on-demand with `docker run` or `compose.yaml` via the `--run-once` option.
-    
-    You can alternatively invoke cleanup of Docker storage directly with:
-
-    - [`docker image prune --all`][docker-docs-prune-image]
-    - [`docker system prune --all`][docker-docs-prune-system] (_also removes unused containers, networks, build cache_).
-
-    If you omit the `--all` option, this will instead only remove ["dangling" content][docker-prune-dangling] (_eg: Orphaned images_).
-
-[watchtower-dockerhub]: https://hub.docker.com/r/containrrr/watchtower
-[watchtower-cleanup]: https://containrrr.github.io/watchtower/arguments/#cleanup
-[watchtower-docs]: https://containrrr.dev/watchtower/
-
-[docker-docs-compose-command]: https://docs.docker.com/compose/compose-file/05-services/#command
-[docker-docs-prune-image]: https://docs.docker.com/engine/reference/commandline/image_prune/
-[docker-docs-prune-system]: https://docs.docker.com/engine/reference/commandline/system_prune/
-[docker-prune-dangling]: https://stackoverflow.com/questions/45142528/what-is-a-dangling-image-and-what-is-an-unused-image/60756668#60756668
+Or you can just use the [`--cleanup`](https://containrrr.github.io/watchtower/arguments/#cleanup) option provided by `containrrr/watchtower`.

docs/content/config/advanced/optional-config.md

@@ -4,69 +4,16 @@ hide:
   - toc # Hide Table of Contents for this page
 ---
 
-## Volumes
+This is a list of all configuration files and directories which are optional or automatically generated in your `docker-data/dms/config/` directory.
 
-DMS has several locations in the container which may be worth persisting externally via [Docker Volumes][docker-docs::volumes].
-
-- Often you will want to prefer [bind mount volumes][docker-docs::volumes::bind-mount] for easy access to files at a local location on your filesystem.
-- As a convention for our docs and example configs, the local location has the common prefix `docker-data/dms/` for grouping these related volumes.
-
-!!! info "Reference - Volmes for DMS"
-
-    Our docs may refer to these DMS specific volumes only by name, or the host/container path for brevity.
-
-    - [Config](#volumes-config): `docker-data/dms/config/` => `/tmp/docker-mailserver/`
-    - [Mail Storage](#volumes-mail): `docker-data/dms/mail-data/` => `/var/mail/`
-    - [State](#volumes-state): `docker-data/dms/mail-state/` => `/var/mail-state/`
-    - [Logs](#volumes-log): `docker-data/dms/mail-logs/` => `/var/log/mail/`
-
-### Mail Storage Volume { #volumes-mail }
-
-This is the location where mail is delivered to your mailboxes.
-
-### State Volume { #volumes-state }
-
-Run-time specific state lives here, but so does some data you may want to keep if a failure event occurs (_crash, power loss_).
-
-!!! example "Examples of relevant data"
-
-    - The Postfix queue (eg: mail pending delivery attempt)
-    - Fail2Ban blocks.
-    - ClamAV signature updates.
-    - Redis storage for Rspamd.
-
-!!! info "When a volume is mounted to `/var/mail-state/`"
-
-    - Service run-time data is [consolidated into the `/var/mail-state/` directory][mail-state-folders]. Otherwise the original locations vary and would need to be mounted individually.
-    - The original locations are updated with symlinks to redirect to their new path in `/var/mail-state/` (_eg: `/var/lib/redis` => `/var/mail-state/lib-redis/`_).
-
-    Supported services: Postfix, Dovecot, Fail2Ban, Amavis, PostGrey, ClamAV, SpamAssassin, Rspamd & Redis, Fetchmail, Getmail, LogRotate, PostSRSd, MTA-STS.
-
-!!! tip
-
-    Sometimes it is helpful to disable this volume when troubleshooting to verify if the data stored here is in a bad state (_eg: caused by a failure event_).
-
-[mail-state-folders]: https://github.com/docker-mailserver/docker-mailserver/blob/v13.3.1/target/scripts/startup/setup.d/mail_state.sh#L13-L33
-
-### Logs Volume { #volumes-log }
-
-This can be a useful volume to persist for troubleshooting needs for the full set of log files.
-
-### Config Volume { #volumes-config }
-
-Most configuration files for Postfix, Dovecot, etc. are persisted here.
-
-This is a list of all configuration files and directories which are optional, automatically generated / updated by our `setup` CLI, or other internal scripts.
-
-#### Directories
+## Directories
 
 - **sieve-filter:** directory for sieve filter scripts. (Docs: [Sieve][docs-sieve])
 - **sieve-pipe:** directory for sieve pipe scripts. (Docs: [Sieve][docs-sieve])
 - **opendkim:** DKIM directory. Auto-configurable via [`setup.sh config dkim`][docs-setupsh]. (Docs: [DKIM][docs-dkim])
 - **ssl:** SSL Certificate directory if `SSL_TYPE` is set to `self-signed` or `custom`. (Docs: [SSL][docs-ssl])
-- **rspamd:** Override directory for custom settings when using Rspamd (Docs: [Rspamd][docs-rspamd-override-d])
 
-#### Files
+## Files
 
 - **{user_email_address}.dovecot.sieve:** User specific Sieve filter file. (Docs: [Sieve][docs-sieve])
 - **before.dovecot.sieve:** Global Sieve filter file, applied prior to the `${login}.dovecot.sieve` filter. (Docs: [Sieve][docs-sieve])
@@ -77,38 +24,33 @@ This is a list of all configuration files and directories which are optional, au
 - **postfix-send-access.cf:** List of users denied sending. Modify via [`setup.sh email restrict`][docs-setupsh].
 - **postfix-receive-access.cf:** List of users denied receiving. Modify via [`setup.sh email restrict`][docs-setupsh].
 - **postfix-virtual.cf:** Alias configuration file. Modify via [`setup.sh alias`][docs-setupsh].
-- **postfix-sasl-password.cf:** listing of relayed domains with their respective `<username>:<password>`. Modify via `setup.sh relay add-auth <domain> <username> [<password>]`. (Docs: [Relay-Hosts Auth][docs::relay-hosts::advanced])
-- **postfix-relaymap.cf:** domain-specific relays and exclusions. Modify via `setup.sh relay add-domain` and `setup.sh relay exclude-domain`. (Docs: [Relay-Hosts Senders][docs::relay-hosts::advanced])
+- **postfix-sasl-password.cf:** listing of relayed domains with their respective `<username>:<password>`. Modify via `setup.sh relay add-auth <domain> <username> [<password>]`. (Docs: [Relay-Hosts Auth][docs-relayhosts-senderauth])
+- **postfix-relaymap.cf:** domain-specific relays and exclusions. Modify via `setup.sh relay add-domain` and `setup.sh relay exclude-domain`. (Docs: [Relay-Hosts Senders][docs-relayhosts-senderhost])
 - **postfix-regexp.cf:** Regular expression alias file. (Docs: [Aliases][docs-aliases-regex])
 - **ldap-users.cf:** Configuration for the virtual user mapping `virtual_mailbox_maps`. See the [`setup-stack.sh`][github-commit-setup-stack.sh-L411] script.
 - **ldap-groups.cf:** Configuration for the virtual alias mapping `virtual_alias_maps`. See the [`setup-stack.sh`][github-commit-setup-stack.sh-L411] script.
 - **ldap-aliases.cf:** Configuration for the virtual alias mapping `virtual_alias_maps`. See the [`setup-stack.sh`][github-commit-setup-stack.sh-L411] script.
 - **ldap-domains.cf:** Configuration for the virtual domain mapping `virtual_mailbox_domains`. See the [`setup-stack.sh`][github-commit-setup-stack.sh-L411] script.
 - **whitelist_clients.local:** Whitelisted domains, not considered by postgrey. Enter one host or domain per line.
-- **spamassassin-rules.cf:** Anti-spam rules for Spamassassin. (Docs: [FAQ - SpamAssassin Rules][docs-faq-spamrules])
+- **spamassassin-rules.cf:** Antispam rules for Spamassassin. (Docs: [FAQ - SpamAssassin Rules][docs-faq-spamrules])
 - **fail2ban-fail2ban.cf:** Additional config options for `fail2ban.cf`. (Docs: [Fail2Ban][docs-fail2ban])
-- **fail2ban-jail.cf:** Additional config options for fail2ban's jail behavior. (Docs: [Fail2Ban][docs-fail2ban])
+- **fail2ban-jail.cf:** Additional config options for fail2ban's jail behaviour. (Docs: [Fail2Ban][docs-fail2ban])
 - **amavis.cf:** replaces the `/etc/amavis/conf.d/50-user` file
 - **dovecot.cf:** replaces `/etc/dovecot/local.conf`. (Docs: [Override Dovecot Defaults][docs-override-dovecot])
 - **dovecot-quotas.cf:** list of custom quotas per mailbox. (Docs: [Accounts][docs-accounts-quota])
 - **user-patches.sh:** this file will be run after all configuration files are set up, but before the postfix, amavis and other daemons are started. (Docs: [FAQ - How to adjust settings with the `user-patches.sh` script][docs-faq-userpatches])
-- **rspamd/custom-commands.conf:** list of simple commands to adjust Rspamd modules in an easy way (Docs: [Rspamd][docs-rspamd-commands])
 
-[docker-docs::volumes]: https://docs.docker.com/storage/volumes/
-[docker-docs::volumes::bind-mount]: https://docs.docker.com/storage/bind-mounts/
-
-[docs-accounts-quota]: ../../config/account-management/provisioner/file.md#quotas
-[docs-aliases-regex]: ../../config/account-management/provisioner/file.md#configuring-regex-aliases
-[docs-dkim]: ../../config/best-practices/dkim_dmarc_spf.md#dkim
+[docs-accounts-quota]: ../../config/user-management/accounts.md#notes
+[docs-aliases-regex]: ../../config/user-management/aliases.md#configuring-regexp-aliases
+[docs-dkim]: ../../config/best-practices/dkim.md
 [docs-fail2ban]: ../../config/security/fail2ban.md
 [docs-faq-spamrules]: ../../faq.md#how-can-i-manage-my-custom-spamassassin-rules
 [docs-faq-userpatches]: ../../faq.md#how-to-adjust-settings-with-the-user-patchessh-script
 [docs-override-postfix]: ./override-defaults/postfix.md
 [docs-override-dovecot]: ./override-defaults/dovecot.md
-[docs::relay-hosts::advanced]: ./mail-forwarding/relay-hosts.md#advanced-configuration
+[docs-relayhosts-senderauth]: ./mail-forwarding/relay-hosts.md#sender-dependent-authentication
+[docs-relayhosts-senderhost]: ./mail-forwarding/relay-hosts.md#sender-dependent-relay-host
 [docs-sieve]: ./mail-sieve.md
 [docs-setupsh]: ../../config/setup.sh.md
 [docs-ssl]: ../../config/security/ssl.md
-[docs-rspamd-override-d]: ../security/rspamd.md#manually
-[docs-rspamd-commands]: ../security/rspamd.md#with-the-help-of-a-custom-file
 [github-commit-setup-stack.sh-L411]: https://github.com/docker-mailserver/docker-mailserver/blob/941e7acdaebe271eaf3d296b36d4d81df4c54b90/target/scripts/startup/setup-stack.sh#L411

docs/content/config/advanced/override-defaults/dovecot.md

@@ -5,16 +5,16 @@ title: 'Override the Default Configs | Dovecot'
 ## Add Configuration
 
 The Dovecot default configuration can easily be extended providing a `docker-data/dms/config/dovecot.cf` file.
-[Dovecot documentation](https://doc.dovecot.org/configuration_manual/) remains the best place to find configuration options.
+[Dovecot documentation](https://wiki.dovecot.org) remains the best place to find configuration options.
 
-Your DMS folder structure should look like this example:
+Your `docker-mailserver` folder should look like this example:
 
 ```txt
 ├── docker-data/dms/config
 │   ├── dovecot.cf
 │   ├── postfix-accounts.cf
 │   └── postfix-virtual.cf
-├── compose.yaml
+├── docker-compose.yml
 └── README.md
 ```
 
@@ -26,7 +26,7 @@ mail_max_userip_connections = 100
 
 Another important option is the `default_process_limit` (defaults to `100`). If high-security mode is enabled you'll need to make sure this count is higher than the maximum number of users that can be logged in simultaneously.
 
-This limit is quickly reached if users connect to DMS with multiple end devices.
+This limit is quickly reached if users connect to the `docker-mailserver` with multiple end devices.
 
 ## Override Configuration
 
@@ -55,7 +55,7 @@ To debug your dovecot configuration you can use:
 - Or: `docker exec -it mailserver doveconf | grep <some-keyword>`
 
 !!! note
-    [`setup.sh`][github-file-setupsh] is included in the DMS repository. Make sure to use the one matching your image version release.
+    [`setup.sh`][github-file-setupsh] is included in the `docker-mailserver` repository. Make sure to use the one matching your image version release.
 
 The file `docker-data/dms/config/dovecot.cf` is copied internally to `/etc/dovecot/local.conf`. To verify the file content, run:
 

docs/content/config/advanced/override-defaults/postfix.md

@@ -2,34 +2,33 @@
 title: 'Override the Default Configs | Postfix'
 ---
 
-[Our default Postfix configuration](https://github.com/docker-mailserver/docker-mailserver/blob/master/target/postfix/main.cf) can easily be extended to add parameters or modify existing ones by providing a `docker-data/dms/config/postfix-main.cf`. This file uses the same format as Postfix `main.cf` does ([See official docs](http://www.postfix.org/postconf.5.html) for all parameters and syntax rules).
+The Postfix default configuration can easily be extended by providing a `docker-data/dms/config/postfix-main.cf` in postfix format.
+This can also be used to add configuration that is not in our default configuration.
 
-!!! example "Example"
-
-    One can easily increase the [backwards-compatibility level](http://www.postfix.org/postconf.5.html#compatibility_level) and set new Postscreen options:
-
-    ```cf
-    # increase the compatibility level from 2 (default) to 3
-    compatibility_level = 3
-    # set a threshold value for Spam detection
-    postscreen_dnsbl_threshold = 4
-    ```
-
-
-!!! help "How are your changes applied?"
-
-    The custom configuration you supply is appended to the default configuration located at `/etc/postfix/main.cf`, and then `postconf -nf` is run to remove earlier duplicate entries that have since been replaced. This happens early during container startup before Postfix is started.
-
----
-
-Similarly, it is possible to add a custom `docker-data/dms/config/postfix-master.cf` file that will override the standard `master.cf`. **Note**: Each line in this file will be passed to `postconf -P`, i.e. **the file is not appended as a whole** to `/etc/postfix/master.cf` like `docker-data/dms/config/postfix-main.cf`! The expected format is `<service_name>/<type>/<parameter>`, for example:
+For example, one common use of this file is for increasing the default maximum message size:
+
+```cf
+# increase maximum message size
+message_size_limit = 52428800
+```
+
+That specific example is now supported and can be handled by setting `POSTFIX_MESSAGE_SIZE_LIMIT`.
+
+!!! note
+
+    [Postfix documentation](http://www.postfix.org/documentation.html) remains the best place to find configuration options.
+
+Each line in the provided file will be loaded into postfix.
+
+In the same way it is possible to add a custom `docker-data/dms/config/postfix-master.cf` file that will override the standard `master.cf`. Each line in the file will be passed to `postconf -P`. The expected format is `<service_name>/<type>/<parameter>`, for example:
 
 ```cf
-# adjust the submission "reject_unlisted_recipient" option
 submission/inet/smtpd_reject_unlisted_recipient=no
 ```
 
-!!! attention
+Run `postconf -P` in the container without arguments to see the active master options.
+
+!!! note
     There should be no space between the parameter and the value.
 
-Run `postconf -Mf` in the container without arguments to see the active master options.
+Have a look at the code for more information.

docs/content/config/advanced/override-defaults/user-patches.md

@@ -2,9 +2,9 @@
 title: 'Custom User Changes & Patches | Scripting'
 ---
 
-If you'd like to change, patch or alter files or behavior of DMS, you can use a script.
+If you'd like to change, patch or alter files or behavior of `docker-mailserver`, you can use a script.
 
-In case you cloned this repository, you can copy the file [`user-patches.sh.dist` (_under `config/`_)][github-file-userpatches] with `#!sh cp config/user-patches.sh.dist docker-data/dms/config/user-patches.sh` in order to create the `user-patches.sh` script.
+In case you cloned this repository, you can copy the file [`user-patches.sh.dist` (_under `config/`_)][gh-file-userpatches] with `#!sh cp config/user-patches.sh.dist docker-data/dms/config/user-patches.sh` in order to create the `user-patches.sh` script.
 
 If you are managing your directory structure yourself, create a `docker-data/dms/config/` directory and add the `user-patches.sh` file yourself.
 
@@ -21,7 +21,7 @@ If you are managing your directory structure yourself, create a `docker-data/dms
 The contents could look like this:
 
 ``` sh
-#!/bin/bash
+#! /bin/bash
 
 cat >/etc/amavis/conf.d/50-user << "END"
 use strict;
@@ -40,4 +40,4 @@ And you're done. The user patches script runs right before starting daemons. Tha
 !!! note
     Many "patches" can already be done with the Docker Compose-/Stack-file. Adding hostnames to `/etc/hosts` is done with the `#!yaml extra_hosts:` section, `sysctl` commands can be managed with the `#!yaml sysctls:` section, etc.
 
-[github-file-userpatches]: https://github.com/docker-mailserver/docker-mailserver/blob/master/config-examples/user-patches.sh
+[gh-file-userpatches]: https://github.com/docker-mailserver/docker-mailserver/blob/master/config/user-patches.sh.dist

docs/content/config/advanced/podman.md

@@ -8,22 +8,17 @@ Podman is a daemonless container engine for developing, managing, and running OC
 
 !!! warning "About Support for Podman"
 
-    Please note that Podman **is not** officially supported as DMS is built and verified on top of the _Docker Engine_. This content is entirely community supported. If you find errors, please open an issue and provide a PR.
+    Please note that Podman **is not** officially supported as `docker-mailserver` is built and verified on top of the _Docker Engine_. This content is entirely community supported. If you find errors, please open an issue and provide a PR.
 
 !!! warning "About this Guide"
 
-    This guide was tested with Fedora 34 using `systemd` and `firewalld`. Moreover, it requires Podman version >= 3.2. You may be able to substitute `dnf` - Fedora's package manager - with others such as `apt`.
-
-!!! warning "About Security"
-
-    Running podman in rootless mode requires additional modifications in order to keep your mailserver secure.
-    Make sure to read the related documentation.
+    This guide was tested with Fedora 34 using `systemd` and `firewalld`. Moreover, it requires Podman version >= 3.2. You may be able to substitute `dnf` - Fedora's package maneger - with others such as `apt`.
 
 ## Installation in Rootfull Mode
 
 While using Podman, you can just manage docker-mailserver as what you did with Docker. Your best friend `setup.sh` includes the minimum code in order to support Podman since it's 100% compatible with the Docker CLI.
 
-The installation is basically the same. Podman v3.2 introduced a RESTful API that is 100% compatible with the Docker API, so you can use Docker Compose with Podman easily. Install Podman and Docker Compose with your package manager first.
+The installation is basically the same. Podman v3.2 introduced a RESTful API that is 100% compatible with the Docker API, so you can use docker-compose with Podman easily. Install Podman and docker-compose with your package manager first.
 
 ```bash
 sudo dnf install podman docker-compose
@@ -38,9 +33,9 @@ systemctl enable --now podman.socket
 This will create a unix socket locate under `/run/podman/podman.sock`, which is the entrypoint of Podman's API. Now, configure docker-mailserver and start it.
 
 ```bash
-export DOCKER_HOST="unix:///run/podman/podman.sock"
-docker compose up -d mailserver
-docker compose ps
+export DOCKER_HOST="unix:/run/podman/podman.sock"
+docker-compose up -d mailserver
+docker-compose ps
 ```
 
 You should see that docker-mailserver is running now.
@@ -61,13 +56,12 @@ Running rootless containers is one of Podman's major features. But due to some r
 
 - a rootless container is running in a user namespace so you cannot bind ports lower than 1024
 - a rootless container's systemd file can only be placed in folder under `~/.config`
-- a rootless container can result in an open relay, make sure to read the [security section](#security-in-rootless-mode).
 
 Also notice that Podman's rootless mode is not about running as a non-root user inside the container, but about the mapping of (normal, non-root) host users to root inside the container.
 
 !!! warning
 
-    In order to make rootless DMS work we must modify some settings in the Linux system, it requires some basic linux server knowledge so don't follow this guide if you not sure what this guide is talking about. Podman rootfull mode and Docker are still good and security enough for normal daily usage.
+    In order to make rootless `docker-mailserver` work we must modify some settings in the Linux system, it requires some basic linux server knowledge so don't follow this guide if you not sure what this guide is talking about. Podman rootfull mode and Docker are still good and security enough for normal daily usage.
 
 First, enable `podman.socket` in systemd's userspace with a non-root user.
 
@@ -75,7 +69,7 @@ First, enable `podman.socket` in systemd's userspace with a non-root user.
 systemctl enable --now --user podman.socket
 ```
 
-The socket file should be located at `/var/run/user/$(id -u)/podman/podman.sock`. Then, modify `compose.yaml` to make sure all ports are bindings are on non-privileged ports.
+The socket file should be located at `/var/run/user/$(id -u)/podman/podman.sock`. Then, modify `docker-compose.yml` to make sure all ports are bindings are on non-privileged ports.
 
 ```yaml
 services:
@@ -88,48 +82,14 @@ services:
       - "10993:993"  # IMAP4 (implicit TLS)
 ```
 
-Then, setup your `mailserver.env` file follow the documentation and use Docker Compose to start the container.
+Then, setup your `mailserver.env` file follow the documentation and use docker-compose to start the container.
 
 ```bash
-export DOCKER_HOST="unix:///var/run/user/$(id -u)/podman/podman.sock"
-docker compose up -d mailserver
-docker compose ps
+export DOCKER_HOST="unix:/var/run/user/1000/podman/podman.sock"
+docker-compose up -d mailserver
+docker-compose ps
 ```
 
-### Security in Rootless Mode
-
-In rootless mode, podman resolves all incoming IPs as localhost, which results in an open gateway in the default configuration. There are two workarounds to fix this problem, both of which have their own drawbacks.
-
-#### Enforce authentication from localhost
-
-The `PERMIT_DOCKER` variable in the `mailserver.env` file allows to specify trusted networks that do not need to authenticate. If the variable is left empty, only requests from localhost and the container IP are allowed, but in the case of rootless podman any IP will be resolved as localhost. Setting `PERMIT_DOCKER=none` enforces authentication also from localhost, which prevents sending unauthenticated emails.
-
-#### Use the slip4netns network driver
-
-The second workaround is slightly more complicated because the `compose.yaml` has to be modified.
-As shown in the [fail2ban section][docs::fail2ban::rootless] the `slirp4netns` network driver has to be enabled.
-This network driver enables podman to correctly resolve IP addresses but it is not compatible with
-user defined networks which might be a problem depending on your setup.
-
-[Rootless Podman][rootless::podman] requires adding the value `slirp4netns:port_handler=slirp4netns` to the `--network` CLI option, or `network_mode` setting in your `compose.yaml`.
-
-You must also add the ENV `NETWORK_INTERFACE=tap0`, because Podman uses a [hard-coded interface name][rootless::podman::interface] for `slirp4netns`.
-
-!!! example
-
-    ```yaml
-    services:
-      mailserver:
-        network_mode: "slirp4netns:port_handler=slirp4netns"
-        environment:
-          - NETWORK_INTERFACE=tap0
-          ...
-    ```
-
-!!! note
-
-    `podman-compose` is not compatible with this configuration.
-
 ### Self-start in Rootless Mode
 
 Generate a systemd file with the Podman CLI.
@@ -150,7 +110,7 @@ Remember to run this command as root user.
 
 ### Port Forwarding
 
-When it comes to forwarding ports using `firewalld`, see [these port forwarding docs][firewalld-port-forwarding] for more information.
+When it comes to forwarding ports using `firewalld`, see <https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/securing_networks/using-and-configuring-firewalld_securing-networks#port-forwarding_using-and-configuring-firewalld> for more infomation.
 
 ```bash
 firewall-cmd --permanent --add-forward-port=port=<25|143|465|587|993>:proto=<tcp>:toport=<10025|10143|10465|10587|10993>
@@ -169,9 +129,4 @@ firewall-cmd --permanent --direct --add-rule <ipv4|ipv6> nat OUTPUT 0 -p <tcp|ud
 firewall-cmd --reload
 ```
 
-Just map all the privilege port with non-privilege port you set in compose.yaml before as root user.
-
-[docs::fail2ban::rootless]: ../security/fail2ban.md#rootless-container
-[rootless::podman]: https://github.com/containers/podman/blob/v3.4.1/docs/source/markdown/podman-run.1.md#--networkmode---net
-[rootless::podman::interface]: https://github.com/containers/podman/blob/v3.4.1/libpod/networking_slirp4netns.go#L264
-[firewalld-port-forwarding]: https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/securing_networks/using-and-configuring-firewalld_securing-networks#port-forwarding_using-and-configuring-firewalld
+Just map all the privilege port with non-privilege port you set in docker-compose.yml before as root user.

docs/content/config/best-practices/autodiscover.md

@@ -4,9 +4,7 @@ hide:
   - toc # Hide Table of Contents for this page
 ---
 
-# Auto-Discovery of Services
-
-Email auto-discovery means a client email is able to automagically find out about what ports and security options to use, based on the mail server URI. It can help simplify the tedious / confusing task of adding own's email account for non-tech savvy users.
+Email auto-discovery means a client email is able to automagically find out about what ports and security options to use, based on the mail-server URI. It can help simplify the tedious / confusing task of adding own's email account for non-tech savvy users.
 
 Email clients will search for auto-discoverable settings and prefill almost everything when a user enters its email address :heart:
 

docs/content/config/best-practices/dkim.md

@@ -0,0 +1,123 @@
+---
+title: 'Best Practices | DKIM'
+---
+
+DKIM is a security measure targeting email spoofing. It is greatly recommended one activates it.
+
+!!! note
+    See [the Wikipedia page](https://en.wikipedia.org/wiki/DomainKeys_Identified_Mail) for more details on DKIM.
+
+## Enabling DKIM Signature
+
+To enable DKIM signature, **you must have created at least one email account**. Once its done, just run the following command to generate the signature:
+
+```sh
+./setup.sh config dkim
+```
+
+After generating DKIM keys, you should restart `docker-mailserver`. DNS edits may take a few minutes to hours to propagate.
+
+The script should ideally be run with a volume for _config_ attached (eg: `./docker-data/dms/config/:/tmp/docker-mailserver/`), otherwise by default it will mount `./config/:/tmp/docker-mailserver/`.
+
+The default keysize when generating the signature is 4096 bits for now. If you need to change it (e.g. your DNS provider limits the size), then provide the size as the first parameter of the command:
+
+```sh
+./setup.sh config dkim keysize <keysize>
+```
+
+For LDAP systems that do not have any directly created user account you can run the following command (since `8.0.0`) to generate the signature by additionally providing the desired domain name (if you have multiple domains use the command multiple times or provide a comma-separated list of domains):
+
+```sh
+./setup.sh config dkim keysize <key-size> domain <example.com>[,<not-example.com>]
+```
+
+Now the keys are generated, you can configure your DNS server with DKIM signature, simply by adding a TXT record. If you have direct access to your DNS zone file, then it's only a matter of pasting the content of `docker-data/dms/config/opendkim/keys/example.com/mail.txt` in your `example.com.hosts` zone.
+
+```console
+$ dig mail._domainkey.example.com TXT
+---
+;; ANSWER SECTION
+mail._domainkey.<DOMAIN> 300 IN TXT    "v=DKIM1; k=rsa; p=AZERTYUIOPQSDFGHJKLMWXCVBN/AZERTYUIOPQSDFGHJKLMWXCVBN/AZERTYUIOPQSDFGHJKLMWXCVBN/AZERTYUIOPQSDFGHJKLMWXCVBN/AZERTYUIOPQSDFGHJKLMWXCVBN/AZERTYUIOPQSDFGHJKLMWXCVBN/AZERTYUIOPQSDFGHJKLMWXCVBN/AZERTYUIOPQSDFGHJKLMWXCVBN"
+```
+
+## Configuration using a Web Interface
+
+1. Generate a new record of the type `TXT`.
+2. Paste `mail._domainkey` the `Name` txt field.
+3. In the `Target` or `Value` field fill in `v=DKIM1; k=rsa; p=AZERTYUGHJKLMWX...`.
+4. In `TTL` (time to live): Time span in seconds. How long the DNS server should cache the `TXT` record.
+5. Save.
+
+!!! note
+    Sometimes the key in `docker-data/dms/config/opendkim/keys/example.com/mail.txt` can be on multiple lines. If so then you need to concatenate the values in the TXT record:
+
+```console
+$ dig mail._domainkey.example.com TXT
+---
+;; ANSWER SECTION
+mail._domainkey.<DOMAIN> 300 IN TXT "v=DKIM1; k=rsa; "
+    "p=AZERTYUIOPQSDF..."
+    "asdfQWERTYUIOPQSDF..."
+```
+
+The target (or value) field must then have all the parts together: `v=DKIM1; k=rsa; p=AZERTYUIOPQSDF...asdfQWERTYUIOPQSDF...`
+
+## Verify-Only
+
+If you want DKIM to only _verify_ incoming emails, the following version of `/etc/opendkim.conf` may be useful (right now there is no easy mechanism for installing it other than forking the repo):
+
+```conf
+# This is a simple config file verifying messages only
+
+#LogWhy                 yes
+Syslog                  yes
+SyslogSuccess           yes
+
+Socket                  inet:12301@localhost
+PidFile                 /var/run/opendkim/opendkim.pid
+
+ReportAddress           postmaster@example.com
+SendReports             yes
+
+Mode                    v
+```
+
+## Switch Off DKIM
+
+Simply remove the DKIM key by recreating (not just relaunching) the `docker-mailserver` container.
+
+## Debugging
+
+- [DKIM-verifer](https://addons.mozilla.org/en-US/thunderbird/addon/dkim-verifier): A add-on for the mail client Thunderbird.
+- You can debug your TXT records with the `dig` tool.
+
+```console
+$ dig TXT mail._domainkey.example.com
+---
+; <<>> DiG 9.10.3-P4-Debian <<>> TXT mail._domainkey.example.com
+;; global options: +cmd
+;; Got answer:
+;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 39669
+;; flags: qr rd ra; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 1
+
+;; OPT PSEUDOSECTION:
+; EDNS: version: 0, flags:; udp: 512
+;; QUESTION SECTION:
+;mail._domainkey.example.com. IN TXT
+
+;; ANSWER SECTION:
+mail._domainkey.example.com. 3600 IN TXT "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCxBSjG6RnWAdU3oOlqsdf2WC0FOUmU8uHVrzxPLW2R3yRBPGLrGO1++yy3tv6kMieWZwEBHVOdefM6uQOQsZ4brahu9lhG8sFLPX4MaKYN/NR6RK4gdjrZu+MYSdfk3THgSbNwIDAQAB"
+
+;; Query time: 50 msec
+;; SERVER: 127.0.1.1#53(127.0.1.1)
+;; WHEN: Wed Sep 07 18:22:57 CEST 2016
+;; MSG SIZE  rcvd: 310
+```
+
+---
+
+!!! warning "Key sizes >=4096-bit"
+
+    Keys of 4096 bits could de denied by some mail-servers. According to https://tools.ietf.org/html/rfc6376 keys are preferably between 512 and 2048 bits. See issue [#1854][github-issue-1854].
+
+[github-issue-1854]: https://github.com/docker-mailserver/docker-mailserver/issues/1854

docs/content/config/best-practices/dkim_dmarc_spf.md

@@ -1,385 +0,0 @@
-# DKIM, DMARC & SPF
-
-Cloudflare has written an [article about DKIM, DMARC and SPF][cloudflare-dkim-dmarc-spf] that we highly recommend you to read to get acquainted with the topic.
-
-!!! note "Rspamd vs Individual validators"
-
-    With v12.0.0, Rspamd was integrated into DMS. It can perform validations for DKIM, DMARC and SPF as part of the `spam-score-calculation` for an email. DMS provides individual alternatives for each validation that can be used instead of deferring to Rspamd:
-
-    - DKIM: `opendkim` is used as a milter (like Rspamd)
-    - DMARC: `opendmarc` is used as a milter (like Rspamd)
-    - SPF: `policyd-spf` is used in Postfix's `smtpd_recipient_restrictions`
-
-    In a future release Rspamd will become the default for these validations, with a deprecation notice issued prior to the removal of the above alternatives.
-
-    We encourage everyone to prefer Rspamd via `ENABLE_RSPAMD=1`.
-
-!!! warning "DNS Caches & Propagation"
-
-    While modern DNS providers are quick, it may take minutes or even hours for new DNS records to become available / propagate.
-
-## DKIM
-
-!!! quote "What is DKIM"
-
-    DomainKeys Identified Mail (DKIM) is an email authentication method designed to detect forged sender addresses in email (email spoofing), a technique often used in phishing and email spam.
-
-    [Source][wikipedia-dkim]
-
-When DKIM is enabled:
-
-1. Inbound mail will verify any included DKIM signatures
-2. Outbound mail is signed (_when your sending domain has a configured DKIM key_)
-
-DKIM requires a public/private key pair to enable **signing (_via private key_)** your outgoing mail, while the receiving end must query DNS to **verify (_via public key_)** that the signature is trustworthy.
-
-??? info "Verification expiry"
-
-    Unlike your TLS certificate, your DKIM keypair does not have a fixed expiry associated to it.
-
-
-    Instead, an expiry may be included in your DKIM signature for each mail sent, where a receiver will [refuse to validate the signature for an email after that expiry date][dkim-verification-expiry-refusal]. This is an added precaution to mitigate malicious activity like "DKIM replay attacks", where an already delivered email from a third-party with a trustworthy DKIM signature is leveraged by a spammer when sending mail to an MTA which verifies the DKIM signature successfully, enabling the spammer to bypass spam protections.
-
-    Unlike a TLS handshake where you are authenticating trust with future communications, with DKIM once the mail has been received and trust of the signature has been verified, the value of verifying the signature again at a later date is less meaningful since the signature was to ensure no tampering had occurred during delivery through the network.
-
-??? tip "DKIM key rotation"
-
-    You can rotate your DKIM keypair by switching to a new DKIM selector (_and DNS updates_), while the previous key and selector remains valid for verification until the last mail signed with that key reaches it's expiry.
-
-    DMS does not provide any automation or support for key rotation, [nor is it likely to provide a notable security benefit][gh-discussion::dkim-key-rotation-expiry] to the typical small scale DMS deployment.
-
-### Generating Keys
-
-You'll need to repeat this process if you add any new domains.
-
-You should have:
-
-- At least one [email account setup][docs-accounts]
-- Attached a [volume for config][docs-volumes-config] to persist the generated files to local storage
-
-!!! example "Creating DKIM Keys"
-
-    DKIM keys can be generated with good defaults by running:
-
-    ```bash
-    docker exec -it <CONTAINER NAME> setup config dkim
-    ```
-
-    If you need to generate your keys with different settings, check the `help` output for supported config options and examples:
-
-    ```bash
-    docker exec -it <CONTAINER NAME> setup config dkim help
-    ```
-
-    As described by the help output, you may need to use the `domain` option explicitly when you're using LDAP or Rspamd.
-
-??? info "Changing the key size"
-
-    The keypair generated for using with DKIM presently defaults to RSA-2048. This is a good size but you can lower the security to `1024-bit`, or increase it to `4096-bit` (_discouraged as that is excessive_).
-
-    To generate a key with different size (_for RSA 1024-bit_) run:
-
-    ```sh
-    setup config dkim keysize 1024
-    ```
-
-    !!! warning "RSA Key Sizes >= 4096 Bit"
-
-        According to [RFC 8301][rfc-8301], keys are preferably between 1024 and 2048 bits. Keys of size 4096-bit or larger may not be compatible to all systems your mail is intended for.
-
-        You [should not need a key length beyond 2048-bit][gh-issue::dkim-length]. If 2048-bit does not meet your security needs, you may want to instead consider adopting key rotation or switching from RSA to ECC keys for DKIM.
-
-??? note "You may need to specify mail domains explicitly"
-
-    Required when using LDAP and Rspamd.
-
-    `setup config dkim` will generate DKIM keys for what is assumed as the primary mail domain (_derived from the FQDN assigned to DMS, minus any subdomain_).
-
-    When the DMS FQDN is `mail.example.com` or `example.com`, by default this command will generate DKIM keys for `example.com` as the primary domain for your users mail accounts (eg: `hello@example.com`).
-
-    The DKIM generation does not have support to query LDAP for additional mail domains it should know about. If the primary mail domain is not sufficient, then you must explicitly specify any extra domains via the `domain` option:
-
-    ```sh
-    # ENABLE_OPENDKIM=1 (default):
-    setup config dkim domain 'example.com,another-example.com'
-
-    # ENABLE_RSPAMD=1 + ENABLE_OPENDKIM=0:
-    setup config dkim domain example.com
-    setup config dkim domain another-example.com
-    ```
-
-    !!! info "OpenDKIM with `ACCOUNT_PROVISIONER=FILE`"
-
-        When DMS uses this configuration, it will by default also detect mail domains (_from accounts added via `setup email add`_), generating additional DKIM keys.
-
-DKIM is currently supported by either OpenDKIM or Rspamd:
-
-=== "OpenDKIM"
-
-    OpenDKIM is currently [enabled by default][docs-env-opendkim].
-
-    After running `setup config dkim`, your new DKIM key files (_and OpenDKIM config_) have been added to `/tmp/docker-mailserver/opendkim/`.
-
-    !!! info "Restart required"
-
-        After restarting DMS, outgoing mail will now be signed with your new DKIM key(s) :tada:
-
-=== "Rspamd"
-
-    Requires opt-in via [`ENABLE_RSPAMD=1`][docs-env-rspamd] (_and disable the default OpenDKIM: `ENABLE_OPENDKIM=0`_).
-
-    Rspamd provides DKIM support through two separate modules:
-
-    1. [Verifying DKIM signatures from inbound mail][rspamd-docs-dkim-checks] is enabled by default.
-    2. [Signing outbound mail with your DKIM key][rspamd-docs-dkim-signing] needs additional setup (key + dns + config).
-
-    ??? warning "Using Multiple Domains"
-
-        If you have multiple domains, you need to:
-
-        - Create a key wth `docker exec -it <CONTAINER NAME> setup config dkim domain <DOMAIN>` for each domain DMS should sign outgoing mail for.
-        - Provide a custom `dkim_signing.conf` (for which an example is shown below), as the default config only supports one domain.
-
-    !!! info "About the Helper Script"
-
-        The script will persist the keys in `/tmp/docker-mailserver/rspamd/dkim/`. Hence, if you are already using the default volume mounts, the keys are persisted in a volume. The script also restarts Rspamd directly, so changes take effect without restarting DMS.
-
-        The script provides you with log messages along the way of creating keys. In case you want to read the complete log, use `-v` (verbose) or `-vv` (very verbose).
-
-        ---
-
-        In case you have not already provided a default DKIM signing configuration, the script will create one and write it to `/etc/rspamd/override.d/dkim_signing.conf`. If this file already exists, it will not be overwritten.
-
-        When you're already using [the `rspamd/override.d/` directory][docs-rspamd-config-dropin], the file is created inside your volume and therefore persisted correctly. If you are not using `rspamd/override.d/`, you will need to persist the file yourself (otherwise it is lost on container restart).
-
-        An example of what a default configuration file for DKIM signing looks like can be found by expanding the example below.
-
-    ??? example "DKIM Signing Module Configuration Examples"
-
-        A simple configuration could look like this:
-
-        ```cf
-        # documentation: https://rspamd.com/doc/modules/dkim_signing.html
-
-        enabled = true;
-
-        sign_authenticated = true;
-        sign_local = true;
-
-        use_domain = "header";
-        use_redis = false; # don't change unless Redis also provides the DKIM keys
-        use_esld = true;
-        check_pubkey = true; # you want to use this in the beginning
-
-        selector = "mail";
-        # The path location is searched for a DKIM key with these variables:
-        # - `$domain` is sourced from the MIME mail message `From` header
-        # - `$selector` is configured for `mail` (as a default fallback)
-        path = "/tmp/docker-mailserver/dkim/keys/$domain/$selector.private";
-
-        # domain specific configurations can be provided below:
-        domain {
-            example.com {
-                path = "/tmp/docker-mailserver/rspamd/dkim/mail.private";
-                selector = "mail";
-            }
-        }
-        ```
-
-        As shown next:
-
-        - You can add more domains into the `domain { ... }` section (in the following example: `example.com` and `example.org`).
-        - A domain can also be configured with multiple selectors and keys within a `selectors [ ... ]` array (in the following example, this is done for `example.org`).
-
-        ```cf
-        # ...
-
-        domain {
-            example.com {
-                path = /tmp/docker-mailserver/rspamd/example.com/ed25519.private";
-                selector = "dkim-ed25519";
-            }
-            example.org {
-                selectors [
-                    {
-                        path = "/tmp/docker-mailserver/rspamd/dkim/example.org/rsa.private";
-                        selector = "dkim-rsa";
-                    },
-                    {
-                        path = "/tmp/docker-mailserver/rspamd/dkim/example.org/ed25519.private";
-                        selector = "dkim-ed25519";
-                    }
-                ]
-            }
-        }
-        ```
-
-    ??? warning "Support for DKIM Keys using ED25519"
-
-        This modern elliptic curve is supported by Rspamd, but support by third-parties for [verifying Ed25519 DKIM signatures is unreliable][dkim-ed25519-support].
-
-        If you sign your mail with this key type, you should include RSA as a fallback, like shown in the above example.
-
-    ??? tip "Let Rspamd Check Your Keys"
-
-        When `check_pubkey = true;` is set, Rspamd will query the DNS record for each DKIM selector, verifying each public key matches the private key configured.
-
-        If there is a mismatch, a warning will be emitted to the Rspamd log `/var/log/mail/rspamd.log`.
-
-### DNS Record { #dkim-dns }
-
-When mail signed with your DKIM key is sent from your mail server, the receiver needs to check a DNS `TXT` record to verify the DKIM signature is trustworthy.
-
-!!! example "Configuring DNS - DKIM record"
-
-    When you generated your key in the previous step, the DNS data was saved into a file `<selector>.txt` (default: `mail.txt`). Use this content to update your [DNS via Web Interface][dns::example-webui] or directly edit your [DNS Zone file][dns::wikipedia-zonefile]:
-
-    === "Web Interface"
-
-        Create a new record:
-
-        | Field | Value                                                                          |
-        | ----- | ------------------------------------------------------------------------------ |
-        | Type  | `TXT`                                                                          |
-        | Name  | `<selector>._domainkey` (_default: `mail._domainkey`_)                         |
-        | TTL   | Use the default (_otherwise [3600 seconds is appropriate][dns::digicert-ttl]_) |
-        | Data  | File content within `( ... )` (_formatted as advised below_)                   |
-
-        When using Rspamd, the helper script has already provided you with the contents (the "Data" field) of the DNS record you need to create - you can just copy-paste this text.
-
-    === "DNS Zone file"
-
-        `<selector>.txt` is already formatted as a snippet for adding to your [DNS Zone file][dns::wikipedia-zonefile].
-
-        Just copy/paste the file contents into your existing DNS zone. The `TXT` value has been split into separate strings every 255 characters for compatibility.
-
-??? info "`<selector>.txt` - Formatting the `TXT` record value correctly"
-
-    This file was generated for use within a [DNS zone file][dns::wikipedia-zonefile]. The file name uses the DKIM selector it was generated with (default DKIM selector is `mail`, which creates `mail.txt`_).
-
-    For your DNS setup, DKIM support needs to create a `TXT` record to store the public key for mail clients to use. `TXT` records with values that are longer than 255 characters need to be split into multiple parts. This is why the generated `<selector>.txt` file (_containing your public key for use with DKIM_) has multiple value parts wrapped within double-quotes between `(` and `)`.
-
-    A DNS web-interface may handle this separation internally instead, and [could expect the value provided all as a single line][dns::webui-dkim] instead of split. When that is required, you'll need to manually format the value as described below.
-
-    Your generated DNS record file (`<selector>.txt`) should look similar to this:
-
-    ```txt
-    mail._domainkey IN TXT ( "v=DKIM1; k=rsa; "
-    "p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqQMMqhb1S52Rg7VFS3EC6JQIMxNDdiBmOKZvY5fiVtD3Z+yd9ZV+V8e4IARVoMXWcJWSR6xkloitzfrRtJRwOYvmrcgugOalkmM0V4Gy/2aXeamuiBuUc4esDQEI3egmtAsHcVY1XCoYfs+9VqoHEq3vdr3UQ8zP/l+FP5UfcaJFCK/ZllqcO2P1GjIDVSHLdPpRHbMP/tU1a9mNZ"
-    "5QMZBJ/JuJK/s+2bp8gpxKn8rh1akSQjlynlV9NI+7J3CC7CUf3bGvoXIrb37C/lpJehS39KNtcGdaRufKauSfqx/7SxA0zyZC+r13f7ASbMaQFzm+/RRusTqozY/p/MsWx8QIDAQAB"
-    ) ;
-    ```
-
-    Take the content between `( ... )`, and combine all the quote wrapped content and remove the double-quotes including the white-space between them. That is your `TXT` record value, the above example would become this:
-
-    ```txt
-    v=DKIM1; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqQMMqhb1S52Rg7VFS3EC6JQIMxNDdiBmOKZvY5fiVtD3Z+yd9ZV+V8e4IARVoMXWcJWSR6xkloitzfrRtJRwOYvmrcgugOalkmM0V4Gy/2aXeamuiBuUc4esDQEI3egmtAsHcVY1XCoYfs+9VqoHEq3vdr3UQ8zP/l+FP5UfcaJFCK/ZllqcO2P1GjIDVSHLdPpRHbMP/tU1a9mNZ5QMZBJ/JuJK/s+2bp8gpxKn8rh1akSQjlynlV9NI+7J3CC7CUf3bGvoXIrb37C/lpJehS39KNtcGdaRufKauSfqx/7SxA0zyZC+r13f7ASbMaQFzm+/RRusTqozY/p/MsWx8QIDAQAB
-    ```
-
-    To test that your new DKIM record is correct, query it with the `dig` command. The `TXT` value response should be a single line split into multiple parts wrapped in double-quotes:
-
-    ```console
-    $ dig +short TXT mail._domainkey.example.com
-    "v=DKIM1; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqQMMqhb1S52Rg7VFS3EC6JQIMxNDdiBmOKZvY5fiVtD3Z+yd9ZV+V8e4IARVoMXWcJWSR6xkloitzfrRtJRwOYvmrcgugOalkmM0V4Gy/2aXeamuiBuUc4esDQEI3egmtAsHcVY1XCoYfs+9VqoHEq3vdr3UQ8zP/l+FP5UfcaJFCK/ZllqcO2P1GjIDVSHLdPpRHbMP/tU1a9mNZ5QMZBJ/JuJK/s+2bp8gpxKn8rh1akSQjlynlV9NI+7J3CC7CUf3bGvoXIrb37C/lpJehS39" "KNtcGdaRufKauSfqx/7SxA0zyZC+r13f7ASbMaQFzm+/RRusTqozY/p/MsWx8QIDAQAB"
-    ```
-
-### Troubleshooting { #dkim-debug }
-
-[MxToolbox has a DKIM Verifier][mxtoolbox-dkim-verifier] that you can use to check your DKIM DNS record(s).
-
-When using Rspamd, we recommend you turn on `check_pubkey = true;` in `dkim_signing.conf`. Rspamd will then check whether your private key matches your public key, and you can check possible mismatches by looking at `/var/log/mail/rspamd.log`.
-
-## DMARC
-
-With DMS, DMARC is pre-configured out of the box. You may disable extra and excessive DMARC checks when using Rspamd via `ENABLE_OPENDMARC=0`.
-
-The only thing you need to do in order to enable DMARC on a "DNS-level" is to add new `TXT`. In contrast to [DKIM](#dkim), DMARC DNS entries do not require any keys, but merely setting the [configuration values][dmarc-howto-configtags]. You can either handcraft the entry by yourself or use one of available generators (like [this one][dmarc-tool-gca]).
-
-Typically something like this should be good to start with:
-
-```txt
-_dmarc.example.com. IN TXT "v=DMARC1; p=none; sp=none; fo=0; adkim=r; aspf=r; pct=100; rf=afrf; ri=86400; rua=mailto:dmarc.report@example.com; ruf=mailto:dmarc.report@example.com"
-```
-
-Or a bit more strict policies (_mind `p=quarantine` and `sp=quarantine`_):
-
-```txt
-_dmarc.example.com. IN TXT "v=DMARC1; p=quarantine; sp=quarantine; fo=0; adkim=r; aspf=r; pct=100; rf=afrf; ri=86400; rua=mailto:dmarc.report@example.com; ruf=mailto:dmarc.report@example.com"
-```
-
-The DMARC status may not be displayed instantly due to delays in DNS (caches). Dmarcian has [a few tools][dmarcian-tools] you can use to verify your DNS records.
-
-## SPF
-
-!!! quote "What is SPF"
-
-    Sender Policy Framework (SPF) is a simple email-validation system designed to detect email spoofing by providing a mechanism to allow receiving mail exchangers to check that incoming mail from a domain comes from a host authorized by that domain's administrators.
-
-    [Source][wikipedia-spf]
-
-!!! tip "Disabling the default SPF service `policy-spf`"
-
-    Set [`ENABLE_POLICYD_SPF=0`][docs-env-spf-policyd] to opt-out of the default SPF service. Advised when Rspamd is configured to handle SPF instead.
-
-### Adding an SPF Record
-
-To add a SPF record in your DNS, insert the following line in your DNS zone:
-
-```txt
-example.com. IN TXT "v=spf1 mx ~all"
-```
-
-This enables the _Softfail_ mode for SPF. You could first add this SPF record with a very low TTL. _SoftFail_ is a good setting for getting started and testing, as it lets all email through, with spams tagged as such in the mailbox.
-
-After verification, you _might_ want to change your SPF record to `v=spf1 mx -all` so as to enforce the _HardFail_ policy. See <http://www.open-spf.org/SPF_Record_Syntax> for more details about SPF policies.
-
-In any case, increment the SPF record's TTL to its final value.
-
-### Backup MX & Secondary MX for `policyd-spf`
-
-For whitelisting an IP Address from the SPF test, you can create a config file (see [`policyd-spf.conf`](https://www.linuxcertif.com/man/5/policyd-spf.conf)) and mount that file into `/etc/postfix-policyd-spf-python/policyd-spf.conf`.
-
-**Example:** Create and edit a `policyd-spf.conf` file at `docker-data/dms/config/postfix-policyd-spf.conf`:
-
-```conf
-debugLevel = 1
-#0(only errors)-4(complete data received)
-
-skip_addresses = 127.0.0.0/8,::ffff:127.0.0.0/104,::1
-
-# Preferably use IP-Addresses for whitelist lookups:
-Whitelist = 192.168.0.0/31,192.168.1.0/30
-# Domain_Whitelist = mx1.not-example.com,mx2.not-example.com
-```
-
-Then add this line to `compose.yaml`:
-
-```yaml
-volumes:
-  - ./docker-data/dms/config/postfix-policyd-spf.conf:/etc/postfix-policyd-spf-python/policyd-spf.conf
-```
-
-[docs-accounts]: ../account-management/overview.md#accounts
-[docs-volumes-config]: ../advanced/optional-config.md#volumes-config
-[docs-env-opendkim]: ../environment.md#enable_opendkim
-[docs-env-rspamd]: ../environment.md#enable_rspamd
-[docs-env-spf-policyd]: ../environment.md#enable_policyd_spf
-[docs-rspamd-config-dropin]: ../security/rspamd.md#manually
-[cloudflare-dkim-dmarc-spf]: https://www.cloudflare.com/learning/email-security/dmarc-dkim-spf/
-[rfc-8301]: https://datatracker.ietf.org/doc/html/rfc8301#section-3.2
-[gh-discussion::dkim-key-rotation-expiry]: https://github.com/orgs/docker-mailserver/discussions/4068#discussioncomment-9784263
-[gh-issue::dkim-length]: https://github.com/docker-mailserver/docker-mailserver/issues/1854#issuecomment-806280929
-[rspamd-docs-dkim-checks]: https://www.rspamd.com/doc/modules/dkim.html
-[rspamd-docs-dkim-signing]: https://www.rspamd.com/doc/modules/dkim_signing.html
-[dns::example-webui]: https://www.vultr.com/docs/introduction-to-vultr-dns/
-[dns::digicert-ttl]: https://www.digicert.com/faq/dns/what-is-ttl
-[dns::wikipedia-zonefile]: https://en.wikipedia.org/wiki/Zone_file
-[dns::webui-dkim]: https://serverfault.com/questions/763815/route-53-doesnt-allow-adding-dkim-keys-because-length-is-too-long
-[dkim-ed25519-support]: https://serverfault.com/questions/1023674/is-ed25519-well-supported-for-the-dkim-validation/1074545#1074545
-[dkim-verification-expiry-refusal]: https://mxtoolbox.com/problem/dkim/dkim-signature-expiration
-[mxtoolbox-dkim-verifier]: https://mxtoolbox.com/dkim.aspx
-[dmarc-howto-configtags]: https://github.com/internetstandards/toolbox-wiki/blob/master/DMARC-how-to.md#overview-of-dmarc-configuration-tags
-[dmarc-tool-gca]: https://dmarcguide.globalcyberalliance.org
-[dmarcian-tools]: https://dmarcian.com/dmarc-tools/
-[wikipedia-dkim]: https://en.wikipedia.org/wiki/DomainKeys_Identified_Mail
-[wikipedia-spf]: https://en.wikipedia.org/wiki/Sender_Policy_Framework

docs/content/config/best-practices/dmarc.md

@@ -0,0 +1,36 @@
+---
+title: 'Best Practices | DMARC'
+hide:
+  - toc # Hide Table of Contents for this page
+---
+
+More information at [DMARC Guide][dmarc-howto].
+
+## Enabling DMARC
+
+In `docker-mailserver`, DMARC is pre-configured out of the box. The only thing you need to do in order to enable it, is to add new `TXT` entry to your DNS.
+
+In contrast with [DKIM][docs-dkim], the DMARC DNS entry does not require any keys, but merely setting the [configuration values][dmarc-howto-configtags]. You can either handcraft the entry by yourself or use one of available generators (like [this one][dmarc-tool::gca]).
+
+Typically something like this should be good to start with (_don't forget to replace `@example.com` to your actual domain_):
+
+```
+_dmarc.example.com. IN TXT "v=DMARC1; p=none; rua=mailto:dmarc.report@example.com; ruf=mailto:dmarc.report@example.com; sp=none; ri=86400"
+```
+
+Or a bit more strict policies (_mind `p=quarantine` and `sp=quarantine`_):
+
+```
+_dmarc IN TXT "v=DMARC1; p=quarantine; rua=mailto:dmarc.report@example.com; ruf=mailto:dmarc.report@example.com; fo=0; adkim=r; aspf=r; pct=100; rf=afrf; ri=86400; sp=quarantine"
+```
+
+DMARC status is not being displayed instantly in Gmail for instance. If you want to check it directly after DNS entries, you can use some services around the Internet such as from [Global Cyber Alliance][dmarc-tool::gca] or [RedSift][dmarc-tool::redsift]. In other cases, email clients will show "DMARC: PASS" in ~1 day or so.
+
+Reference: [#1511][github-issue-1511]
+
+[docs-dkim]: ./dkim.md
+[github-issue-1511]: https://github.com/docker-mailserver/docker-mailserver/issues/1511
+[dmarc-howto]: https://github.com/internetstandards/toolbox-wiki/blob/master/DMARC-how-to.md
+[dmarc-howto::configtags]: https://github.com/internetstandards/toolbox-wiki/blob/master/DMARC-how-to.md#overview-of-dmarc-configuration-tags
+[dmarc-tool::gca]: https://dmarcguide.globalcyberalliance.org
+[dmarc-tool::redsift]: https://ondmarc.redsift.com

docs/content/config/best-practices/mta-sts.md

@@ -1,30 +0,0 @@
----
-title: 'Best practices | MTA-STS'
-hide:
-  - toc # Hide Table of Contents for this page
----
-
-MTA-STS is an optional mechanism for a domain to signal support for STARTTLS.
-
-- It can be used to prevent man-in-the-middle-attacks from hiding STARTTLS support that would force DMS to send outbound mail through an insecure connection.
-- MTA-STS is an alternative to DANE without the need of DNSSEC.
-- MTA-STS is supported by some of the biggest mail providers like Google Mail and Outlook.
-
-## Supporting MTA-STS for outbound mail
-
-Enable this feature via the ENV setting [`ENABLE_MTA_STS=1`](../environment.md#enable_mta_sts).
-
-!!! warning "If you have configured DANE"
-
-    Enabling MTA-STS will by default override DANE if both are configured for a domain.
-
-    This can be partially addressed by configuring a dane-only policy resolver before the MTA-STS entry in `smtp_tls_policy_maps`. See the [`postfix-mta-sts-resolver` documentation][postfix-mta-sts-resolver::dane] for further details.
-
-[postfix-mta-sts-resolver::dane]: https://github.com/Snawoot/postfix-mta-sts-resolver#warning-mta-sts-policy-overrides-dane-tls-authentication
-
-## Supporting MTA-STS for inbound mail
-
-While this feature in DMS supports ensuring STARTTLS is used when mail is sent to another mail server, you may setup similar for mail servers sending mail to DMS.
-
-This requires configuring your DNS and hosting the MTA-STS policy file via a webserver. A good introduction can be found on [dmarcian.com](https://dmarcian.com/mta-sts/).
-

docs/content/config/best-practices/spf.md

@@ -0,0 +1,59 @@
+---
+title: 'Best Practices | SPF'
+hide:
+  - toc # Hide Table of Contents for this page
+---
+
+From [Wikipedia](https://en.wikipedia.org/wiki/Sender_Policy_Framework):
+
+!!! quote
+    Sender Policy Framework (SPF) is a simple email-validation system designed to detect email spoofing by providing a mechanism to allow receiving mail exchangers to check that incoming mail from a domain comes from a host authorized by that domain's administrators. The list of authorized sending hosts for a domain is published in the Domain Name System (DNS) records for that domain in the form of a specially formatted TXT record. Email spam and phishing often use forged "from" addresses, so publishing and checking SPF records can be considered anti-spam techniques.
+
+!!! note
+    For a more technical review: https://github.com/internetstandards/toolbox-wiki/blob/master/SPF-how-to.md
+
+## Add a SPF Record
+
+To add a SPF record in your DNS, insert the following line in your DNS zone:
+
+```txt
+; MX record must be declared for SPF to work
+example.com. IN  MX 1 mail.example.com.
+
+; SPF record
+example.com. IN TXT "v=spf1 mx ~all"
+```
+
+This enables the _Softfail_ mode for SPF. You could first add this SPF record with a very low TTL.
+
+_SoftFail_ is a good setting for getting started and testing, as it lets all email through, with spams tagged as such in the mailbox.
+
+After verification, you _might_ want to change your SPF record to `v=spf1 mx -all` so as to enforce the _HardFail_ policy. See http://www.open-spf.org/SPF_Record_Syntax for more details about SPF policies.
+
+In any case, increment the SPF record's TTL to its final value.
+
+## Backup MX, Secondary MX
+
+For whitelisting a IP Address from the SPF test, you can create a config file (see [`policyd-spf.conf`](https://www.linuxcertif.com/man/5/policyd-spf.conf)) and mount that file into `/etc/postfix-policyd-spf-python/policyd-spf.conf`.
+
+**Example:**
+
+Create and edit a `policyd-spf.conf` file at `docker-data/dms/config/postfix-policyd-spf.conf`:
+
+```conf
+debugLevel = 1
+#0(only errors)-4(complete data received)
+
+skip_addresses = 127.0.0.0/8,::ffff:127.0.0.0/104,::1
+
+# Preferably use IP-Addresses for whitelist lookups:
+Whitelist = 192.168.0.0/31,192.168.1.0/30
+# Domain_Whitelist = mx1.not-example.com,mx2.not-example.com
+```
+
+Then add this line to `docker-compose.yml`:
+
+```yaml
+volumes:
+  - ./docker-data/dms/config/postfix-policyd-spf.conf:/etc/postfix-policyd-spf-python/policyd-spf.conf
+```

docs/content/config/debugging.md

@@ -1,137 +0,0 @@
----
-title: 'Debugging'
-hide:
-    - toc
----
-
-This page contains valuable information when it comes to resolving issues you encounter.
-
-!!! info "Contributions Welcome!"
-
-    Please consider contributing solutions to the [FAQ][docs-faq] :heart:
-
-## Preliminary Checks
-
-- Check that all published DMS ports are actually open and not blocked by your ISP / hosting provider.
-- SSL errors are likely the result of a wrong setup on the user side and not caused by DMS itself.
-- Ensure that you have correctly started DMS. Many problems related to configuration are due to this.
-
-!!! danger "Correctly starting DMS"
-
-    Use the [`--force-recreate`][docker-docs::force-recreate] option to avoid configuration mishaps: `docker compose up --force-recreate`
-
-    Alternatively, always use `docker compose down` to stop DMS. **Do not** rely on `CTRL + C`, `docker compose stop`, or `docker compose restart`.
-
-    ---
-
-    DMS setup scripts are run when a container starts, but may fail to work properly if you do the following:
-
-    - Stopping a container with commands like: `docker stop` or `docker compose up` stopped via `CTRL + C` instead of `docker compose down`.
-    - Restarting a container.
-
-    Volumes persist data across container instances, however the same container instance will keep internal changes not stored in a volume until the container is removed.
-
-    Due to this, DMS setup scripts may modify configuration it has already modified in the past.
-
-    - This is brittle as some changes are naive by assuming they are applied to the original configs from the image.
-    - Volumes in `compose.yaml` are expected to persist any important data. Thus it should be safe to throwaway the container created each time, avoiding this config problem.
-
-### Mail sent from DMS does not arrive at destination
-
-Some service providers block outbound traffic on port 25. 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/)
-- [Vultr](https://www.vultr.com/docs/what-ports-are-blocked/)
-
-These links may advise how the provider can unblock the port through additional services offered, or via a support ticket request.
-
-### Mail sent to DMS does not get delivered to user
-
-Common logs related to this are:
-
-- `warning: do not list domain domain.fr in BOTH mydestination and virtual_mailbox_domains`
-- `Recipient address rejected: User unknown in local recipient table`
-
-If your logs look like this, you likely have [assigned the same FQDN to the DMS `hostname` and your mail accounts][gh-issues::dms-fqdn-misconfigured] which is not supported by default. You can either adjust your DMS `hostname` or follow [this FAQ advice][docs::faq-bare-domain]
-
-It is also possible that [DMS services are temporarily unavailable][gh-issues::dms-services-unavailable] when configuration changes are detected, producing the 2nd error. Certificate updates may be a less obvious trigger.
-
-## Steps for Debugging DMS
-
-1. **Increase log verbosity**: Very helpful for troubleshooting problems during container startup. Set the environment variable [`LOG_LEVEL`][docs-environment-log-level] to `debug` or `trace`.
-2. **Use error logs as a search query**: Try [finding an _existing issue_][gh-issues] or _search engine result_ from any errors in your container log output. Often you'll find answers or more insights. If you still need to open an issue, sharing links from your search may help us assist you. The mail server log can be acquired by running `docker log <CONTAINER NAME>` (_or `docker logs -f <CONTAINER NAME>` if you want to follow the log_).
-3. **Inspect the logs of the service that is failing**: We provide a dedicated paragraph on this topic [further down below](#logs).
-4. **Understand the basics of mail servers**: Especially for beginners, make sure you read our [Introduction][docs-introduction] and [Usage][docs-usage] articles.
-5. **Search the whole FAQ**: Our [FAQ][docs-faq] contains answers for common problems. Make sure you go through the list.
-6. **Reduce the scope**: Ensure that you can run a basic setup of DMS first. Then incrementally restore parts of your original configuration until the problem is reproduced again. If you're new to DMS, it is common to find the cause is misunderstanding how to configure a minimal setup.
-
-### Debug a running container
-
-#### General
-
-To get a shell inside the container run: `docker exec -it <CONTAINER NAME> bash`. To install additional software, run:
-
-1. `apt-get update` to update repository metadata.
-2. `apt-get install <PACKAGE>` to install a package, e.g., `apt-get install neovim` if you want to use NeoVim instead of `nano` (which is shipped by default).
-
-#### Logs
-
-If you need more flexibility than what the `docker logs` command offers, then the most useful locations to get relevant DMS logs within the container are:
-
-- `/var/log/mail/<SERVICE>.log`
-- `/var/log/supervisor/<SERVICE>.log`
-
-You may use `nano` (a text editor) to edit files, while `less` (a file viewer) and `tail`/`cat` are useful tools to inspect the contents of logs.
-
-## Compatibility
-
-It's possible that the issue you're experiencing is due to a compatibility conflict.
-
-This could be from outdated software, or running a system that isn't able to provide you newer software and kernels. You may want to verify if you can reproduce the issue on a system that is not affected by these concerns.
-
-### Network
-
-- Misconfigured network connections can cause the client IP address to be proxied through a docker network gateway IP, or a [service that acts on behalf of connecting clients for logins][gh-discuss-roundcube-fail2ban] where the connections client IP appears to be only from that service (eg: Container IP) instead. This can relay the wrong information to other services (eg: monitoring like Fail2Ban, SPF verification) causing unexpected failures.
-- **`userland-proxy`:** Prior to Docker `v23`, [changing the `userland-proxy` setting did not reliably remove NAT rules][network::docker-userlandproxy].
-- **UFW / firewalld:** Some users expect only their firewall frontend to manage the firewall rules, but these will be bypassed when Docker publishes a container port (_as there is no integration between the two_).
-- **`iptables` / `nftables`:**
-    - Docker [only manages the NAT rules via `iptables`][network::docker-nftables], relying on compatibility shims for supporting the successor `nftables`. Internally DMS expects `nftables` support on the host kernel for services like Fail2Ban to function correctly.
-    - [Kernels older than 5.2 may affect management of NAT rules via `nftables`][network::kernel-nftables]. Other software outside of DMS may also manipulate these rules, such as firewall frontends.
-- **IPv6:**
-    - Requires [additional configuration][docs-ipv6] to prevent or properly support IPv6 connections (eg: Preserving the Client IP).
-    - Support in 2023 is still considered experimental. You are advised to use at least Docker Engine `v23` (2023Q1).
-    - Various networking bug fixes have been addressed since the initial IPv6 support arrived in Docker Engine `v20.10.0` (2020Q4).
-
-### System
-
-- **macOS:** DMS has limited support for macOS. Often an issue encountered is due to permissions related to the `volumes` config in `compose.yaml`. You may have luck [trying `gRPC FUSE`][gh-macos-support] as the file sharing implementation; [`VirtioFS` is the successor][docker-macos-virtiofs] but presently appears incompatible with DMS.
-- **Kernel:** Some systems provide [kernels with modifications (_replacing defaults and backporting patches_)][network::kernels-modified] to support running legacy software or kernels, complicating compatibility. This can be commonly experienced with products like NAS.
-- **CGroups v2:** Hosts running older kernels (prior to 5.2) and systemd (prior to v244) are not likely to leverage cgroup v2, or have not defaulted to the cgroup v2 `unified` hierarchy. Not meeting this baseline may influence the behavior of your DMS container, even with the latest Docker Engine installed.
-- **Container runtime:** Docker and Podman for example have subtle differences. DMS docs are primarily focused on Docker, but we try to document known issues where relevant.
-- **Rootless containers:** Introduces additional differences in behavior or requirements:
-    - cgroup v2 is required for supporting rootless containers.
-    - Differences such as for container networking which may further affect support for IPv6 and preserving the client IP (Remote address). Example with Docker rootless are [binding a port to a specific interface][docker-rootless-interface] and the choice of [port forwarding driver][docs::fail2ban::rootless-portdriver].
-
-[network::docker-userlandproxy]: https://github.com/moby/moby/issues/44721
-[network::docker-nftables]: https://github.com/moby/moby/issues/26824
-[network::kernels-modified]: https://github.com/docker-mailserver/docker-mailserver/pull/2662#issuecomment-1168435970
-[network::kernel-nftables]: https://unix.stackexchange.com/questions/596493/can-nftables-and-iptables-ip6tables-rules-be-applied-at-the-same-time-if-so-wh/596497#596497
-
-[docs-environment-log-level]: ./environment.md#log_level
-[docs-faq]: ../faq.md
-[docs::faq-bare-domain]: ../faq.md#can-i-use-a-nakedbare-domain-ie-no-hostname
-[docs-ipv6]: ./advanced/ipv6.md
-[docs-introduction]: ../introduction.md
-[docs::fail2ban::rootless-portdriver]: ./security/fail2ban.md#rootless-container
-[docs-usage]: ../usage.md
-
-[gh-issues]: https://github.com/docker-mailserver/docker-mailserver/issues
-[gh-issues::dms-fqdn-misconfigured]: https://github.com/docker-mailserver/docker-mailserver/issues/3679#issuecomment-1837609043
-[gh-issues::dms-services-unavailable]: https://github.com/docker-mailserver/docker-mailserver/issues/3679#issuecomment-1848083358
-[gh-macos-support]: https://github.com/docker-mailserver/docker-mailserver/issues/3648#issuecomment-1822774080
-[gh-discuss-roundcube-fail2ban]: https://github.com/orgs/docker-mailserver/discussions/3273#discussioncomment-5654603
-
-[docker-rootless-interface]: https://github.com/moby/moby/issues/45742
-[docker-macos-virtiofs]: https://www.docker.com/blog/speed-boost-achievement-unlocked-on-docker-desktop-4-6-for-mac/
-[docker-docs::force-recreate]: https://docs.docker.com/compose/reference/up/

docs/content/config/environment.md

@@ -4,22 +4,19 @@ title: Environment Variables
 
 !!! info
 
-    Values in **bold** are the default values. If an option doesn't work as documented here, check if you are running the latest image. The current `master` branch corresponds to the image `ghcr.io/docker-mailserver/docker-mailserver:edge`.
+    Values in **bold** are the default values. If an option doesn't work as documented here, check if you are running the latest image. The current `master` branch corresponds to the image `mailserver/docker-mailserver:edge`.
 
 #### General
 
 ##### OVERRIDE_HOSTNAME
 
-If you can't set your hostname (_eg: you're in a container platform that doesn't let you_) specify it via this environment variable. It will have priority over `docker run --hostname`, or the equivalent `hostname:` field in `compose.yaml`.
+- **empty** => uses the `hostname` command to get canonical hostname for `docker-mailserver` to use.
+- => 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 (_eg: you're in a container platform that doesn't let you_) specify it via this environment variable. It will take priority over `docker run` options: `--hostname` and `--domainname`, or `docker-compose.yml` config equivalents: `hostname:` and `domainname:`.
 
-- **empty** => Uses the `hostname -f` command to get canonical hostname for DMS to use.
-- => Specify an FQDN (fully-qualified domain name) to serve mail for. The hostname is required for DMS to function correctly.
+##### DMS_DEBUG
 
-##### LOG_LEVEL
-
-Set the log level for DMS. This is mostly relevant for container startup scripts and change detection event feedback.
-
-Valid values (in order of increasing verbosity) are: `error`, `warn`, `info`, `debug` and `trace`. The default log level is `info`.
+- **0** => Debug disabled
+- 1     => Enables debug on startup
 
 ##### SUPERVISOR_LOGLEVEL
 
@@ -33,49 +30,22 @@ Here you can adjust the [log-level for Supervisor](http://supervisord.org/loggin
 
 The log-level will show everything in its class and above.
 
-##### DMS_VMAIL_UID
+##### ONE_DIR
 
-Default: 5000
-
-The User ID assigned to the static vmail user for `/var/mail` (_Mail storage managed by Dovecot_).
-
-!!! warning "Incompatible UID values"
-
-    - A value of [`0` (root) is not compatible][gh-issue::vmail-uid-cannot-be-root].
-    - This feature will attempt to adjust the `uid` for the `docker` user (`/etc/passwd`), hence the error emitted to logs if the UID is already assigned to another user.
-    - The feature appears to work with other UID values that are already assigned in `/etc/passwd`, even though Dovecot by default has a setting for the minimum UID as `500`.
-
-##### DMS_VMAIL_GID
-
-Default: 5000
-
-The Group ID assigned to the static vmail group for `/var/mail` (_Mail storage managed by Dovecot_).
-
-##### ACCOUNT_PROVISIONER
-
-Configures the [provisioning source of user accounts][docs::account-management::overview] (including aliases) for user queries and authentication by services managed by DMS (_Postfix and Dovecot_).
-
-- **FILE** => use local files
-- LDAP => use LDAP authentication
-
-LDAP requires an external service (e.g. [`bitnami/openldap`](https://hub.docker.com/r/bitnami/openldap/)).
+- 0 => state in default directories.
+- **1** => consolidate all states into a single directory (`/var/mail-state`) to allow persistence using docker volumes. See the [related FAQ entry][docs-faq-onedir] for more information.
 
 ##### PERMIT_DOCKER
 
 Set different options for mynetworks option (can be overwrite in postfix-main.cf) **WARNING**: Adding the docker network's gateway to the list of trusted hosts, e.g. using the `network` or `connected-networks` option, can create an [**open relay**](https://en.wikipedia.org/wiki/Open_mail_relay), for instance if IPv6 is enabled on the host machine but not in Docker.
 
-- **none** => Explicitly force authentication
-- container => Container IP address only.
+- **empty** => localhost only.
 - host => Add docker host (ipv4 only).
 - network => Add the docker default bridge network (172.16.0.0/12); **WARNING**: `docker-compose` might use others (e.g. 192.168.0.0/16) use `PERMIT_DOCKER=connected-networks` in this case.
 - connected-networks => Add all connected docker networks (ipv4 only).
 
 Note: you probably want to [set `POSTFIX_INET_PROTOCOLS=ipv4`](#postfix_inet_protocols) to make it work fine with Docker.
 
-##### TZ
-
-Set the timezone. If this variable is unset, the container runtime will try to detect the time using `/etc/localtime`, which you can alternatively mount into the container. The value of this variable must follow the pattern `AREA/ZONE`, i.e. of you want to use Germany's time zone, use `Europe/Berlin`. You can lookup all available timezones [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
-
 ##### ENABLE_AMAVIS
 
 Amavis content filter (used for ClamAV & SpamAssassin)
@@ -92,77 +62,29 @@ Amavis content filter (used for ClamAV & SpamAssassin)
 - 1/2      => Show default informational output
 - 3/4/5    => log debug information (very verbose)
 
-##### ENABLE_DNSBL
+##### ENABLE_CLAMAV
 
-This enables DNS block lists in _Postscreen_. If you want to know which lists we are using, have a look at [the default `main.cf` for Postfix we provide](https://github.com/docker-mailserver/docker-mailserver/blob/master/target/postfix/main.cf) and search for `postscreen_dnsbl_sites`.
-
-!!! danger "A Warning On DNS Block Lists"
-
-    Make sure your DNS queries are properly resolved, i.e. you will most likely not want to use a public DNS resolver as these queries do not return meaningful results. We try our best to only evaluate proper return codes - this is not a guarantee that all codes are handled fine though.
-
-    **Note that emails will be rejected if they don't pass the block list checks!**
-
-- **0** => DNS block lists are disabled
-- 1     => DNS block lists are enabled
-
-##### ENABLE_MTA_STS
-
-Enables MTA-STS support for outbound mail.
-
-- **0** => Disabled
-- 1 => Enabled
-
-See [MTA-STS](best-practices/mta-sts.md) for further explanation.
-
-##### ENABLE_OPENDKIM
-
-Enables the OpenDKIM service.
-
-- **1** => Enabled
-- 0 => Disabled
-
-##### ENABLE_OPENDMARC
-
-Enables the OpenDMARC service.
-
-- **1** => Enabled
-- 0 => Disabled
-
-##### ENABLE_POLICYD_SPF
-
-Enabled `policyd-spf` in Postfix's configuration. You will likely want to set this to `0` in case you're using Rspamd ([`ENABLE_RSPAMD=1`](#enable_rspamd)).
-
-- 0 => Disabled
-- **1** => Enabled
+- **0** => Clamav is disabled
+- 1 => Clamav is enabled
 
 ##### ENABLE_POP3
 
-- **0** => POP3 service disabled
+- **empty** => POP3 service disabled
 - 1 => Enables POP3 service
 
-##### ENABLE_IMAP
-
-- 0 => Disabled
-- **1** => Enabled
-
-##### ENABLE_CLAMAV
-
-- **0** => ClamAV is disabled
-- 1 => ClamAV is enabled
-
 ##### ENABLE_FAIL2BAN
 
 - **0** => fail2ban service disabled
 - 1 => Enables fail2ban service
 
-If you enable Fail2Ban, don't forget to add the following lines to your `compose.yaml`:
+If you enable Fail2Ban, don't forget to add the following lines to your `docker-compose.yml`:
 
 ``` BASH
 cap_add:
   - NET_ADMIN
 ```
 
-Otherwise, `nftables` won't be able to ban IPs.
+Otherwise, `iptables` won't be able to ban IPs.
 
 ##### FAIL2BAN_BLOCKTYPE
 
@@ -201,12 +123,12 @@ Please read [the SSL page in the documentation][docs-tls] for more information.
 
 Configures the handling of creating mails with forged sender addresses.
 
-- **0** => (not recommended) Mail address spoofing allowed. Any logged in user may create email messages with a [forged sender address](https://en.wikipedia.org/wiki/Email_spoofing).
-- 1 => Mail spoofing denied. Each user may only send with their own or their alias addresses. Addresses with [extension delimiters](http://www.postfix.org/postconf.5.html#recipient_delimiter) are not able to send messages.
+- **empty** => Mail address spoofing allowed. Any logged in user may create email messages with a forged sender address. See also [Wikipedia](https://en.wikipedia.org/wiki/Email_spoofing)(not recommended, but default for backwards compatibility reasons)
+- 1 => (recommended) Mail spoofing denied. Each user may only send with his own or his alias addresses. Addresses with [extension delimiters](http://www.postfix.org/postconf.5.html#recipient_delimiter) are not able to send messages.
 
 ##### ENABLE_SRS
 
-Enables the Sender Rewriting Scheme. SRS is needed if DMS acts as forwarder. See [postsrsd](https://github.com/roehling/postsrsd/blob/main/README.rst) for further explanation.
+Enables the Sender Rewriting Scheme. SRS is needed if `docker-mailserver` 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
@@ -223,20 +145,26 @@ Set how many days a virusmail will stay on the server before being deleted
 
 - **empty** => 7 days
 
+##### ENABLE_POSTFIX_VIRTUAL_TRANSPORT
+
+This Option is activating the Usage of POSTFIX_DAGENT to specify a ltmp client different from default dovecot socket.
+
+- **empty** => disabled
+- 1 => enabled
+
 ##### POSTFIX_DAGENT
 
-Configure Postfix `virtual_transport` to deliver mail to a different LMTP client (_default is a unix socket to dovecot_).
+Enabled by ENABLE_POSTFIX_VIRTUAL_TRANSPORT. Specify the final delivery of postfix
 
-Provide any valid URI. Examples:
-
-- **empty** => `lmtp:unix:/var/run/dovecot/lmtp` (default, configured in Postfix `main.cf`)
+- **empty**: fail
 - `lmtp:unix:private/dovecot-lmtp` (use socket)
-- `lmtps:inet:<host>:<port>` (secure lmtp with starttls)
+- `lmtps:inet:<host>:<port>` (secure lmtp with starttls, take a look at <https://sys4.de/en/blog/2014/11/17/sicheres-lmtp-mit-starttls-in-dovecot/>)
 - `lmtp:<kopano-host>:2003` (use kopano as mailstore)
+- etc.
 
-##### POSTFIX_MAILBOX_SIZE_LIMIT
+##### POSTFIX\_MAILBOX\_SIZE\_LIMIT
 
-Set the mailbox size limit for all users. If set to zero, the size will be unlimited (default). Size is in bytes.
+Set the mailbox size limit for all users. If set to zero, the size will be unlimited (default).
 
 - **empty** => 0 (no limit)
 
@@ -245,21 +173,14 @@ Set the mailbox size limit for all users. If set to zero, the size will be unlim
 - **1** => Dovecot quota is enabled
 - 0 => Dovecot quota is disabled
 
-See [mailbox quota][docs-accounts-quota].
+See [mailbox quota][docs-accounts].
 
-##### POSTFIX_MESSAGE_SIZE_LIMIT
+##### POSTFIX\_MESSAGE\_SIZE\_LIMIT
 
-Set the message size limit for all users. If set to zero, the size will be unlimited (not recommended!). Size is in bytes.
+Set the message size limit for all users. If set to zero, the size will be unlimited (not recommended!)
 
 - **empty** => 10240000 (~10 MB)
 
-##### CLAMAV_MESSAGE_SIZE_LIMIT
-
-Mails larger than this limit won't be scanned.
-ClamAV must be enabled (ENABLE_CLAMAV=1) for this.
-
-- **empty** => 25M (25 MB)
-
 ##### ENABLE_MANAGESIEVE
 
 - **empty** => Managesieve service disabled
@@ -295,174 +216,21 @@ Customize the update check interval. Number + Suffix. Suffix must be 's' for sec
 - sdbox => (experimental) uses Dovecot high-performance mailbox format, one file contains one message
 - mdbox ==> (experimental) uses Dovecot high-performance mailbox format, multiple messages per file and multiple files per box
 
-This option has been added in November 2019. Using other format than Maildir is considered as experimental in docker-mailserver and should only be used for testing purpose. For more details, please refer to [Dovecot Documentation](https://doc.dovecot.org/admin_manual/mailbox_formats/#mailbox-formats).
-
-##### POSTFIX_REJECT_UNKNOWN_CLIENT_HOSTNAME
-
-If enabled, employs `reject_unknown_client_hostname` to sender restrictions in Postfix's configuration.
-
-- **0** => Disabled
-- 1 => Enabled
+This option has been added in November 2019. Using other format than Maildir is considered as experimental in docker-mailserver and should only be used for testing purpose. For more details, please refer to [Dovecot Documentation](https://wiki2.dovecot.org/MailboxFormat).
 
 ##### POSTFIX_INET_PROTOCOLS
 
-- **all** => Listen on all interfaces.
-- ipv4 => Listen only on IPv4 interfaces. Most likely you want this behind Docker.
-- ipv6 => Listen only on IPv6 interfaces.
+- **all** => All possible protocols.
+- ipv4 => Use only IPv4 traffic. Most likely you want this behind Docker.
+- ipv6 => Use only IPv6 traffic.
 
-Note: More details at <http://www.postfix.org/postconf.5.html#inet_protocols>
-
-##### DOVECOT_INET_PROTOCOLS
-
-- **all** => Listen on all interfaces
-- ipv4 => Listen only on IPv4 interfaces. Most likely you want this behind Docker.
-- ipv6 => Listen only on IPv6 interfaces.
-
-Note: More information at <https://dovecot.org/doc/dovecot-example.conf>
-
-##### MOVE_SPAM_TO_JUNK
-
-- 0 => Spam messages will be delivered to the inbox.
-- **1** => Spam messages will be delivered to the Junk mailbox.
-
-Routes mail identified as spam into the recipient(s) Junk mailbox (_a specialized folder for junk associated to the [special-use flag `\Junk`][docs::dovecot::special-use-flag], handled via a Dovecot sieve script internally_).
-
-[docs::dovecot::special-use-flag]: ../examples/use-cases/imap-folders.md
-
-!!! info
-
-    Mail is received as spam when it has been marked with either header:
-
-    - `X-Spam: Yes` (_added by Rspamd_)
-    - `X-Spam-Flag: YES` (_added by SpamAssassin - requires [`SPAMASSASSIN_SPAM_TO_INBOX=1`](#spamassassin_spam_to_inbox)_)
-
-##### MARK_SPAM_AS_READ
-
-- **0** => disabled
-- 1 => Spam messages will be marked as read
-
-Enable to treat received spam as "read" (_avoids notification to MUA client of new mail_).
-
-!!! info
-
-    Mail is received as spam when it has been marked with either header:
-
-    - `X-Spam: Yes` (_added by Rspamd_)
-    - `X-Spam-Flag: YES` (_added by SpamAssassin - requires [`SPAMASSASSIN_SPAM_TO_INBOX=1`](#spamassassin_spam_to_inbox)_)
-
-##### SPAM_SUBJECT
-
-This variable defines a prefix for e-mails tagged with the `X-Spam: Yes` (Rspamd) or `X-Spam-Flag: YES` (SpamAssassin/Amavis) header.
-
-Default: empty (no prefix will be added to e-mails)
-
-??? example "Including trailing white-space"
-
-    Add trailing white-space by quote wrapping the value: `SPAM_SUBJECT='[SPAM] '`
-
-#### Rspamd
-
-##### ENABLE_RSPAMD
-
-Enable or disable [Rspamd][docs-rspamd].
-
-- **0** => disabled
-- 1 => enabled
-
-##### ENABLE_RSPAMD_REDIS
-
-Explicit control over running a Redis instance within the container. By default, this value will match what is set for [`ENABLE_RSPAMD`](#enable_rspamd).
-
-The purpose of this setting is to opt-out of starting an internal Redis instance when enabling Rspamd, replacing it with your own external instance.
-
-??? note "Configuring Rspamd for an external Redis instance"
-
-    You will need to [provide configuration][rspamd-redis-config] at `/etc/rspamd/local.d/redis.conf` similar to:
-
-    ```
-    servers = "redis.example.test:6379";
-    expand_keys = true;
-    ```
-
-[rspamd-redis-config]: https://rspamd.com/doc/configuration/redis.html
-
-- 0 => Disabled
-- 1 => Enabled
-
-##### RSPAMD_CHECK_AUTHENTICATED
-
-This settings controls whether checks should be performed on emails coming from authenticated users (i.e. most likely outgoing emails). The default value is `0` in order to align better with SpamAssassin. **We recommend** reading through [the Rspamd documentation on scanning outbound emails][rspamd-scanning-outbound] though to decide for yourself whether you need and want this feature.
-
-!!! note "Not all checks and actions are disabled"
-
-    DKIM signing of e-mails will still happen.
-
-- **0** => No checks will be performed for authenticated users
-- 1 => All default checks will be performed for authenticated users
-
-[rspamd-scanning-outbound]: https://rspamd.com/doc/tutorials/scanning_outbound.html
-
-##### RSPAMD_GREYLISTING
-
-Controls whether the [Rspamd Greylisting module][rspamd-greylisting-module] is enabled. This module can further assist in avoiding spam emails by [greylisting] e-mails with a certain spam score.
-
-- **0** => Disabled
-- 1 => Enabled
-
-[rspamd-greylisting-module]: https://rspamd.com/doc/modules/greylisting.html
-[greylisting]: https://en.wikipedia.org/wiki/Greylisting_(email)
-
-##### RSPAMD_LEARN
-
-When enabled,
-
-1. the "[autolearning][rspamd-autolearn]" feature is turned on;
-2. the Bayes classifier will be trained (with the help of Sieve scripts) when moving mails
-    1. from anywhere to the `Junk` folder (learning this email as spam);
-    2. from the `Junk` folder into the `INBOX` (learning this email as ham).
-
-!!! warning "Attention"
-
-    As of now, the spam learning database is global (i.e. available to all users). If one user deliberately trains it with malicious data, then it will ruin your detection rate.
-
-    This feature is suitably only for users who can tell ham from spam and users that can be trusted.
-
-[rspamd-autolearn]: https://rspamd.com/doc/configuration/statistic.html#autolearning
-
-- **0** => Disabled
-- 1 => Enabled
-
-##### RSPAMD_HFILTER
-
-Can be used to enable or disable the [Hfilter group module][rspamd-docs-hfilter-group-module]. This is used by DMS to adjust the `HFILTER_HOSTNAME_UNKNOWN` symbol, increasing its default weight to act similar to Postfix's `reject_unknown_client_hostname`, without the need to outright reject a message.
-
-- 0 => Disabled
-- **1** => Enabled
-
-[rspamd-docs-hfilter-group-module]: https://www.rspamd.com/doc/modules/hfilter.html
-
-##### RSPAMD_HFILTER_HOSTNAME_UNKNOWN_SCORE
-
-Can be used to control the score when the [`HFILTER_HOSTNAME_UNKNOWN` symbol](#rspamd_hfilter) applies. A higher score is more punishing. Setting it to 15 (the default score for rejecting an e-mail) is equivalent to rejecting the email when the check fails.
-
-Default: 6 (which corresponds to the `add_header` action)
-
-
-##### RSPAMD_NEURAL
-
-Can be used to enable or disable the [Neural network module][rspamd-docs-neural-network]. This is an experimental anti-spam weigh method using three neural networks in the configuration added here. As far as we can tell it trains itself by using other modules to find out what spam is. It will take a while (a week or more) to train its first neural network. The config trains new networks all the time and discards old networks.
-Since it is experimental, it is switched off by default.
-
-- **0** => Disabled
-- 1 => Enabled
-
-[rspamd-docs-neural-network]: https://www.rspamd.com/doc/modules/neural.html
+Note: More details in <http://www.postfix.org/postconf.5.html#inet_protocols>
 
 #### Reports
 
 ##### PFLOGSUMM_TRIGGER
 
-Enables regular Postfix log summary ("pflogsumm") mail reports.
+Enables regular pflogsumm mail reports.
 
 - **not set** => No report
 - daily_cron => Daily report for the previous day
@@ -473,16 +241,16 @@ If this is not set and reports are enabled with the old options, logrotate will
 
 ##### PFLOGSUMM_RECIPIENT
 
-Recipient address for Postfix log summary reports.
+Recipient address for pflogsumm reports.
 
-- **not set** => Use POSTMASTER_ADDRESS
+- **not set** => Use REPORT_RECIPIENT or POSTMASTER_ADDRESS
 - => Specify the recipient address(es)
 
 ##### PFLOGSUMM_SENDER
 
-Sender address (`FROM`) for pflogsumm reports (if Postfix log summary reports are enabled).
+From address for pflogsumm reports.
 
-- **not set** => Use REPORT_SENDER
+- **not set** => Use REPORT_SENDER or POSTMASTER_ADDRESS
 - => Specify the sender address
 
 ##### LOGWATCH_INTERVAL
@@ -500,52 +268,48 @@ Recipient address for logwatch reports if they are enabled.
 - **not set** => Use REPORT_RECIPIENT or POSTMASTER_ADDRESS
 - => Specify the recipient address(es)
 
-##### LOGWATCH_SENDER
+##### REPORT_RECIPIENT (deprecated)
 
-Sender address (`FROM`) for logwatch reports if logwatch reports are enabled.
+Enables a report being sent (created by pflogsumm) on a regular basis.
 
-- **not set** => Use REPORT_SENDER
-- => Specify the sender address
-
-##### REPORT_RECIPIENT
-
-Defines who receives reports (if they are enabled).
-
-- **empty** => Use POSTMASTER_ADDRESS
+- **0** => Report emails are disabled unless enabled by other options
+- 1 => Using POSTMASTER_ADDRESS as the recipient
 - => Specify the recipient address
 
-##### REPORT_SENDER
+##### REPORT_SENDER (deprecated)
 
-Defines who sends reports (if they are enabled).
+Change the sending address for mail report
 
-- **empty** => `mailserver-report@<YOUR DOMAIN>`
-- => Specify the sender address
+- **empty** => mailserver-report@hostname
+- => Specify the report sender (From) address
+
+##### REPORT_INTERVAL (deprecated)
+
+Changes the interval in which logs are rotated and a report is being sent (deprecated).
+
+- **daily** => Send a daily report
+- weekly => Send a report every week
+- monthly => Send a report every month
+
+Note: This variable used to control logrotate inside the container and sent the pflogsumm report when the logs were rotated.
+It is still supported for backwards compatibility, but the new option LOGROTATE_INTERVAL has been added that only rotates
+the logs.
 
 ##### LOGROTATE_INTERVAL
 
-Changes the interval in which log files are rotated.
+Defines the interval in which the mail log is being rotated.
 
-- **weekly** => Rotate log files weekly
-- daily => Rotate log files daily
-- monthly => Rotate log files monthly
+- **daily** => Rotate daily.
+- weekly => Rotate weekly.
+- monthly => Rotate monthly.
 
-!!! note
+Note that only the log inside the container is affected.
+The full log output is still available via `docker logs mailserver` (_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/).
 
-    `LOGROTATE_INTERVAL` only manages `logrotate` within the container for services we manage internally.
+Also note that by default the logs are lost when the container is recycled. To keep the logs, mount a volume.
 
-    The entire log output for the container is still available via `docker logs mailserver` (or your respective container name). If you want to configure external log rotation for that container output as well, : [Docker Logging Drivers](https://docs.docker.com/config/containers/logging/configure/).
-
-    By default, the logs are lost when the container is destroyed (eg: re-creating via `docker compose down && docker compose up -d`). To keep the logs, mount a volume (to `/var/log/mail/`).
-
-!!! note
-
-    This variable can also determine the interval for Postfix's log summary reports, see [`PFLOGSUMM_TRIGGER`](#pflogsumm_trigger).
-
-##### LOGROTATE_COUNT
-
-Defines how many files are kept by logrotate.
-
-- **4** => Number of files
+Finally the logrotate interval **may** affect the period for generated reports. That is the case when the reports are triggered by log rotation.
 
 #### SpamAssassin
 
@@ -554,153 +318,66 @@ Defines how many files are kept by logrotate.
 - **0** => SpamAssassin is disabled
 - 1 => SpamAssassin is enabled
 
-??? info "SpamAssassin analyzes incoming mail and assigns a spam score"
-
-    Integration with Amavis involves processing mail based on the assigned spam score via [`SA_TAG`, `SA_TAG2` and `SA_KILL`][amavis-docs::spam-score].
-
-    These settings have equivalent ENV supported by DMS for easy adjustments, as documented below.
-
-[amavis-docs::spam-score]: https://www.ijs.si/software/amavisd/amavisd-new-docs.html#tagkill
-
-##### ENABLE_SPAMASSASSIN_KAM
-
-- **0** => KAM disabled
-- 1 => KAM enabled
-
-[KAM](https://mcgrail.com/template/projects#KAM1) is a 3rd party SpamAssassin ruleset, provided by the McGrail Foundation. If SpamAssassin is enabled, KAM can be used in addition to the default ruleset.
+**/!\\ Spam delivery:** when SpamAssassin is enabled, messages marked as spam WILL NOT BE DELIVERED.
+Use `SPAMASSASSIN_SPAM_TO_INBOX=1` for receiving spam messages.
 
 ##### SPAMASSASSIN_SPAM_TO_INBOX
 
-- 0 => (_Amavis action: `D_BOUNCE`_): Spam messages will be bounced (_rejected_) without any notification (_dangerous_).
-- **1** => (_Amavis action: `D_PASS`_): Spam messages will be delivered to the inbox.
+- **0** => Spam messages will be bounced (_rejected_) without any notification (_dangerous_).
+- 1 => Spam messages will be delivered to the inbox and tagged as spam using `SA_SPAM_SUBJECT`.
 
-!!! note
+##### MOVE_SPAM_TO_JUNK
 
-    The Amavis action configured by this setting:
+- **1** => Spam messages will be delivered in the `Junk` folder.
+- 0 => Spam messages will be delivered in the mailbox.
 
-    - Influences the behavior of the [`SA_KILL`](#sa_kill) setting.
-    - Applies to the Amavis config parameters `$final_spam_destiny` and `$final_bad_header_destiny`.
-
-!!! note "This ENV setting is related to"
-
-    - [`MOVE_SPAM_TO_JUNK=1`](#move_spam_to_junk)
-    - [`MARK_SPAM_AS_READ=1`](#mark_spam_as_read)
-    - [`SPAM_SUBJECT`](#spam_subject)
+Note: this setting needs `SPAMASSASSIN_SPAM_TO_INBOX=1`
 
 ##### SA_TAG
 
-- **2.0** => add 'spam info' headers at, or above this spam score
+- **2.0** => add spam info headers if at, or above that level
 
-Mail is not yet considered spam at this spam score, but for purposes like diagnostics it can be useful to identify mail with a spam score at a lower bound than `SA_TAG2`.
-
-??? example "`X-Spam` headers appended to mail"
-
-    Send a simple mail to a local DMS account `hello@example.com`:
-
-    ```bash
-    docker exec dms swaks --server 0.0.0.0 --to hello@example.com --body 'spam'
-    ```
-
-    Inspecting the raw mail you will notice several `X-Spam` headers were added to the mail like this:
-
-    ```
-    X-Spam-Flag: NO
-    X-Spam-Score: 4.162
-    X-Spam-Level: ****
-    X-Spam-Status: No, score=4.162 tagged_above=2 required=4
-            tests=[BODY_SINGLE_WORD=1, DKIM_ADSP_NXDOMAIN=0.8,
-            NO_DNS_FOR_FROM=0.379, NO_RECEIVED=-0.001, NO_RELAYS=-0.001,
-            PYZOR_CHECK=1.985] autolearn=no autolearn_force=no
-    ```
-
-    !!! info "The `X-Spam-Score` is `4.162`"
-
-        High enough for `SA_TAG` to trigger adding these headers, but not high enough for `SA_TAG2` (_which would set `X-Spam-Flag: YES` instead_).
+Note: this SpamAssassin setting needs `ENABLE_SPAMASSASSIN=1`
 
 ##### SA_TAG2
 
-- **6.31** => add 'spam detected' headers at, or above this level
+- **6.31** => add 'spam detected' headers at that level
 
-When a spam score is high enough, mark mail as spam (_Appends the mail header: `X-Spam-Flag: YES`_).
-
-!!! info "Interaction with other ENV"
-
-    - [`SPAM_SUBJECT`](#spam_subject) modifies the mail subject to better communicate spam mail to the user.
-    - [`MOVE_SPAM_TO_JUNK=1`](#move_spam_to_junk): The mail is still delivered, but to the recipient(s) junk folder instead. This feature reduces the usefulness of `SPAM_SUBJECT`.
+Note: this SpamAssassin setting needs `ENABLE_SPAMASSASSIN=1`
 
 ##### SA_KILL
 
-- **10.0** => quarantine + triggers action to handle spam
+- **6.31** => triggers spam evasive actions
 
-Controls the spam score threshold for triggering an action on mail that has a high spam score.
+!!! note "This SpamAssassin setting needs `ENABLE_SPAMASSASSIN=1`"
 
-??? tip "Choosing an appropriate `SA_KILL` value"
+    By default, `docker-mailserver` is configured to quarantine spam emails.
+    
+    If emails are quarantined, they are compressed and stored in a location dependent on the `ONE_DIR` setting above. To inhibit this behaviour and deliver spam emails, set this to a very high value e.g. `100.0`.
 
-    The value should be high enough to be represent confidence in mail as spam:
+    If `ONE_DIR=1` (default) the location is `/var/mail-state/lib-amavis/virusmails/`, or if `ONE_DIR=0`: `/var/lib/amavis/virusmails/`. These paths are inside the docker container.
 
-    - Too low: The action taken may prevent legitimate mail (ham) that was incorrectly detected as spam from being delivered successfully.
-    - Too high: Allows more spam to bypass the `SA_KILL` trigger (_how to treat mail with high confidence that it is actually spam_).
+##### SA_SPAM_SUBJECT
 
-    Experiences from DMS users with these settings has been [collected here][gh-issue::sa-tunables-insights], along with [some direct configuration guides][gh-issue::sa-tunables-guides] (_under "Resources for references"_).
+- **\*\*\*SPAM\*\*\*** => add tag to subject if spam detected
 
-[gh-issue::sa-tunables-insights]: https://github.com/docker-mailserver/docker-mailserver/pull/3058#issuecomment-1420268148
-[gh-issue::sa-tunables-guides]: https://github.com/docker-mailserver/docker-mailserver/pull/3058#issuecomment-1416547911
-
-??? info "Trigger action"
-
-    DMS will configure Amavis with either of these actions based on the DMS [`SPAMASSASSIN_SPAM_TO_INBOX`](#spamassassin_spam_to_inbox) ENV setting:
-
-    - `D_PASS` (**default**):
-        - Accept mail and deliver it to the recipient(s), despite the high spam score. A copy is still stored in quarantine.
-        - This is a good default to start with until you are more confident in an `SA_KILL` threshold that won't accidentally discard / bounce legitimate mail users are expecting to arrive but is detected as spam.
-    - `D_BOUNCE`:
-        - Additionally sends a bounce notification (DSN).
-        - The [DSN is suppressed][amavis-docs::actions] (_no bounce sent_) when the spam score exceeds the Amavis `$sa_dsn_cutoff_level` config setting (default: `10`). With the DMS `SA_KILL` default also being `10`, no DSN will ever be sent.
-    - `D_REJECT` / `D_DISCARD`:
-        - These two aren't configured by DMS, but are valid alternative action values if configuring Amavis directly.
-
-??? note "Quarantined mail"
-
-    When mail has a spam score that reaches the `SA_KILL` threshold:
-
-    - [It will be quarantined][amavis-docs::quarantine] regardless of the `SA_KILL` action to perform.
-    - With `D_PASS` the delivered mail also appends an `X-Quarantine-ID` mail header. The ID value of this header is part of the quarantined file name.
-
-    If emails are quarantined, they are compressed and stored at a location:
-
-    - Default: `/var/lib/amavis/virusmails/`
-    - When the [`/var/mail-state/` volume][docs::dms-volumes-state] is present: `/var/mail-state/lib-amavis/virusmails/`
-
-    !!! tip
-
-        Easily list mail stored in quarantine with `find` and the quarantine path:
-
-        ```bash
-        find /var/lib/amavis/virusmails -type f
-        ```
-
-[amavis-docs::actions]: https://www.ijs.si/software/amavisd/amavisd-new-docs.html#actions
-[amavis-docs::quarantine]: https://www.ijs.si/software/amavisd/amavisd-new-docs.html#quarantine
+Note: this SpamAssassin setting needs `ENABLE_SPAMASSASSIN=1`. Add the SpamAssassin score to the subject line by inserting the keyword \_SCORE\_: **\*\*\*SPAM(\_SCORE\_)\*\*\***.
 
 ##### SA_SHORTCIRCUIT_BAYES_SPAM
 
 - **1** => will activate SpamAssassin short circuiting for bayes spam detection.
 
-This will uncomment the respective line in `/etc/spamassasin/local.cf`
+This will uncomment the respective line in ```/etc/spamassasin/local.cf```
 
-!!! warning
-
-    Activate this only if you are confident in your bayes database for identifying spam.
+Note: activate this only if you are confident in your bayes database for identifying spam.
 
 ##### SA_SHORTCIRCUIT_BAYES_HAM
 
 - **1** => will activate SpamAssassin short circuiting for bayes ham detection
 
-This will uncomment the respective line in `/etc/spamassasin/local.cf`
+This will uncomment the respective line in ```/etc/spamassasin/local.cf```
 
-!!! warning
-
-    Activate this only if you are confident in your bayes database for identifying ham.
+Note: activate this only if you are confident in your bayes database for identifying ham.
 
 #### Fetchmail
 
@@ -715,39 +392,21 @@ This will uncomment the respective line in `/etc/spamassasin/local.cf`
 
 ##### FETCHMAIL_PARALLEL
 
-- **0** => `fetchmail` runs with a single config file `/etc/fetchmailrc`
-- 1 => `/etc/fetchmailrc` is split per poll entry. For every poll entry a separate fetchmail instance is started to [allow having multiple imap idle connections per server][fetchmail-imap-workaround] (_when poll entries reference the same IMAP server_).
-
-[fetchmail-imap-workaround]: https://otremba.net/wiki/Fetchmail_(Debian)#Immediate_Download_via_IMAP_IDLE
+  **0** => `fetchmail` runs with a single config file `/etc/fetchmailrc`
+  **1** => `/etc/fetchmailrc` is split per poll entry. For every poll entry a seperate fetchmail instance is started  to allow having multiple imap idle configurations defined.
 
 Note: The defaults of your fetchmailrc file need to be at the top of the file. Otherwise it won't be added correctly to all separate `fetchmail` instances.
-#### Getmail
-
-##### ENABLE_GETMAIL
-
-Enable or disable `getmail`.
-
-- **0** => Disabled
-- 1 => Enabled
-
-##### GETMAIL_POLL
-
-- **5** => `getmail` The number of minutes for the interval. Min: 1; Default: 5.
-
-
-#### OAUTH2
-
-##### ENABLE_OAUTH2
-
-- **empty** => OAUTH2 authentication is disabled
-- 1 => OAUTH2 authentication is enabled
-
-##### OAUTH2_INTROSPECTION_URL
-
-- => Specify the user info endpoint URL of the oauth2 provider (_eg: `https://oauth2.example.com/userinfo/`_)
 
 #### LDAP
 
+##### ENABLE_LDAP
+
+- **empty** => LDAP authentification is disabled
+- 1 => LDAP authentification is enabled
+- NOTE:
+  - A second container for the ldap service is necessary (e.g. [docker-openldap](https://github.com/osixia/docker-openldap))
+  - For preparing the ldap server to use in combination with this container [this](http://acidx.net/wordpress/2014/06/installing-a-mailserver-with-postfix-dovecot-sasl-ldap-roundcube/) article may be helpful
+
 ##### LDAP_START_TLS
 
 - **empty** => no
@@ -756,8 +415,8 @@ Enable or disable `getmail`.
 ##### LDAP_SERVER_HOST
 
 - **empty** => mail.example.com
-- => Specify the `<dns-name>` / `<ip-address>` where the LDAP server is reachable via a URI like: `ldaps://mail.example.com`.
-- Note: You must include the desired URI scheme (`ldap://`, `ldaps://`, `ldapi://`).
+- => Specify the dns-name/ip-address where the ldap-server is listening, or an URI like `ldaps://mail.example.com`
+- NOTE: If you going to use `docker-mailserver` in combination with `docker-compose.yml` you can set the service name here
 
 ##### LDAP_SEARCH_BASE
 
@@ -824,15 +483,15 @@ The following variables overwrite the default values for ```/etc/dovecot/dovecot
 - => Bind dn for LDAP connection. (e.g. `cn=admin,dc=domain,dc=com`)
 
 ##### DOVECOT_DNPASS
-
 - **empty** => same as `LDAP_BIND_PW`
-- => Password for LDAP dn specified in `DOVECOT_DN`.
+- => Password for LDAP dn sepecifified in `DOVECOT_DN`.
 
 ##### DOVECOT_URIS
 
 - **empty** => same as `LDAP_SERVER_HOST`
-- => Specify a space separated list of LDAP URIs.
-- Note: You must include the desired URI scheme (`ldap://`, `ldaps://`, `ldapi://`).
+- => Specify a space separated list of LDAP uris.
+- Note: If the protocol is missing, `ldap://` will be used.
+- Note: This deprecates `DOVECOT_HOSTS` (as it didn't allow to use LDAPS), which is currently still supported for backwards compatibility.
 
 ##### DOVECOT_LDAP_VERSION
 
@@ -910,26 +569,22 @@ Note: This postgrey setting needs `ENABLE_POSTGREY=1`
 
 ##### SASLAUTHD_MECHANISMS
 
-DMS only implements support for these mechanisms:
-
-- **`ldap`** => Authenticate against an LDAP server
-- `rimap` => Authenticate against an IMAP server
+- **empty** => pam
+- `ldap` => authenticate against ldap server
+- `shadow` => authenticate against local user db
+- `mysql` => authenticate against mysql db
+- `rimap` => authenticate against imap server
+- NOTE: can be a list of mechanisms like pam ldap shadow
 
 ##### SASLAUTHD_MECH_OPTIONS
 
 - **empty** => None
-
-!!! info
-
-    With `SASLAUTHD_MECHANISMS=rimap` you need to specify the ip-address / servername of the IMAP server, such as `SASLAUTHD_MECH_OPTIONS=127.0.0.1`.
+- e.g. with SASLAUTHD_MECHANISMS rimap you need to specify the ip-address/servername of the imap server  ==> xxx.xxx.xxx.xxx
 
 ##### SASLAUTHD_LDAP_SERVER
 
-- **empty** => Use the same value as `LDAP_SERVER_HOST`
-
-!!! note
-
-    You must include the desired URI scheme (`ldap://`, `ldaps://`, `ldapi://`).
+- **empty** => same as `LDAP_SERVER_HOST`
+- Note: since version 10.0.0, you can specify a protocol here (like ldaps://); this deprecates SASLAUTHD_LDAP_SSL.
 
 ##### SASLAUTHD_LDAP_START_TLS
 
@@ -984,6 +639,11 @@ Specify what password attribute to use for password verification.
 - **empty** => Nothing is added to the configuration but the documentation says it is `userPassword` by default.
 - Any value => Fills the `ldap_password_attr` option
 
+##### SASL_PASSWD
+
+- **empty** => No sasl_passwd will be created
+- string => `/etc/postfix/sasl_passwd` will be created with the string as password
+
 ##### SASLAUTHD_LDAP_AUTH_METHOD
 
 - **empty** => `bind` will be used as a default value
@@ -1029,121 +689,40 @@ you to replace both instead of just the envelope sender.
 - **empty** => Derived from [`OVERRIDE_HOSTNAME`](#override_hostname), `$DOMAINNAME` (internal), or the container's hostname
 - Set this if auto-detection fails, isn't what you want, or you wish to have a separate container handle DSNs
 
-#### Relay Host
-
-Supported ENV for the [Relay Host][docs::relay-host] feature.
-
-!!! note "Prefer `DEFAULT_RELAY_HOST` instead of `RELAY_HOST`"
-
-    This is advised unless you need support for sender domain opt-out (via `setup relay exclude-domain`).
-
-    The implementation for `RELAY_HOST` is not compatible with LDAP.
-
-!!! tip "Opt-in for relay host support"
-
-    Enable relaying only for specific sender domains instead by using `setup relay add-domain`.
-
-    **NOTE:** Presently there is a caveat when relay host credentials are configured (_which is incompatible with opt-in_).
+#### Default Relay Host
 
 ##### DEFAULT_RELAY_HOST
 
-Configures a default relay host.
+- **empty** => don't set default relayhost setting in main.cf
+- default host and port to relay all mail through.
+    Format: `[example.com]:587` (don't forget the brackets if you need this to
+    be compatible with `$RELAY_USER` and `$RELAY_PASSWORD`, explained below).
 
-!!! info
-
-    - All mail sent outbound from DMS will be relayed through the configured host, unless sender-dependent relayhost maps have been configured (_which have precedence_).
-    - The host value may optionally be wrapped in brackets (_skips DNS query for MX record_): `[mail.example.com]:587` vs `example.com:587`
-
-!!! abstract "Technical Details"
-
-    This ENV internally configures the Postfix `main.cf` setting: [`relayhost`][postfix-config::relayhost]
+#### Multi-domain Relay Hosts
 
 ##### RELAY_HOST
 
-Configures a default relay host.
-
-!!! note
-
-    Expects a value like `mail.example.com`. Internally this will be wrapped to `[mail.example.com]`, so it should resolve to the MTA directly.
-
-    !!! warning "Do not use with `DEFAULT_RELAY_HOST`"
-
-        `RELAY_HOST` has precedence as it is configured with `sender_dependent_relayhost_maps`.
-
-!!! info
-
-    - This is a legacy ENV. It is however required for the opt-out feature of `postfix-relaymap.cf` to work.
-    - Internal configuration however differs from `DEFAULT_RELAY_HOST`.
-
-!!! abstract "Technical Details"
-
-    This feature is configured internally using the:
-
-    - Postfix setting with config: [`sender_dependent_relayhost_maps = texthash:/etc/postfix/relayhost_map`][postfix-config::relayhost_maps]
-    - DMS Config volume support via: `postfix-relaymap.cf` (_generates `/etc/postfix/relayhost_map`_)
-
-    All known mail domains managed by DMS will be configured to relay outbound mail to `RELAY_HOST` by adding them implicitly to `/etc/postfix/relayhost_map`, except for domains using the opt-out feature of `postfix-relaymap.cf`.
+- **empty** => don't configure relay host
+- default host to relay mail through
 
 ##### RELAY_PORT
 
-Default => 25
-
-Support for configuring a different port than 25 for `RELAY_HOST` to use.
-
-!!! note
-
-    Requires `RELAY_HOST`.
-
-#### Relay Host Credentials
-
-!!! warning "Configuring relay host credentials enforces outbound authentication"
-
-    Presently when `RELAY_USER` + `RELAY_PASSWORD` or `postfix-sasl-password.cf` are configured, all outbound mail traffic is configured to require a secure connection established and forbids the omission of credentials.
-
-    Additional feature work is required to only enforce these requirements on mail sent through a configured relay host.
+- **empty** => 25
+- default port to relay mail through
 
 ##### RELAY_USER
 
+- **empty** => no default
+- default relay username (if no specific entry exists in postfix-sasl-password.cf)
+
 ##### RELAY_PASSWORD
 
-Provide the credentials to use with `RELAY_HOST` or `DEFAULT_RELAY_HOST`.
+- **empty** => no default
+- password for default relay user
 
-!!! tip "Alternative credentials config"
-
-    You may prefer to use `setup relay add-auth` to avoid risking ENV exposing secrets.
-
-    - With the CLI command, you must provide relay credentials for each of your sender domains.
-    - Alternatively manually edit `postfix-sasl-password.cf` with the correct relayhost entry (_`DEFAULT_RELAY_HOST` value, or as defined in `/etc/postfix/relayhost_map`_) to provide credentials per relayhost configured.
-
-!!! abstract "Technical Details"
-
-    Credentials for relay hosts are configured internally using the:
-
-    - Postfix setting with config: [`smtp_sasl_password_maps = texthash:/etc/postfix/sasl_passwd`][postfix-config::sasl_passwd]
-    - DMS Config volume support via: `postfix-sasl-password.cf` (_generates `/etc/postfix/sasl_passwd`_)
-
-    ---
-
-    When `postfix-sasl-password.cf` is present, DMS will copy it internally to `/etc/postfix/sasl_passwd`.
-
-    - DMS provides support for mapping credentials by sender domain:
-        - Explicitly via `setup relay add-auth` (_creates / updates `postfix-sasl-password.cf`_).
-        - Implicitly via the relay ENV support (_configures all known DMS managed domains to use the relay ENV_).
-    - Credentials can be explicitly configured for specific relay hosts instead of sender domains:
-        - Add the exact relayhost value (`host:port` / `[host]:port`) from the generated `/etc/postfix/relayhost_map`, or `main.cf:relayhost` (`DEFAULT_RELAY_HOST`).
-        - `setup relay ...` is missing support, you must instead add these manually to `postfix-sasl-password.cf`.
-
-[gh-issue::vmail-uid-cannot-be-root]: https://github.com/docker-mailserver/docker-mailserver/issues/4098#issuecomment-2257201025
-
-[docs-rspamd]: ./security/rspamd.md
+[docs-faq-onedir]: ../faq.md#what-is-the-mail-state-folder-for
 [docs-tls]: ./security/ssl.md
 [docs-tls-letsencrypt]: ./security/ssl.md#lets-encrypt-recommended
 [docs-tls-manual]: ./security/ssl.md#bring-your-own-certificates
 [docs-tls-selfsigned]: ./security/ssl.md#self-signed-certificates
-[docs-accounts-quota]: ./account-management/overview.md#quotas
-[docs::account-management::overview]: ./account-management/overview.md
-[docs::relay-host]: ./advanced/mail-forwarding/relay-hosts.md
-[docs::dms-volumes-state]: ./advanced/optional-config.md#volumes-state
-[postfix-config::relayhost]: https://www.postfix.org/postconf.5.html#relayhost
-[postfix-config::relayhost_maps]: https://www.postfix.org/postconf.5.html#sender_dependent_relayhost_maps
-[postfix-config::sasl_passwd]: https://www.postfix.org/postconf.5.html#smtp_sasl_password_maps
+[docs-accounts]: ./user-management/accounts.md#notes

docs/content/config/pop3.md

@@ -4,7 +4,7 @@ hide:
   - toc # Hide Table of Contents for this page
 ---
 
-If you want to use POP3(S), you have to add the ports 110 and/or 995 (TLS secured) and the environment variable `ENABLE_POP3` to your `compose.yaml`:
+If you want to use POP3(S), you have to add the ports 110 and/or 995 (TLS secured) and the environment variable `ENABLE_POP3` to your `docker-compose.yml`:
 
 ```yaml
 mailserver:

docs/content/config/security/fail2ban.md

@@ -4,159 +4,126 @@ hide:
   - toc # Hide Table of Contents for this page
 ---
 
-!!! quote "What is Fail2Ban (F2B)?"
+Fail2Ban is installed automatically and bans IP addresses for 3 hours after 3 failed attempts in 10 minutes by default.
 
-    Fail2ban is an intrusion prevention software framework. Written in the Python programming language, it is designed to prevent against brute-force attacks. It is able to run on POSIX systems that have an interface to a packet-control system or firewall installed locally, such as \[NFTables\] or TCP Wrapper.
+## Configuration files
 
-    [Source][wikipedia-fail2ban]
+If you want to change this, you can easily edit our github example file: [`config/fail2ban-jail.cf`][github-file-f2bjail].
 
-    [wikipedia-fail2ban]: https://en.wikipedia.org/wiki/Fail2ban
+You can do the same with the values from `fail2ban.conf`, e.g `dbpurgeage`. In that case you need to edit: [`config/fail2ban-fail2ban.cf`][github-file-f2bconfig].
 
-## Configuration
+The configuration files need to be located at the root of the `/tmp/docker-mailserver/` volume bind (usually `./docker-data/dms/config/:/tmp/docker-mailserver/`).
+
+This following configuration files from `/tmp/docker-mailserver/` will be copied during container startup.
+
+- `fail2ban-jail.cf` -> `/etc/fail2ban/jail.d/user-jail.local`
+- `fail2ban-fail2ban.cf` -> `/etc/fail2ban/fail2ban.local`
+
+### Docker-compose config
+
+Example configuration volume bind:
+
+```yaml
+    volumes:
+      - ./docker-data/dms/config/:/tmp/docker-mailserver/
+```
+
+!!! attention
+    `docker-mailserver` must be launched with the `NET_ADMIN` capability in order to be able to install the iptable rules that actually ban IP addresses.
+
+    Thus either include `--cap-add=NET_ADMIN` in the `docker run` command, or the equivalent in `docker-compose.yml`:
+
+    ```yaml
+    cap_add:
+      - NET_ADMIN
+    ```
+
+If you don't you will see errors the form of:
+
+```log
+iptables -w -X f2b-postfix -- stderr: "getsockopt failed strangely: Operation not permitted\niptables v1.4.21: can't initialize iptabl
+es table `filter': Permission denied (you must be root)\nPerhaps iptables or your kernel needs to be upgraded.\niptables v1.4.21: can'
+t initialize iptables table `filter': Permission denied (you must be root)\nPerhaps iptables or your kernel needs to be upgraded.\n"
+2016-06-01 00:53:51,284 fail2ban.action         [678]: ERROR   iptables -w -D INPUT -p tcp -m multiport --dports smtp,465,submission -
+j f2b-postfix
+```
+
+## Running fail2ban in a rootless container
+
+[`RootlessKit`][rootless::rootless-kit] is the _fakeroot_ implementation for supporting _rootless mode_ in Docker and Podman. By default RootlessKit uses the [`builtin` port forwarding driver][rootless::port-drivers], which does not propagate source IP addresses.
+
+It is necessary for `fail2ban` to have access to the real source IP addresses in order to correctly identify clients. This is achieved by changing the port forwarding driver to [`slirp4netns`][rootless::slirp4netns], which is slower than `builtin` but does preserve the real source IPs.
+
+### Docker with `slirp4netns` port driver
+
+For [rootless mode][rootless::docker] in Docker, create `~/.config/systemd/user/docker.service.d/override.conf` with the following content:
+
+```
+[Service]
+Environment="DOCKERD_ROOTLESS_ROOTLESSKIT_PORT_DRIVER=slirp4netns"
+```
+
+And then restart the daemon:
+
+```console
+$ systemctl --user daemon-reload
+$ systemctl --user restart docker
+```
+
+!!! note
+
+    This changes the port driver for all rootless containers managed by Docker.
+
+    Per container configuration is not supported, if you need that consider Podman instead.
+
+### Podman with `slirp4netns` port driver
+
+[Rootless Podman][rootless::podman] requires adding the value `slirp4netns:port_handler=slirp4netns` to the `--network` CLI option, or `network_mode` setting in your `docker-compose.yml`.
+
+
+You must also add the ENV `NETWORK_INTERFACE=tap0`, because Podman uses a [hard-coded interface name][rootless::podman::interface] for `slirp4netns`.
 
-Enabling Fail2Ban support can be done via ENV, but also requires granting at least the `NET_ADMIN` capability to interact with the kernel and ban IP addresses.
 
 !!! example
 
-    === "Docker Compose"
+    ```yaml
+    services:
+      mailserver:
+        network_mode: "slirp4netns:port_handler=slirp4netns"
+        environment:
+          - ENABLE_FAIL2BAN=1
+          - NETWORK_INTERFACE=tap0
+          ...
+    ```
 
-        ```yaml title="compose.yaml"
-        services:
-          mailserver:
-            environment:
-              - ENABLE_FAIL2BAN=1
-            cap_add:
-              - NET_ADMIN
-        ```
+!!! note
 
-    === "Docker CLI"
+    `slirp4netns` is not compatible with user-defined networks.
 
-        ```bash
-        docker run --rm -it \
-          --cap-add=NET_ADMIN \
-          --env ENABLE_FAIL2BAN=1
-        ```
+## Manage bans
 
-!!! warning "Security risk of adding non-default capabilties"
+You can also manage and list the banned IPs with the [`setup.sh`][docs-setupsh] script.
 
-    DMS bundles F2B into the image for convenience to simplify integration and deployment.
+### List bans
 
-    The [`NET_ADMIN`][security::cap-net-admin] and [`NET_RAW`][security::cap-net-raw] capabilities are not granted by default to the container root user, as they can be used to compromise security.
-
-    If this risk concerns you, it may be wiser to instead prefer only granting these capabilities to a dedicated Fail2Ban container ([example][lsio:f2b-image]).
-
-!!! bug "Running Fail2Ban on Older Kernels"
-
-    DMS configures F2B to use [NFTables][network::nftables], not [IPTables (legacy)][network::iptables-legacy].
-
-    We have observed that older systems (for example NAS systems), do not support the modern NFTables rules. You will need to configure F2B to use legacy IPTables again, for example with the [`fail2ban-jail.cf`][github-file-f2bjail], see the [section on configuration further down below](#custom-files).
-
-[security::cap-net-admin]: https://0xn3va.gitbook.io/cheat-sheets/container/escaping/excessive-capabilities#cap_net_admin
-[security::cap-net-raw]: https://0xn3va.gitbook.io/cheat-sheets/container/escaping/excessive-capabilities#cap_net_raw
-[lsio:f2b-image]: https://docs.linuxserver.io/images/docker-fail2ban
-[network::nftables]: https://en.wikipedia.org/wiki/Nftables
-[network::iptables-legacy]: https://developers.redhat.com/blog/2020/08/18/iptables-the-two-variants-and-their-relationship-with-nftables#two_variants_of_the_iptables_command
-
-### DMS Defaults
-
-DMS will automatically ban IP addresses of hosts that have generated 6 failed attempts over the course of the last week. The bans themselves last for one week. The Postfix jail is configured to use `mode = extra` in DMS.
-
-### Custom Files
-
-!!! question "What is [`docker-data/dms/config/`][docs::dms-volumes-config]?"
-
-This following configuration files inside the `docker-data/dms/config/` volume will be copied inside the container during startup
-
-1. `fail2ban-jail.cf` is copied to `/etc/fail2ban/jail.d/user-jail.local`
-    - with this file, you can adjust the configuration of individual jails and their defaults
-    - there is an example provided [in our repository on GitHub][github-file-f2bjail]
-2. `fail2ban-fail2ban.cf` is copied to `/etc/fail2ban/fail2ban.local`
-    - with this file, you can adjust F2B behavior in general
-    - there is an example provided [in our repository on GitHub][github-file-f2bconfig]
-
-[docs::dms-volumes-config]: ../advanced/optional-config.md#volumes-config
-[github-file-f2bjail]: https://github.com/docker-mailserver/docker-mailserver/blob/master/config-examples/fail2ban-jail.cf
-[github-file-f2bconfig]: https://github.com/docker-mailserver/docker-mailserver/blob/master/config-examples/fail2ban-fail2ban.cf
-
-### Viewing All Bans
-
-When just running
-
-```bash
-setup fail2ban
+```sh
+./setup.sh debug fail2ban
 ```
 
-the script will show all banned IP addresses.
+### Un-ban
 
-To get a more detailed `status` view, run
+Here `192.168.1.15` is our banned IP.
 
-```bash
-setup fail2ban status
+```sh
+./setup.sh debug fail2ban unban 192.168.1.15
 ```
 
-### Managing Bans
-
-You can manage F2B with the `setup` script. The usage looks like this:
-
-```bash
-docker exec <CONTAINER NAME> setup fail2ban [<ban|unban> <IP>]
-```
-
-### Viewing the Log File
-
-```bash
-docker exec <CONTAINER NAME> setup fail2ban log
-```
-
-## Running Inside A Rootless Container { #rootless-container }
-
-[`RootlessKit`][rootless::rootless-kit] is the _fakeroot_ implementation for supporting _rootless mode_ in Docker and Podman. By default, RootlessKit uses the [`builtin` port forwarding driver][rootless::port-drivers], which does not propagate source IP addresses.
-
-It is necessary for F2B to have access to the real source IP addresses in order to correctly identify clients. This is achieved by changing the port forwarding driver to [`slirp4netns`][rootless::slirp4netns], which is slower than the builtin driver but does preserve the real source IPs.
-
+[docs-setupsh]: ../setup.sh.md
+[github-file-f2bjail]: https://github.com/docker-mailserver/docker-mailserver/blob/master/config/fail2ban-jail.cf
+[github-file-f2bconfig]: https://github.com/docker-mailserver/docker-mailserver/blob/master/config/fail2ban-fail2ban.cf
 [rootless::rootless-kit]: https://github.com/rootless-containers/rootlesskit
 [rootless::port-drivers]: https://github.com/rootless-containers/rootlesskit/blob/v0.14.5/docs/port.md#port-drivers
 [rootless::slirp4netns]: https://github.com/rootless-containers/slirp4netns
-
-=== "Docker"
-
-    For [rootless mode][rootless::docker] in Docker, create `~/.config/systemd/user/docker.service.d/override.conf` with the following content:
-
-    !!! danger inline end
-
-        This changes the port driver for all rootless containers managed by Docker. Per container configuration is not supported, if you need that consider Podman instead.
-
-    ```cf
-    [Service]
-    Environment="DOCKERD_ROOTLESS_ROOTLESSKIT_PORT_DRIVER=slirp4netns"
-    ```
-
-    And then restart the daemon:
-
-    ```console
-    $ systemctl --user daemon-reload
-    $ systemctl --user restart docker
-    ```
-
-    [rootless::docker]: https://docs.docker.com/engine/security/rootless
-
-=== "Podman"
-
-    [Rootless Podman][rootless::podman] requires adding the value `slirp4netns:port_handler=slirp4netns` to the `--network` CLI option, or `network_mode` setting in your `compose.yaml`:
-
-    !!! example
-
-        ```yaml
-        services:
-          mailserver:
-            network_mode: "slirp4netns:port_handler=slirp4netns"
-            environment:
-              - ENABLE_FAIL2BAN=1
-              - NETWORK_INTERFACE=tap0
-              ...
-        ```
-
-    You must also add the ENV `NETWORK_INTERFACE=tap0`, because Podman uses a [hard-coded interface name][rootless::podman::interface] for `slirp4netns`. `slirp4netns` is not compatible with user-defined networks!
-
-    [rootless::podman]: https://github.com/containers/podman/blob/v3.4.1/docs/source/markdown/podman-run.1.md#--networkmode---net
-    [rootless::podman::interface]: https://github.com/containers/podman/blob/v3.4.1/libpod/networking_slirp4netns.go#L264
+[rootless::docker]: https://docs.docker.com/engine/security/rootless
+[rootless:podman]: https://github.com/containers/podman/blob/v3.4.1/docs/source/markdown/podman-run.1.md#--networkmode---net
+[rootless:podman::interface]: https://github.com/containers/podman/blob/v3.4.1/libpod/networking_slirp4netns.go#L264

docs/content/config/security/mail_crypt.md

@@ -3,7 +3,7 @@ title: 'Security | mail_crypt (email/storage encryption)'
 ---
 
 !!! info
-
+ 
     The Mail crypt plugin is used to secure email messages stored in a Dovecot system. Messages are encrypted before written to storage and decrypted after reading. Both operations are transparent to the user.
 
     In case of unauthorized access to the storage backend, the messages will, without access to the decryption keys, be unreadable to the offending party.
@@ -30,26 +30,26 @@ Official Dovecot documentation: https://doc.dovecot.org/configuration_manual/mai
     }
     ```
 
-2. Shutdown your mailserver (`docker compose down`)
+2. Shutdown your mailserver (`docker-compose down`)
 
 3. You then need to [generate your global EC key](https://doc.dovecot.org/configuration_manual/mail_crypt_plugin/#ec-key). We named them `/certs/ecprivkey.pem` and `/certs/ecpubkey.pem` in step #1.
 
-4. The EC key needs to be available in the container. I prefer to mount a /certs directory into the container:
+4. The EC key needs to be available in the container. I prefer to mount a /certs directory into the container: 
     ```yaml
     services:
       mailserver:
-        image: ghcr.io/docker-mailserver/docker-mailserver:latest
+        image: docker.io/mailserver/docker-mailserver:latest
         volumes:
         . . .
           - ./certs/:/certs
         . . .
     ```
 
-5. While you're editing the `compose.yaml`, add the configuration file:
+5. While you're editing the `docker-compose.yml`, add the configuration file:
     ```yaml
     services:
       mailserver:
-        image: ghcr.io/docker-mailserver/docker-mailserver:latest
+        image: docker.io/mailserver/docker-mailserver:latest
         volumes:
         . . .
           - ./config/dovecot/10-custom.conf:/etc/dovecot/conf.d/10-custom.conf

docs/content/config/security/rspamd.md

@@ -1,369 +0,0 @@
----
-title: 'Security | Rspamd'
----
-
-## About
-
-Rspamd is a ["fast, free and open-source spam filtering system"][rspamd-web]. DMS integrates Rspamd like any other service. We provide a basic but easy to maintain setup of Rspamd.
-
-If you want to take a look at the default configuration files for Rspamd that DMS adds, navigate to [`target/rspamd/` inside the repository][dms-repo::default-rspamd-configuration]. Please consult the [section "The Default Configuration"](#the-default-configuration) section down below for a written overview.
-
-### Enable Rspamd
-
-Rspamd is presently opt-in for DMS, but intended to become the default anti-spam service in a future release.
-
-DMS offers two anti-spam solutions:
-
-- Legacy (_Amavis, SpamAssassin, OpenDKIM, OpenDMARC_)
-- Rspamd (_Provides equivalent features of software from the legacy solution_)
-
-While you could configure Rspamd to only replace some of the legacy services, it is advised to only use Rspamd with the legacy services disabled.
-
-!!! example "Switch to Rspamd"
-
-    To use Rspamd add the following ENV config changes:
-    
-    ```env
-    ENABLE_RSPAMD=1
-    
-    # Rspamd replaces the functionality of all these anti-spam services, disable them:
-    ENABLE_OPENDKIM=0
-    ENABLE_OPENDMARC=0
-    ENABLE_POLICYD_SPF=0
-    ENABLE_AMAVIS=0
-    ENABLE_SPAMASSASSIN=0
-    # Greylisting is opt-in, if you had enabled Postgrey switch to the Rspamd equivalent:
-    ENABLE_POSTGREY=0
-    RSPAMD_GREYLISTING=1
-    
-    # Optional: Add anti-virus support with ClamAV (compatible with Rspamd):
-    ENABLE_CLAMAV=1
-    ```
-
-!!! info "Relevant Environment Variables"
-
-    The following environment variables are related to Rspamd:
-    
-    1. [`ENABLE_RSPAMD`](../environment.md#enable_rspamd)
-    2. [`ENABLE_RSPAMD_REDIS`](../environment.md#enable_rspamd_redis)
-    3. [`RSPAMD_CHECK_AUTHENTICATED`](../environment.md#rspamd_check_authenticated)
-    4. [`RSPAMD_GREYLISTING`](../environment.md#rspamd_greylisting)
-    5. [`RSPAMD_HFILTER`](../environment.md#rspamd_hfilter)
-    6. [`RSPAMD_HFILTER_HOSTNAME_UNKNOWN_SCORE`](../environment.md#rspamd_hfilter_hostname_unknown_score)
-    7. [`RSPAMD_LEARN`](../environment.md#rspamd_learn)
-    8. [`SPAM_SUBJECT`](../environment.md#spam_subject)
-    9. [`MOVE_SPAM_TO_JUNK`][docs::spam-to-junk]
-    10. [`MARK_SPAM_AS_READ`](../environment.md#mark_spam_as_read)
-
-## Overview of Rspamd support
-
-### Mode of Operation
-
-!!! note "Attention"
-
-    Read this section carefully if you want to understand how Rspamd is integrated into DMS and how it works (on a surface level).
-
-Rspamd is integrated as a milter into DMS. When enabled, Postfix's `main.cf` configuration file includes the parameter `rspamd_milter = inet:localhost:11332`, which is added to `smtpd_milters`. As a milter, Rspamd can inspect incoming and outgoing e-mails.
-
-Each mail is assigned what Rspamd calls symbols: when an e-mail matches a specific criterion, the e-mail receives a symbol. Afterward, Rspamd applies a _spam score_ (as usual with anti-spam software) to the e-mail.
-
-- The score itself is calculated by adding the values of the individual symbols applied earlier. The higher the spam score is, the more likely the e-mail is spam.
-- Symbol values can be negative (i.e., these symbols indicate the mail is legitimate, maybe because [SPF and DKIM][docs::dkim-dmarc-spf] are verified successfully). On the other hand, symbol scores can be positive (i.e., these symbols indicate the e-mail is spam, perhaps because the e-mail contains numerous links).
-
-Rspamd then adds (a few) headers to the e-mail based on the spam score. Most important is `X-Spamd-Result`, which contains an overview of which symbols were applied. It could look like this:
-
-```txt
-X-Spamd-Result     default: False [-2.80 / 11.00]; R_SPF_NA(1.50)[no SPF record]; R_DKIM_ALLOW(-1.00)[example.com:s=dtag1]; DWL_DNSWL_LOW(-1.00)[example.com:dkim]; RWL_AMI_LASTHOP(-1.00)[192.0.2.42:from]; DMARC_POLICY_ALLOW(-1.00)[example.com,none]; RWL_MAILSPIKE_EXCELLENT(-0.40)[192.0.2.42:from]; FORGED_SENDER(0.30)[noreply@example.com,some-reply-address@bounce.example.com]; RCVD_IN_DNSWL_LOW(-0.10)[192.0.2.42:from]; MIME_GOOD(-0.10)[multipart/mixed,multipart/related,multipart/alternative,text/plain]; MIME_TRACE(0.00)[0:+,1:+,2:+,3:+,4:~,5:~,6:~]; RCVD_COUNT_THREE(0.00)[3]; RCPT_COUNT_ONE(0.00)[1]; REPLYTO_DN_EQ_FROM_DN(0.00)[]; ARC_NA(0.00)[]; TO_MATCH_ENVRCPT_ALL(0.00)[]; RCVD_TLS_LAST(0.00)[]; DKIM_TRACE(0.00)[example.com:+]; HAS_ATTACHMENT(0.00)[]; TO_DN_NONE(0.00)[]; FROM_NEQ_ENVFROM(0.00)[noreply@example.com,some-reply-address@bounce.example.com]; FROM_HAS_DN(0.00)[]; REPLYTO_DOM_NEQ_FROM_DOM(0.00)[]; PREVIOUSLY_DELIVERED(0.00)[receiver@anotherexample.com]; ASN(0.00)[asn:3320, ipnet:192.0.2.0/24, country:DE]; MID_RHS_MATCH_FROM(0.00)[]; MISSING_XM_UA(0.00)[]; HAS_REPLYTO(0.00)[some-reply-address@dms-reply.example.com]
-```
-
-And then there is a corresponding `X-Rspamd-Action` header, which shows the overall result and the action that is taken. In our example, it would be:
-
-```txt
-X-Rspamd-Action    no action
-```
-
-Since the score is `-2.80`, nothing will happen and the e-mail is not classified as spam. Our custom [`actions.conf`][dms-repo::rspamd-actions-config] defines what to do at certain scores:
-
-1. At a score of 4, the e-mail is to be _greylisted_;
-2. At a score of 6, the e-mail is _marked with a header_ (`X-Spam: Yes`);
-3. At a score of 11, the e-mail is outright _rejected_.
-
----
-
-There is more to spam analysis than meets the eye: we have not covered the [Bayes training and filters][rspamd-docs::bayes] here, nor have we discussed [Sieve rules for e-mails that are marked as spam][docs::spam-to-junk].
-
-Even the calculation of the score with the individual symbols has been presented to you in a simplified manner. But with the knowledge from above, you're equipped to read on and use Rspamd confidently. Keep on reading to understand the integration even better - you will want to know about your anti-spam software, not only to keep the bad e-mail out, but also to make sure the good e-mail arrive properly!
-
-### Workers
-
-The proxy worker operates in [self-scan mode][rspamd-docs::proxy-self-scan-mode]. This simplifies the setup as we do not require a normal worker. You can easily change this though by [overriding the configuration by DMS](#providing-custom-settings-overriding-settings).
-
-DMS does not set a default password for the controller worker. You may want to do that yourself. In setups where you already have an authentication provider in front of the Rspamd webpage, you may want to [set the `secure_ip ` option to `"0.0.0.0/0"` for the controller worker](#with-the-help-of-a-custom-file) to disable password authentication inside Rspamd completely.
-
-### Persistence with Redis
-
-When Rspamd is enabled, we implicitly also start an instance of Redis in the container:
-
-- Redis is configured to persist its data via RDB snapshots to disk in the directory `/var/lib/redis` (_or the [`/var/mail-state/`][docs::dms-volumes-state] volume when present_).
-- With the volume mount, the snapshot will restore the Redis data across container updates, and provide a way to keep a backup.
-- Without a volume mount a containers internal state will persist across restarts until the container is recreated due to changes like ENV or upgrading the image for the container.
-
-Redis uses `/etc/redis/redis.conf` for configuration:
-
-- We adjust this file when enabling the internal Redis service.
-- If you have an external instance of Redis to use, the internal Redis service can be opt-out via setting the ENV [`ENABLE_RSPAMD_REDIS=0`][docs::env::enable-redis] (_link also details required changes to the DMS Rspamd config_).
-
-If you are interested in using Valkey instead of Redis, please refer to [this guidance][gh-dms::guide::valkey].
-
-### Web Interface
-
-Rspamd provides a [web interface][rspamd-docs::web-ui], which contains statistics and data Rspamd collects. The interface is enabled by default and reachable on port 11334.
-
-![Rspamd Web Interface](https://rspamd.com/img/webui.png)
-
-To use the web interface you will need to configure a password, [otherwise you won't be able to log in][rspamd-docs::web-ui::password].
-
-??? example "Set a custom password"
-
-    Add this line to [your Rspamd `custom-commands.conf` config](#with-the-help-of-a-custom-file) which sets the `password` option of the _controller worker_:
-
-    ```
-    set-option-for-controller password "your hashed password here"
-    ```
-
-    The password hash can be generated via the `rspamadm pw` command:
-
-    ```bash
-    docker exec -it <CONTAINER_NAME> rspamadm pw
-    ```
-
-    ---
-
-    **Related:** A minimal Rspamd `compose.yaml` [example with a reverse-proxy for web access][gh-dms::guide::rspamd-web].
-
-### DNS
-
-DMS does not supply custom values for DNS servers (to Rspamd). If you need to use custom DNS servers, which could be required when using [DNS-based deny/allowlists](#rbls-real-time-blacklists-dnsbls-dns-based-blacklists), you need to adjust [`options.inc`][rspamd-docs::config::global] yourself. Make sure to also read our [FAQ page on DNS servers][docs::faq::dns-servers].
-
-!!! warning
-
-    Rspamd heavily relies on a properly working DNS server that it can use to resolve DNS queries. If your DNS server is misconfigured, you will encounter issues when Rspamd queries DNS to assess if mail is spam. Legitimate mail is then unintentionally marked as spam or worse, rejected entirely.
-
-    When Rspamd is deciding if mail is spam, it will check DNS records for SPF, DKIM and DMARC. Each of those has an associated symbol for DNS temporary errors with a non-zero weight assigned. That weight contributes towards the spam score assessed by Rspamd which is normally desirable - provided your network DNS is functioning correctly, otherwise when DNS is broken all mail is biased towards spam due to these failed DNS lookups.
-
-!!! danger
-
-    While we do not provide values for custom DNS servers by default, we set `soft_reject_on_timeout = true;` by default. This setting will cause a soft reject if a task (presumably a DNS request) timeout takes place.
-
-    This setting is enabled to not allow spam to proceed just because DNS requests did not succeed. It could deny legitimate e-mails to pass though too in case your DNS setup is incorrect or not functioning properly.
-
-### Logs
-
-You can find the Rspamd logs at `/var/log/mail/rspamd.log`, and the corresponding logs for [Redis](#persistence-with-redis), if it is enabled, at `/var/log/supervisor/rspamd-redis.log`. We recommend inspecting these logs (with `docker exec -it <CONTAINER NAME> less /var/log/mail/rspamd.log`) in case Rspamd does not work as expected.
-
-### Modules
-
-You can find a list of all Rspamd modules [on their website][rspamd-docs::modules].
-
-#### Disabled By Default
-
-DMS disables certain modules (`clickhouse`, `elastic`, `neural`, `reputation`, `spamassassin`, `url_redirector`, `metric_exporter`) by default. We believe these are not required in a standard setup, and they would otherwise needlessly use system resources.
-
-#### Anti-Virus (ClamAV)
-
-You can choose to enable ClamAV, and Rspamd will then use it to check for viruses. Just set the environment variable `ENABLE_CLAMAV=1`.
-
-#### RBLs (Real-time Blacklists) / DNSBLs (DNS-based Blacklists)
-
-The [RBL module][rspamd-docs::modules::rbl] is enabled by default. As a consequence, Rspamd will perform DNS lookups to various blacklists. Whether an RBL or a DNSBL is queried depends on where the domain name was obtained: RBL servers are queried with IP addresses extracted from message headers, DNSBL server are queried with domains and IP addresses extracted from the message body ([source][www::rbl-vs-dnsbl]).
-
-!!! danger "Rspamd and DNS Block Lists"
-
-    When the RBL module is enabled, Rspamd will do a variety of DNS requests to (amongst other things) DNSBLs. There are a variety of issues involved when using DNSBLs. Rspamd will try to mitigate some of them by properly evaluating all return codes. This evaluation is a best effort though, so if the DNSBL operators change or add return codes, it may take a while for Rspamd to adjust as well.
-
-    If you want to use DNSBLs, **try to use your own DNS resolver** and make sure it is set up correctly, i.e. it should be a non-public & **recursive** resolver. Otherwise, you might not be able ([see this Spamhaus post][spamhaus::faq::dnsbl-usage]) to make use of the block lists.
-
-## Providing Custom Settings & Overriding Settings
-
-!!! info "Rspamd config overriding precedence"
-
-    Rspamd has a layered approach for configuration with [`local.d` and `override.d` config directories][rspamd-docs::config-directories].
-
-    - DMS [extends the Rspamd default configs via `/etc/rspamd/local.d/`][dms-repo::default-rspamd-configuration].
-    - User config changes should be handled separately as overrides via the [DMS Config Volume][docs::dms-volumes-config] (`docker-data/dms/config/`) with either:
-        - `./rspamd/override.d/` - Config files placed here are copied to `/etc/rspamd/override.d/` during container startup.
-        - [`./rspamd/custom-commands.conf`](#with-the-help-of-a-custom-file) - Applied after copying any provided configs from `rspamd/override.d/` (DMS Config volume) to `/etc/rspamd/override.d/`.
-
-!!! abstract "Reference docs for Rspamd config"
-
-    - [Config Overview][rspamd-docs::config::overview], [Quickstart guide][rspamd-docs::config::quickstart], and [Config Syntax (UCL)][rspamd-docs::config::ucl-syntax]
-    - Global Options ([`options.inc`][rspamd-docs::config::global])
-    - [Workers][rspamd-docs::config::workers] ([`worker-controller.inc`][rspamd-docs::config::worker-controller], [`worker-proxy.inc`][rspamd-docs::config::worker-proxy])
-    - [Modules][rspamd-docs::modules] (_view each module page for their specific config options_)
-
-!!! tip "View rendered config"
-
-    `rspamadm configdump` will output the full rspamd configuration that is used should you need it for troubleshooting / inspection.
-
-    - You can also see which modules are enabled / disabled via `rspamadm configdump --modules-state`
-    - Specific config sections like `dkim` or `worker` can also be used to filter the output to just those sections: `rspamadm configdump dkim worker`
-    - Use `--show-help` to include inline documentation for many settings.
-
-### Using `custom-commands.conf` { #with-the-help-of-a-custom-file }
-
-For convenience DMS provides a single config file that will directly create or modify multiple configs at `/etc/rspamd/override.d/`. This is handled as the final rspamd configuration step during container startup.
-
-DMS will apply this config when you provide `rspamd/custom-commands.conf` in your DMS Config volume. Configure it with directive lines as documented below.
-
-!!! note "Only use this feature for `option = value` changes"
-
-    `custom-commands.conf` is only suitable for adding or replacing simple `option = value` settings for configs at `/etc/rspamd/override.d/`.
-  
-    - New settings are appended to the associated config file.
-    - When replacing an existing setting in an override config, that setting may be any matching line (_allowing for nested scopes, instead of only top-level keys_).
-  
-    Any changes involving more advanced [UCL config syntax][rspamd-docs::config::ucl-syntax] should instead add UCL config files directly to `rspamd/override.d/` (_in the DMS Config volume_).
-
-!!! info "`custom-commands.conf` syntax"
-
-    There are 7 directives available to manage custom Rspamd configurations. Add these directive lines into `custom-commands.conf`, they will be processed sequentially.
-
-    **Directives:**
-
-    ```txt
-    # For /etc/rspamd/override.d/{options.inc,worker-controller.inc,worker-proxy}.inc
-    set-common-option         <OPTION NAME> <OPTION VALUE>
-    set-option-for-controller <OPTION NAME> <OPTION VALUE>
-    set-option-for-proxy      <OPTION NAME> <OPTION VALUE>
-
-    # For /etc/rspamd/override.d/<MODULE NAME>.conf
-    enable-module         <MODULE NAME>
-    disable-module        <MODULE NAME>
-    set-option-for-module <MODULE NAME> <OPTION NAME> <OPTION VALUE>
-
-    # For /etc/rspamd/override.d/<FILENAME>
-    add-line <FILENAME> <CONTENT>
-    ```
-
-    **Syntax:**
-
-    - Blank lines are ok.
-    - `#` at the start of a line represents a comment for adding notes.
-    - `<OPTION VALUE>` and `<CONTENT>` will contain the remaining content of their line, any preceding inputs are delimited by white-space.
-
-    ---
-
-    ??? note "`<MODULE NAME>` can also target non-module configs"
-
-        An example is the `statistics` module, which has config to import a separate file (`classifier-bayes.conf`) for easier overrides to this section of the module config.
-
-??? example
-
-    ```conf title="rspamd/custom-commands.conf"
-    # If you're confident you've properly secured access to the rspamd web service/API (Default port: 11334)
-    # with your own auth layer (eg: reverse-proxy) you can bypass rspamd requiring credentials:
-    # https://rspamd.com/doc/workers/controller.html#controller-configuration
-    set-option-for-controller secure_ip "0.0.0.0/0"
-
-    # Some settings aren't documented well, you may find them in snippets or Rspamds default config files:
-    # https://rspamd.com/doc/tutorials/quickstart.html#using-of-milter-protocol-for-rspamd--16
-    # /etc/rspamd/worker-proxy.inc
-    set-option-for-proxy reject_message "Rejected - Detected as spam"
-
-    # Equivalent to the previous example, but `add-line` is more verbose:
-    add-line worker-proxy.inc reject_message = "Rejected - Detected as spam"
-
-    # Enable Bayes auto-learning feature to classify spam based on Rspamd action/score results:
-    # NOTE: The statistics module imports a separate file for classifier-bayes config
-    # https://rspamd.com/doc/configuration/statistic.html#autolearning
-    set-option-for-module classifier-bayes autolearn true
-
-    # Disable the `chartable` module:
-    # https://rspamd.com/doc/modules/chartable.html
-    disable-module chartable
-    ```
-
-## Advanced Configuration
-
-### DKIM Signing
-
-There is a dedicated [section for setting up DKIM with Rspamd in our documentation][docs::dkim-with-rspamd].
-
-### ARC (Authenticated Received Chain)
-
-[ARC][wikipedia::arc] support in DMS is opt-in via config file. [Enable the ARC Rspamd module][rspamd-docs::arc] by creating a config file at `docker-data/dms/config/rspamd/override.d/arc.conf`.
-
-!!! example
-
-    For each mail domain you have DMS manage, add the equivalent `example.com` sub-section to `domain` and adjust the `path` + `selector` fields as necessary.
-
-    ```conf title="rspamd/override.d/arc.conf"
-    sign_local = true;
-    sign_authenticated = true;
-
-    domain {
-        example.com {
-            path = "/tmp/docker-mailserver/rspamd/dkim/rsa-2048-mail-example.private.txt";
-            selector = "mail";
-        }
-    }
-    ```
-
-!!! tip "Using a common keypair"
-
-    As with DKIM, the keypair can be shared across your configured domains.
-
-    Your ARC config can share the same DKIM private key + selector (_with associated DNS record for the public key_).
-
-### _Abusix_ Integration
-
-This subsection provides information about the integration of [Abusix][abusix-web], "a set of blocklists that work as an additional email security layer for your existing mail environment". The setup is straight-forward and well documented:
-
-1. [Create an account][abusix-web::register]
-2. Retrieve your API key
-3. Navigate to the ["Getting Started" documentation for Rspamd][abusix-docs::rspamd-integration] and follow the steps described there
-4. Make sure to change `<APIKEY>` to your private API key
-
-We recommend mounting the files directly into the container, as they are rather big and not manageable with our [`custom-command.conf` script](#with-the-help-of-a-custom-file). If mounted to the correct location, Rspamd will automatically pick them up.
-
-While _Abusix_ can be integrated into Postfix, Postscreen and a multitude of other software, we recommend integrating _Abusix_ only into a single piece of software running in your mail server - everything else would be excessive and wasting queries. Moreover, we recommend the integration into suitable filtering software and not Postfix itself, as software like Postscreen or Rspamd can properly evaluate the return codes and other configuration.
-
-[rspamd-web]: https://rspamd.com/
-[rspamd-docs::bayes]: https://rspamd.com/doc/configuration/statistic.html
-[rspamd-docs::proxy-self-scan-mode]: https://rspamd.com/doc/workers/rspamd_proxy.html#self-scan-mode
-[rspamd-docs::web-ui]: https://rspamd.com/webui/
-[rspamd-docs::web-ui::password]: https://www.rspamd.com/doc/tutorials/quickstart.html#setting-the-controller-password
-[rspamd-docs::modules]: https://rspamd.com/doc/modules/
-[rspamd-docs::modules::rbl]: https://rspamd.com/doc/modules/rbl.html
-[rspamd-docs::config-directories]: https://rspamd.com/doc/faq.html#what-are-the-locald-and-overrided-directories
-[rspamd-docs::config::ucl-syntax]: https://rspamd.com/doc/configuration/ucl.html
-[rspamd-docs::config::overview]: https://rspamd.com/doc/configuration/index.html
-[rspamd-docs::config::quickstart]: https://rspamd.com/doc/tutorials/quickstart.html#configuring-rspamd
-[rspamd-docs::config::global]: https://rspamd.com/doc/configuration/options.html
-[rspamd-docs::config::workers]: https://rspamd.com/doc/workers/
-[rspamd-docs::config::worker-controller]: https://rspamd.com/doc/workers/controller.html
-[rspamd-docs::config::worker-proxy]: https://rspamd.com/doc/workers/rspamd_proxy.html
-
-[wikipedia::arc]: https://en.wikipedia.org/wiki/Authenticated_Received_Chain
-[rspamd-docs::arc]: https://rspamd.com/doc/modules/arc.html
-
-[www::rbl-vs-dnsbl]: https://forum.eset.com/topic/25277-dnsbl-vs-rbl-mail-security/#comment-119818
-[abusix-web]: https://abusix.com/
-[abusix-web::register]: https://app.abusix.com/
-[abusix-docs::rspamd-integration]: https://abusix.com/docs/rspamd/
-[spamhaus::faq::dnsbl-usage]: https://www.spamhaus.org/faq/section/DNSBL%20Usage#365
-
-[dms-repo::rspamd-actions-config]: https://github.com/docker-mailserver/docker-mailserver/tree/v15.0.0/target/rspamd/local.d/actions.conf
-[dms-repo::default-rspamd-configuration]: https://github.com/docker-mailserver/docker-mailserver/tree/v15.0.0/target/rspamd
-[gh-dms::guide::valkey]: https://github.com/docker-mailserver/docker-mailserver/issues/4001#issuecomment-2652596692
-[gh-dms::guide::rspamd-web]: https://github.com/orgs/docker-mailserver/discussions/4269#discussioncomment-11329588
-
-[docs::env::enable-redis]: ../environment.md#enable_rspamd_redis
-[docs::spam-to-junk]: ../environment.md#move_spam_to_junk
-[docs::dkim-dmarc-spf]: ../best-practices/dkim_dmarc_spf.md
-[docs::dkim-with-rspamd]: ../best-practices/dkim_dmarc_spf.md#dkim
-
-[docs::dms-volumes-config]: ../advanced/optional-config.md#volumes-config
-[docs::dms-volumes-state]: ../advanced/optional-config.md#volumes-state
-
-[docs::faq::dns-servers]: ../../faq.md#what-about-dns-servers

docs/content/config/security/ssl.md

@@ -6,7 +6,7 @@ There are multiple options to enable SSL (via [`SSL_TYPE`][docs-env::ssl-type]):
 
 - Using [letsencrypt](#lets-encrypt-recommended) (recommended)
 - Using [Caddy](#caddy)
-- Using [Traefik](#traefik)
+- Using [Traefik](#traefik-v2)
 - Using [self-signed certificates](#self-signed-certificates)
 - Using [your own certificates](#bring-your-own-certificates)
 
@@ -25,39 +25,53 @@ After installation, you can test your setup with:
 
 ## The FQDN
 
-An [FQDN](https://en.wikipedia.org/wiki/Fully_qualified_domain_name) (_Fully Qualified Domain Name_) such as `mail.example.com` is required for DMS to function correctly, especially for looking up the correct SSL certificate to use.
+An [FQDN](https://en.wikipedia.org/wiki/Fully_qualified_domain_name) (_Fully Qualified Domain Name_) such as `mail.example.com` is required for `docker-mailserver` to function correctly, especially for looking up the correct SSL certificate to use.
 
-- `mail.example.com` will still use `user@example.com` as the mail address. You do not need a bare domain for that.
-- We usually discourage assigning a bare domain (_When your DNS MX record does not point to a subdomain_) to represent DMS. However, an FQDN of [just `example.com` is also supported][docs-faq-baredomain].
-- Internally, `hostname -f` will be used to retrieve the FQDN as configured in the below examples.
-- Wildcard certificates (eg: `*.example.com`) are supported for `SSL_TYPE=letsencrypt`. Your configured FQDN below may be `mail.example.com`, and your wildcard certificate provisioned to `/etc/letsencrypt/live/example.com` which will be checked as a fallback FQDN by DMS.
+Internally, `hostname -f` will be used to retrieve the FQDN as configured in the below examples.
 
-!!! example "Setting the hostname correctly"
+Wildcard certificates (eg: `*.example.com`) are supported for `SSL_TYPE=letsencrypt`. Your configured FQDN below may be `mail.example.com`, and your wildcard certificate provisioned to `/etc/letsencrypt/live/example.com` which will be checked as a fallback FQDN by `docker-mailserver`.
 
-    Change `mail.example.com` below to your own FQDN.
+!!! example "Docker CLI options `--hostname` and optionally `--domainname`"
 
     ```sh
-    # CLI:
+    docker run --hostname mail --domainname example.com
+    # `--domainname` is not required:
     docker run --hostname mail.example.com
     ```
 
-    or
+!!! example "`docker-compose.yml` config"
 
     ```yml
-    # compose.yaml
+    services:
+      mailserver:
+        hostname: mail
+        domainname: example.com
+    # `domainname` is not required:
     services:
       mailserver:
         hostname: mail.example.com
     ```
 
+!!! example "_Bare domains_ (eg: `example.com`) should only use the hostname option"
+
+    ```sh
+    docker run --hostname example.com
+    ```
+
+    ```yml
+    services:
+      mailserver:
+        hostname: example.com
+    ```
+
 ## Provisioning methods
 
 ### Let's Encrypt (Recommended)
 
-To enable _Let's Encrypt_ for DMS, you have to:
+To enable _Let's Encrypt_ for `docker-mailserver`, you have to:
 
 1. Get your certificate using the _Let's Encrypt_ client [Certbot][certbot::github].
-2. For your DMS container:
+2. For your `docker-mailserver` container:
 
     - Add the environment variable `SSL_TYPE=letsencrypt`.
     - Mount [your local `letsencrypt` folder][certbot::certs-storage] as a volume to `/etc/letsencrypt`.
@@ -68,16 +82,18 @@ You don't have to do anything else. Enjoy!
 
     `/etc/letsencrypt/live` stores provisioned certificates in individual folders named by their FQDN.
 
-    Make sure that the entire folder is mounted to DMS as there are typically symlinks from `/etc/letsencrypt/live/mail.example.com` to `/etc/letsencrypt/archive`.
+    Make sure that the entire folder is mounted to `docker-mailserver` as there are typically symlinks from `/etc/letsencrypt/live/mail.example.com` to `/etc/letsencrypt/archive`.
 
 !!! example
 
-    Add these additions to the `mailserver` service in your [`compose.yaml`][github-file-compose]:
+    Add these additions to the `mailserver` service in your [`docker-compose.yml`][github-file-compose]:
 
     ```yaml
     services:
       mailserver:
-        hostname: mail.example.com
+        # For the FQDN 'mail.example.com':
+        hostname: mail
+        domainname: example.com
         environment:
           - SSL_TYPE=letsencrypt
         volumes:
@@ -86,11 +102,13 @@ You don't have to do anything else. Enjoy!
 
 #### Example using Docker for _Let's Encrypt_ { data-toc-label='Certbot with Docker' }
 
-Certbot provisions certificates to `/etc/letsencrypt`. Add a volume to store these, so that they can later be accessed by DMS container. You may also want to persist Certbot [logs][certbot::log-rotation], just in case you need to troubleshoot.
+- Certbot provisions certificates to `/etc/letsencrypt`. Add a volume to store these, so that they can later be accessed by `docker-mailserver` container.
+- You may also want to persist Certbot [logs][certbot::log-rotation], just in case you need to troubleshoot.
 
 1. Getting a certificate is this simple! (_Referencing: [Certbot docker instructions][certbot::docker] and [`certonly --standalone` mode][certbot::standalone]_):
 
     ```sh
+    # Change `mail.example.com` below to your own FQDN.
     # Requires access to port 80 from the internet, adjust your firewall if needed.
     docker run --rm -it \
       -v "${PWD}/docker-data/certbot/certs/:/etc/letsencrypt/" \
@@ -99,22 +117,7 @@ Certbot provisions certificates to `/etc/letsencrypt`. Add a volume to store the
       certbot/certbot certonly --standalone -d mail.example.com
     ```
 
-2. Add a volume for DMS that maps the _local `certbot/certs/` folder_ to the container path `/etc/letsencrypt/`.
-
-    !!! example
-
-        Add these additions to the `mailserver` service in your [`compose.yaml`][github-file-compose]:
-
-        ```yaml
-        services:
-          mailserver:
-            hostname: mail.example.com
-            environment:
-              - SSL_TYPE=letsencrypt
-            volumes:
-              - ./docker-data/certbot/certs/:/etc/letsencrypt
-        ```
-
+2. Add a volume for `docker-mailserver` that maps the _local `certbot/certs/` folder_ to the container path `/etc/letsencrypt/`.
 3. The certificate setup is complete, but remember _it will expire_. Consider automating renewals.
 
 !!! tip "Renewing Certificates"
@@ -134,156 +137,16 @@ Certbot provisions certificates to `/etc/letsencrypt`. Add a volume to store the
     ```
 
     This process can also be [automated via _cron_ or _systemd timers_][certbot::automated-renewal].
-    
-    - [Example with a systemd timer][certbot::automated-renewal::example-systemd-timer]
 
 !!! note "Using a different ACME CA"
 
     Certbot does support [alternative certificate providers via the `--server`][certbot::custom-ca] option. In most cases you'll want to use the default _Let's Encrypt_.
 
-#### Example using `certbot-dns-cloudflare` with Docker { data-toc-label='certbot-dns-cloudflare with Docker' }
-
-If you are unable get a certificate via the `HTTP-01` (port 80) or `TLS-ALPN-01` (port 443) [challenge types](https://letsencrypt.org/docs/challenge-types/), the `DNS-01` challenge can be useful (_this challenge can additionally issue wildcard certificates_). This guide shows how to use the `DNS-01` challenge with Cloudflare as your DNS provider.
-
-Obtain a Cloudflare API token:
-
-1. Login into your Cloudflare dashboard.
-2. Navigate to the [API Tokens page](https://dash.cloudflare.com/profile/api-tokens).
-3. Click "Create Token", and choose the `Edit zone DNS` template (_Certbot [requires the `ZONE:DNS:Edit` permission](https://certbot-dns-cloudflare.readthedocs.io/en/stable/#credentials)_).
-
-    !!! warning "Only include the necessary Zone resource configuration"
-
-        Be sure to configure "Zone Resources" section on this page to `Include -> Specific zone -> <your zone here>`.
-
-        This restricts the API token to only this zone (domain) which is an important security measure.
-
-4. Store the _API token_ you received in a file `cloudflare.ini` with content:
-
-    ```dosini
-    dns_cloudflare_api_token = YOUR_CLOUDFLARE_TOKEN_HERE
-    ```
-
-    - As this is sensitive data, you should restrict access to it with `chmod 600` and `chown 0:0`.
-    - Store the file in a folder if you like, such as `docker-data/certbot/secrets/`.
-
-5. Your `compose.yaml` should include the following:
-
-    ```yaml
-    services:
-      mailserver:
-        environments:
-          # Set SSL certificate type.
-          - SSL_TYPE=letsencrypt
-        volumes:
-          # Mount the cert folder generated by Certbot:
-          - ./docker-data/certbot/certs/:/etc/letsencrypt/:ro
-
-      certbot-cloudflare:
-        image: certbot/dns-cloudflare:latest
-        command: certonly --dns-cloudflare --dns-cloudflare-credentials /run/secrets/cloudflare-api-token -d mail.example.com
-        volumes:
-          - ./docker-data/certbot/certs/:/etc/letsencrypt/
-          - ./docker-data/certbot/logs/:/var/log/letsencrypt/
-        secrets:
-          - cloudflare-api-token
-
-    # Docs: https://docs.docker.com/engine/swarm/secrets/#use-secrets-in-compose
-    # WARNING: In compose configs without swarm, the long syntax options have no effect,
-    # Ensure that you properly `chmod 600` and `chown 0:0` the file on disk. Effectively treated as a bind mount.
-    secrets:
-      cloudflare-api-token:
-        file: ./docker-data/certbot/secrets/cloudflare.ini
-    ```
-
-    Alternative using the `docker run` command (`secrets` feature is not available):
-
-      ```sh
-      docker run \
-        --volume "${PWD}/docker-data/certbot/certs/:/etc/letsencrypt/" \
-        --volume "${PWD}/docker-data/certbot/logs/:/var/log/letsencrypt/" \
-        --volume "${PWD}/docker-data/certbot/secrets/:/tmp/secrets/certbot/"
-        certbot/dns-cloudflare \
-        certonly --dns-cloudflare --dns-cloudflare-credentials /tmp/secrets/certbot/cloudflare.ini -d mail.example.com
-      ```
-
-6. Run the service to provision a certificate:
-
-    ```sh
-    docker compose run certbot-cloudflare
-    ```
-
-7. You should see the following log output:
-
-    ```log
-    Saving debug log to /var/log/letsencrypt/letsencrypt. log | Requesting a certificate for mail.example.com
-    Waiting 10 seconds for DNS changes to propagate
-    Successfully received certificate.
-    Certificate is saved at: /etc/letsencrypt/live/mail.example.com/fullchain.pem
-    Key is saved at: /etc/letsencrypt/live/mail.example.com/privkey.pem
-    This certificate expires on YYYY-MM-DD.
-    These files will be updated when the certificate renews.
-    NEXT STEPS:
-    - The certificate will need to be renewed before it expires. Certbot can automatically renew the certificate in background, but you may need to take steps to enable that functionality. See https://certbot.org/renewal instructions.
-    ```
-
-After completing the steps above, your certificate should be ready to use.
-
-??? tip "Renewing a certificate (Optional)"
-
-    We've only demonstrated how to provision a certificate, but it will expire in 90 days and need to be renewed before then.
-
-    In the following example, add a new service (`certbot-cloudflare-renew`) into `compose.yaml` that will handle certificate renewals:
-
-    ```yml
-    services:
-      certbot-cloudflare-renew:
-        image: certbot/dns-cloudflare:latest
-        command: renew --dns-cloudflare --dns-cloudflare-credentials /run/secrets/cloudflare-api-token
-        volumes:
-          - ./docker-data/certbot/certs/:/etc/letsencrypt/
-          - ./docker-data/certbot/logs/:/var/log/letsencrypt/
-        secrets:
-          - cloudflare-api-token
-
-    ```
-
-    You can manually run this service to renew the cert within 90 days:
-
-    ```sh
-    docker compose run certbot-cloudflare-renew
-    ```
-
-    You should see the following output
-    (The following log was generated with `--dry-run` options)
-
-    ```log
-    Saving debug log to /var/log/letsencrypt/letsencrypt.log
-
-    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-    Processing /etc/letsencrypt/renewal/mail.example.com.conf
-    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-    Account registered.
-    Simulating renewal of an existing certificate for mail.example.com
-    Waiting 10 seconds for DNS changes to propagate
-
-    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-    Congratulations, all simulated renewals succeeded:
-      /etc/letsencrypt/live/mail.example.com/fullchain.pem (success)
-    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-    ```
-
-    It is recommended to automate this renewal via a task scheduler like a _systemd timer_ or in `crontab`
-    (`crontab` example: Checks every day if the certificate should be renewed)
-
-    ```sh
-    0 0 * * * docker compose -f PATH_TO_YOUR_DOCKER_COMPOSE_YML up certbot-cloudflare-renew
-    ```
-
 #### Example using `nginx-proxy` and `acme-companion` with Docker { data-toc-label='nginx-proxy with Docker' }
 
 If you are running a web server already, port 80 will be in use which Certbot requires. You could use the [Certbot `--webroot`][certbot::webroot] feature, but it is more common to leverage a _reverse proxy_ that manages the provisioning and renewal of certificates for your services automatically.
 
-In the following example, we show how DMS can be run alongside the docker containers [`nginx-proxy`][nginx-proxy::github] and [`acme-companion`][acme-companion::github] (_Referencing: [`acme-companion` documentation][acme-companion::docs]_):
+In the following example, we show how `docker-mailserver` can be run alongside the docker containers [`nginx-proxy`][nginx-proxy::github] and [`acme-companion`][acme-companion::github] (_Referencing: [`acme-companion` documentation][acme-companion::docs]_):
 
 1. Start the _reverse proxy_ (`nginx-proxy`):
 
@@ -317,7 +180,7 @@ In the following example, we show how DMS can be run alongside the docker contai
 
 3. Start the rest of your web server containers as usual.
 
-4. Start a _dummy container_ to provision certificates for your FQDN (eg: `mail.example.com`). `acme-companion` will detect the container and generate a _Let's Encrypt_ certificate for your domain, which can be used by DMS:
+4. Start a _dummy container_ to provision certificates for your FQDN (eg: `mail.example.com`). `acme-companion` will detect the container and generate a _Let's Encrypt_ certificate for your domain, which can be used by `docker-mailserver`:
 
     ```sh
     docker run --detach \
@@ -330,7 +193,7 @@ In the following example, we show how DMS can be run alongside the docker contai
 
     You may want to add `--env LETSENCRYPT_TEST=true` to the above while testing, to avoid the _Let's Encrypt_ certificate generation rate limits.
 
-5. Make sure your mount path to the `letsencrypt` certificates directory is correct. Edit your `compose.yaml` for the `mailserver` service to have volumes added like below:
+5. Make sure your mount path to the `letsencrypt` certificates directory is correct. Edit your `docker-compose.yml` for the `mailserver` service to have volumes added like below:
 
     ```yaml
     volumes:
@@ -340,17 +203,18 @@ In the following example, we show how DMS can be run alongside the docker contai
       - ./docker-data/acme-companion/certs/:/etc/letsencrypt/live/:ro
     ```
 
-6. Then from the `compose.yaml` project directory, run: `docker compose up -d mailserver`.
+6. Then from the `docker-compose.yml` project directory, run: `docker-compose up -d mailserver`.
 
 #### Example using `nginx-proxy` and `acme-companion` with `docker-compose` { data-toc-label='nginx-proxy with docker-compose' }
 
-The following example is the [basic setup][acme-companion::basic-setup] you need for using `nginx-proxy` and `acme-companion` with DMS (_Referencing: [`acme-companion` documentation][acme-companion::docs]_):
+The following example is the [basic setup][acme-companion::basic-setup] you need for using `nginx-proxy` and `acme-companion` with `docker-mailserver` (_Referencing: [`acme-companion` documentation][acme-companion::docs]_):
 
-???+ example "Example: `compose.yaml`"
+???+ example "Example: `docker-compose.yml`"
 
-    You should have an existing `compose.yaml` with a `mailserver` service. Below are the modifications to add for integrating with `nginx-proxy` and `acme-companion` services:
+    You should have an existing `docker-compose.yml` with a `mailserver` service. Below are the modifications to add for integrating with `nginx-proxy` and `acme-companion` services:
 
     ```yaml
+    version: '3.8'
     services:
       # Add the following `environment` and `volumes` to your existing `mailserver` service:
       mailserver:
@@ -378,17 +242,19 @@ The following example is the [basic setup][acme-companion::basic-setup] you need
         volumes:
           # `certs/`:      Managed by the `acme-companion` container (_read-only_).
           # `docker.sock`: Required to interact with containers via the Docker API.
+          # `dhparam`:     A named data volume to prevent `nginx-proxy` creating an anonymous volume each time.
           - ./docker-data/nginx-proxy/html/:/usr/share/nginx/html/
           - ./docker-data/nginx-proxy/vhost.d/:/etc/nginx/vhost.d/
           - ./docker-data/acme-companion/certs/:/etc/nginx/certs/:ro
           - /var/run/docker.sock:/tmp/docker.sock:ro
+          - dhparam:/etc/nginx/dhparam
 
       acme-companion:
         image: nginxproxy/acme-companion
         container_name: nginx-proxy-acme
         restart: always
         environment:
-          # When `volumes_from: [nginx-proxy]` is not supported,
+          # Only docker-compose v2 supports: `volumes_from: [nginx-proxy]`,
           # reference the _reverse-proxy_ `container_name` here:
           - NGINX_PROXY_CONTAINER=nginx-proxy
         volumes:
@@ -402,6 +268,12 @@ The following example is the [basic setup][acme-companion::basic-setup] you need
           - ./docker-data/acme-companion/certs/:/etc/nginx/certs/:rw
           - ./docker-data/acme-companion/acme-state/:/etc/acme.sh/
           - /var/run/docker.sock:/var/run/docker.sock:ro
+
+    # Once `nginx-proxy` fixes their Dockerfile, this named data volume can be removed from docs.
+    # Users can opt for a local bind mount volume like all others if they prefer, but this volume
+    # is only intended to be temporary.
+    volumes:
+      dhparam:
     ```
 
 !!! tip "Optional ENV vars worth knowing about"
@@ -410,12 +282,12 @@ The following example is the [basic setup][acme-companion::basic-setup] you need
 
     - `LETSENCRYPT_TEST=true`: _Recommended during initial setup_. Otherwise the default production endpoint has a [rate limit of 5 duplicate certificates per week][letsencrypt::limits]. Overrides `ACME_CA_URI` to use the _Let's Encrypt_ staging endpoint.
     - `LETSENCRYPT_EMAIL`: For when you don't use `DEFAULT_EMAIL` on `acme-companion`, or want to assign a different email contact for this container.
-    - `LETSENCRYPT_KEYSIZE`: Allows you to configure the type (RSA or ECDSA) and size of the private key for your certificate. Default is RSA 4096, but RSA 2048 is recommended.
+    - `LETSENCRYPT_KEYSIZE`: Allows you to configure the type (RSA or ECDSA) and size of the private key for your certificate. Default is RSA 4096.
     - `LETSENCRYPT_RESTART_CONTAINER=true`: When the certificate is renewed, the entire container will be restarted to ensure the new certificate is used.
 
     [`acme-companion` ENV for default settings][acme-companion::env-config] that apply to all containers using `LETSENCRYPT_HOST`:
 
-    - `DEFAULT_EMAIL`: An email address that the CA (_eg: Let's Encrypt_) can contact you about expiring certificates, failed renewals, or for account recovery. You may want to use an email address not handled by your mail server to ensure deliverability in the event your mail server breaks.
+    - `DEFAULT_EMAIL`: An email address that the CA (_eg: Let's Encrypt_) can contact you about expiring certificates, failed renewals, or for account recovery. You may want to use an email address not handled by your mail-server to ensure deliverability in the event your mail-server breaks.
     - `CERTS_UPDATE_INTERVAL`: If you need to adjust the frequency to check for renewals. 3600 seconds (1 hour) by default.
     - `DEBUG=1`: Should be helpful when [troubleshooting provisioning issues][acme-companion::troubleshooting] from `acme-companion` logs.
     - `ACME_CA_URI`: Useful in combination with `CA_BUNDLE` to use a private CA. To change the default _Let's Encrypt_ endpoint to the staging endpoint, use `https://acme-staging-v02.api.letsencrypt.org/directory`.
@@ -452,8 +324,8 @@ The following example is the [basic setup][acme-companion::basic-setup] you need
     # Optional variables:
     LETSENCRYPT_mail_TEST=true
     LETSENCRYPT_mail_EMAIL='admin@example.com'
-    # Supported values are `2048`, `3072` and `4096` for RSA keys, and `ec-256` or `ec-384` for elliptic curve keys.
-    LETSENCRYPT_mail_KEYSIZE=2048
+    # RSA-4096 => `4096`, ECDSA-256 => `ec-256`:
+    LETSENCRYPT_mail_KEYSIZE=4096
     ```
 
     Unlike with the equivalent ENV for containers, [changes to this file will **not** be detected automatically][acme-companion::standalone-changes]. You would need to wait until the next renewal check by `acme-companion` (_every hour by default_), restart `acme-companion`, or [manually invoke the _service loop_][acme-companion::service-loop]:
@@ -464,11 +336,13 @@ The following example is the [basic setup][acme-companion::basic-setup] you need
 
 Version 6.2 and later of the Synology NAS DSM OS now come with an interface to generate and renew letencrypt certificates. Navigation into your DSM control panel and go to Security, then click on the tab Certificate to generate and manage letsencrypt certificates.
 
-Amongst other things, you can use these to secure your mail server. DSM locates the generated certificates in a folder below `/usr/syno/etc/certificate/_archive/`.
+Amongst other things, you can use these to secure your mail-server. DSM locates the generated certificates in a folder below `/usr/syno/etc/certificate/_archive/`.
 
-Navigate to that folder and note the 6 character random folder name of the certificate you'd like to use. Then, add the following to your `compose.yaml` declaration file:
+Navigate to that folder and note the 6 character random folder name of the certificate you'd like to use. Then, add the following to your `docker-compose.yml` declaration file:
 
 ```yaml
+# Note: If you have an existing setup that was working pre docker-mailserver v10.2,
+# '/tmp/dms/custom-certs' below has replaced the previous '/tmp/ssl' container path.
 volumes:
   - /usr/syno/etc/certificate/_archive/<your-folder>/:/tmp/dms/custom-certs/
 environment:
@@ -481,142 +355,144 @@ DSM-generated letsencrypt certificates get auto-renewed every three months.
 
 ### Caddy
 
-[Caddy][web::caddy] is an open-source web server with built-in TLS certificate generation. You can use the [official Docker image][dockerhub::caddy] and write your own `Caddyfile`.
+If you are using Caddy to renew your certificates, please note that only RSA certificates work. Read [#1440][github-issue-1440] for details. In short for Caddy v1 the `Caddyfile` should look something like:
 
-!!! example
+```caddyfile
+https://mail.example.com {
+  tls admin@example.com {
+    key_type rsa2048
+  }
+}
+```
 
-    While DMS does not need a webserver to work, this workaround will provision a TLS certificate for DMS to use by adding a dummy site block to trigger cert provisioning.
+For Caddy v2 you can specify the `key_type` in your server's global settings, which would end up looking something like this if you're using a `Caddyfile`:
 
-    ```yaml title="compose.yaml"
-    services:
-      # Basic Caddy service to provision certs:
-      reverse-proxy:
-        image: caddy:2.7
-        ports:
-          - 80:80
-          - 443:443
-        volumes:
-          - ./Caddyfile:/etc/caddy/Caddyfile:ro
-          - ${CADDY_DATA_DIR}:/data
+```caddyfile
+{
+  debug
+  admin localhost:2019
+  http_port 80
+  https_port 443
+  default_sni example.com
+  key_type rsa4096
+}
+```
 
-      # Share the Caddy data volume for certs and configure SSL_TYPE to `letsencrypt`
-      mailserver:
-        image: ghcr.io/docker-mailserver/docker-mailserver:latest
-        hostname: mail.example.com
-        environment:
-          SSL_TYPE: letsencrypt
-        # While you could use a named data volume instead of a bind mount volume, it would require the long-syntax to rename cert files:
-        # https://docs.docker.com/compose/compose-file/05-services/#volumes
-        volumes:
-          - ${CADDY_DATA_DIR}/certificates/acme-v02.api.letsencrypt.org-directory/mail.example.com/mail.example.com.crt:/etc/letsencrypt/live/mail.example.com/fullchain.pem
-          - ${CADDY_DATA_DIR}/certificates/acme-v02.api.letsencrypt.org-directory/mail.example.com/mail.example.com.key:/etc/letsencrypt/live/mail.example.com/privkey.pem
-    ```
-
-    An explicit entry in your `Caddyfile` config will have Caddy provision and renew a certificate for your DMS FQDN:
-
-    ```caddyfile title="Caddyfile"
-    mail.example.com {
-      # Optionally provision RSA 2048-bit certificate instead of ECDSA P-256:
-      tls {
-        key_type rsa2048
-      }
-
-      # Optional, can be useful for troubleshooting
-      # connection to Caddy with correct certificate:
-      respond "Hello DMS"
-    }
-    ```
-
-    !!! info
-
-        An explicit `tls` directive affects only the site-address block it's used in:
-
-        - Use [`tls internal { ... }`][caddy-docs::tls-internal] if wanting to create a local self-signed cert, which may be useful for testing. This allows opt-in to use self-signed certs unlike the global `local_certs` option.
-        - [`key_type`][caddy-docs::key-type] can be used in the `tls` block if you need to enforce RSA as the key type for certificates provisioned. The default is currently ECDSA (P-256). This may improve compatibility with legacy clients.
-
-??? example "With `caddy-docker-proxy`"
-
-    Using [`lucaslorentz/caddy-docker-proxy`][github::caddy-docker-proxy] allows you to generate a `Caddyfile` by adding labels to your services in `compose.yaml`:
-
-    ```yaml title="compose.yaml"
-    services:
-      reverse-proxy:
-        image: lucaslorentz/caddy-docker-proxy:2.8
-        ports:
-          - 80:80
-          - 443:443
-        volumes:
-          - /var/run/docker.sock:/var/run/docker.sock
-          - ${CADDY_DATA_DIR}:/data
-        labels:
-          # Set global config here, this option has an empty value to enable self-signed certs for local testing:
-          # NOTE: Remove this label when going to production.
-          caddy.local_certs: ""
-
-      # Use labels to configure Caddy to provision DMS certs
-      mailserver:
-        image: ghcr.io/docker-mailserver/docker-mailserver:latest
-        hostname: mail.example.com
-        environment:
-          SSL_TYPE: letsencrypt
-        volumes:
-          - ${CADDY_DATA_DIR}/certificates/acme-v02.api.letsencrypt.org-directory/mail.example.com/mail.example.com.crt:/etc/letsencrypt/live/mail.example.com/fullchain.pem
-          - ${CADDY_DATA_DIR}/certificates/acme-v02.api.letsencrypt.org-directory/mail.example.com/mail.example.com.key:/etc/letsencrypt/live/mail.example.com/privkey.pem
-        labels:
-          # Set your DMS FQDN here to add the site-address into the generated Caddyfile:
-          caddy_0: mail.example.com
-          # Adding a dummy directive is required:
-          caddy_0.respond: "Hello DMS"
-          # Uncomment to make a proxy for Rspamd:
-          # caddy_1: rspamd.example.com
-          # caddy_1.reverse_proxy: "{{upstreams 11334}}"
-    ```
-
-!!! warning "Caddy certificate location varies"
-
-    The path contains the certificate provisioner used. This path may be different from the example above for you and may change over time when [multiple ACME provisioner services are used][dms-pr-feedback::caddy-provisioning-gotcha].
-
-    This can make the volume mounting for DMS to find the certificates non-deterministic, but you can [restrict provisioning to single service via the `acme_ca` setting][caddy::restrict-acme-provisioner].
-
-    ---
-
-    **NOTE:** Bind mounting a file directly instead of a directory will mount by inode. If the file is updated at renewal and this modifies the inode on the host system, then the container will still point to the old certificate.
-
-    If this happens, consider using our manual TLS type instead:
-
-    ```yaml title="compose.yaml"
-    services:
-      mailserver:
-        environment:
-          SSL_TYPE: manual
-          SSL_CERT_PATH: /srv/tls/mail.example.com/mail.example.com.crt
-          SSL_KEY_PATH: /srv/tls/mail.example.com/mail.example.com.key
-        volumes:
-          - ${CADDY_DATA_DIR}/certificates/acme-v02.api.letsencrypt.org-directory/mail.example.com/:/srv/tls/mail.example.com/:ro
-    ```
-
-### Traefik
-
-[Traefik][traefik::github] is an open-source application proxy using the [ACME protocol][ietf::rfc::acme]. Traefik can request certificates for domains and subdomains, and it will take care of renewals, challenge negotiations, etc.
-
-Traefik's storage format is natively supported if the `acme.json` store is mounted into the container at `/etc/letsencrypt/acme.json`. The file is also monitored for changes and will trigger a reload of the mail services (Postfix and Dovecot).
-
-DMS will select it's certificate from `acme.json` prioritizing a match for the DMS FQDN (hostname), while also checking one DNS level up (_eg: `mail.example.com` => `example.com`_). Wildcard certificates are supported.
-
-This setup only comes with one caveat - The domain has to be configured on another service for Traefik to actually request it from _Let's Encrypt_ (_i.e. Traefik will not issue a certificate without a service / router demanding it_).
+If you are instead using a json config for Caddy v2, you can set it in your site's TLS automation policies:
 
 ???+ example "Example Code"
 
-    Here is an example setup for [`Docker Compose`](https://docs.docker.com/compose/):
+    ```json
+    {
+      "apps": {
+        "http": {
+          "servers": {
+            "srv0": {
+              "listen": [
+                ":443"
+              ],
+              "routes": [
+                {
+                  "match": [
+                    {
+                      "host": [
+                        "mail.example.com",
+                      ]
+                    }
+                  ],
+                  "handle": [
+                    {
+                      "handler": "subroute",
+                      "routes": [
+                        {
+                          "handle": [
+                            {
+                              "body": "",
+                              "handler": "static_response"
+                            }
+                          ]
+                        }
+                      ]
+                    }
+                  ],
+                  "terminal": true
+                },
+              ]
+            }
+          }
+        },
+        "tls": {
+          "automation": {
+            "policies": [
+              {
+                "subjects": [
+                  "mail.example.com",
+                ],
+                "key_type": "rsa2048",
+                "issuer": {
+                  "email": "admin@example.com",
+                  "module": "acme"
+                }
+              },
+              {
+                "issuer": {
+                  "email": "admin@example.com",
+                  "module": "acme"
+                }
+              }
+            ]
+          }
+        }
+      }
+    }
+    ```
+
+The generated certificates can be mounted:
+
+```yaml
+volumes:
+  - ${CADDY_DATA_DIR}/certificates/acme-v02.api.letsencrypt.org-directory/mail.example.com/mail.example.com.crt:/etc/letsencrypt/live/mail.example.com/fullchain.pem
+  - ${CADDY_DATA_DIR}/certificates/acme-v02.api.letsencrypt.org-directory/mail.example.com/mail.example.com.key:/etc/letsencrypt/live/mail.example.com/privkey.pem
+```
+
+EC certificates fail in the TLS handshake:
+
+```log
+CONNECTED(00000003)
+140342221178112:error:14094410:SSL routines:ssl3_read_bytes:sslv3 alert handshake failure:ssl/record/rec_layer_s3.c:1543:SSL alert number 40
+no peer certificate available
+No client certificate CA names sent
+```
+
+### Traefik v2
+
+[Traefik][traefik::github] is an open-source application proxy using the [ACME protocol][ietf::rfc::acme]. [Traefik][traefik::github] can request certificates for domains and subdomains, and it will take care of renewals, challenge negotiations, etc. We strongly recommend to use [Traefik][traefik::github]'s major version 2.
+
+[Traefik][traefik::github]'s storage format is natively supported if the `acme.json` store is mounted into the container at `/etc/letsencrypt/acme.json`. The file is also monitored for changes and will trigger a reload of the mail services (Postfix and Dovecot).
+
+Wildcard certificates are supported. If your FQDN is `mail.example.com` and your wildcard certificate is `*.example.com`, add the ENV: `#!bash SSL_DOMAIN=example.com`.
+
+The mail-server will select it's certificate from `acme.json` checking these ENV for a matching FQDN (_in order of priority_):
+
+1. `#!bash ${SSL_DOMAIN}`
+2. `#!bash ${HOSTNAME}`
+3. `#!bash ${DOMAINNAME}`
+
+This setup only comes with one caveat: The domain has to be configured on another service for [Traefik][traefik::github] to actually request it from _Let's Encrypt_, i.e. [Traefik][traefik::github] will not issue a certificate without a service / router demanding it.
+
+???+ example "Example Code"
+    Here is an example setup for [`docker-compose`](https://docs.docker.com/compose/):
 
     ```yaml
+    version: '3.8'
     services:
       mailserver:
-        image: ghcr.io/docker-mailserver/docker-mailserver:latest
+        image: docker.io/mailserver/docker-mailserver:latest
         container_name: mailserver
-        hostname: mail.example.com
+        hostname: mail
+        domainname: example.com
         volumes:
-          - ./docker-data/traefik/acme.json:/etc/letsencrypt/acme.json:ro
+           - ./docker-data/traefik/acme.json:/etc/letsencrypt/acme.json:ro
         environment:
           SSL_TYPE: letsencrypt
           SSL_DOMAIN: mail.example.com
@@ -627,26 +503,26 @@ This setup only comes with one caveat - The domain has to be configured on anoth
         image: docker.io/traefik:latest #v2.5
         container_name: docker-traefik
         ports:
-          - "80:80"
-          - "443:443"
+           - "80:80"
+           - "443:443"
         command:
-          - --providers.docker
-          - --entrypoints.http.address=:80
-          - --entrypoints.http.http.redirections.entryPoint.to=https
-          - --entrypoints.http.http.redirections.entryPoint.scheme=https
-          - --entrypoints.https.address=:443
-          - --entrypoints.https.http.tls.certResolver=letsencrypt
-          - --certificatesresolvers.letsencrypt.acme.email=admin@example.com
-          - --certificatesresolvers.letsencrypt.acme.storage=/acme.json
-          - --certificatesresolvers.letsencrypt.acme.httpchallenge.entrypoint=http
+           - --providers.docker
+           - --entrypoints.http.address=:80
+           - --entrypoints.http.http.redirections.entryPoint.to=https
+           - --entrypoints.http.http.redirections.entryPoint.scheme=https
+           - --entrypoints.https.address=:443
+           - --entrypoints.https.http.tls.certResolver=letsencrypt
+           - --certificatesresolvers.letsencrypt.acme.email=admin@example.com
+           - --certificatesresolvers.letsencrypt.acme.storage=/acme.json
+           - --certificatesresolvers.letsencrypt.acme.httpchallenge.entrypoint=http
         volumes:
-          - ./docker-data/traefik/acme.json:/acme.json
-          - /var/run/docker.sock:/var/run/docker.sock:ro
+           - ./docker-data/traefik/acme.json:/acme.json
+           - /var/run/docker.sock:/var/run/docker.sock:ro
 
       whoami:
         image: docker.io/traefik/whoami:latest
         labels:
-          - "traefik.http.routers.whoami.rule=Host(`mail.example.com`)"
+           - "traefik.http.routers.whoami.rule=Host(`mail.example.com`)"
     ```
 
 ### Self-Signed Certificates
@@ -655,19 +531,23 @@ This setup only comes with one caveat - The domain has to be configured on anoth
 
     Use self-signed certificates only for testing purposes!
 
-This feature requires you to provide the following files into your [`docker-data/dms/config/ssl/` directory][docs::dms-volumes-config] (_internal location: `/tmp/docker-mailserver/ssl/`_):
+This feature requires you to provide the following files into your [`docker-data/dms/config/ssl/` directory][docs-optional-config] (_internal location: `/tmp/docker-mailserver/ssl/`_):
 
 - `<FQDN>-key.pem`
 - `<FQDN>-cert.pem`
 - `demoCA/cacert.pem`
 
-Where `<FQDN>` is the FQDN you've configured for your DMS container.
+Where `<FQDN>` is the FQDN you've configured for your `docker-mailserver` container.
 
-Add `SSL_TYPE=self-signed` to your DMS environment variables. Postfix and Dovecot will be configured to use the provided certificate (_`.pem` files above_) during container startup.
+Add `SSL_TYPE=self-signed` to your `docker-mailserver` environment variables. Postfix and Dovecot will be configured to use the provided certificate (_`.pem` files above_) during container startup.
 
 #### Generating a self-signed certificate
 
-One way to generate self-signed certificates is with [Smallstep's `step` CLI](https://smallstep.com/docs/step-cli). This is exactly what [DMS does for creating test certificates][github-file::tls-readme].
+!!! note
+
+    Since `docker-mailserver` v10, support in `setup.sh` for generating a _self-signed SSL certificate_ internally was removed.
+
+One way to generate self-signed certificates is with [Smallstep's `step` CLI](https://smallstep.com/docs/step-cli). This is exactly what [`docker-mailserver` does for creating test certificates][github-file::tls-readme].
 
 For example with the FQDN `mail.example.test`, you can generate the required files by running:
 
@@ -711,7 +591,7 @@ docker run --rm -it \
 
 ### Bring Your Own Certificates
 
-You can also provide your own certificate files. Add these entries to your `compose.yaml`:
+You can also provide your own certificate files. Add these entries to your `docker-compose.yml`:
 
 ```yaml
 volumes:
@@ -731,11 +611,11 @@ The local and internal paths may be whatever you prefer, so long as both `SSL_CE
 
 !!! info
 
-    You may have to restart DMS once the certificates change.
+    You may have to restart `docker-mailserver` once the certificates change.
 
 ## Testing a Certificate is Valid
 
-!!! example "Connect to DMS on port 25"
+- From your host:
 
     ```sh
     docker exec mailserver openssl s_client \
@@ -744,42 +624,26 @@ The local and internal paths may be whatever you prefer, so long as both `SSL_CE
       -CApath /etc/ssl/certs/
     ```
 
-    The response should show the certificate chain with a line further down: `Verify return code: 0 (ok)`
-
-    ---
-
-    This example runs within the DMS container itself to verify the cert is working locally.
-
-    - Adjust the `-connect` IP if testing externally from another system. Additionally testing for port 143 (Dovecot IMAP) is encouraged (_change the protocol for `-starttls` from `smtp` to `imap`_).
-    - `-CApath` will help verify the certificate chain, provided the location contains the root CA that signed your TLS cert for DMS.
-
-??? example "Verify certificate dates"
+- Or:
 
     ```sh
     docker exec mailserver openssl s_client \
-      -connect 0.0.0.0:25 \
-      -starttls smtp \
-      -CApath /etc/ssl/certs/ \
-      2>/dev/null | openssl x509 -noout -dates
+      -connect 0.0.0.0:143 \
+      -starttls imap \
+      -CApath /etc/ssl/certs/
     ```
 
-!!! tip "Testing and troubleshooting"
+And you should see the certificate chain, the server certificate and: `Verify return code: 0 (ok)`
 
-    If you need to test a connection without resolving DNS, `curl` can connect with `--resolve` option to map an FQDN + Port to an IP address, instead of the request address provided.
+In addition, to verify certificate dates:
 
-    ```bash
-    # NOTE: You may want to use `--insecure` if the cert was provisioned with a private CA not present on the curl client:
-    # Use `--verbose` for additional insights on the connection.
-    curl --resolve mail.example.com:443:127.0.0.1 https://mail.example.com
-    ```
-
-    Similarly with `openssl` you can connect to an IP as shown previously, but provide an explicit SNI if necessary with `-servername mail.example.com`.
-
-    ---
-
-    Both `curl` and `openssl` also support `-4` and `-6` for enforcing IPv4 or IPv6 lookup.
-
-    This can be useful, such as when [DNS resolves the IP to different servers leading to different certificates returned][dms-discussion::gotcha-fqdn-bad-dns]. As shown in that link, `step certificate inspect` is also handy for viewing details of the cert returned or on disk.
+```sh
+docker exec mailserver openssl s_client \
+  -connect 0.0.0.0:25 \
+  -starttls smtp \
+  -CApath /etc/ssl/certs/ \
+  2>/dev/null | openssl x509 -noout -dates
+```
 
 ## Plain-Text Access
 
@@ -804,13 +668,15 @@ These options in conjunction mean:
 
 If you have another source for SSL/TLS certificates you can import them into the server via an external script. The external script can be found here: [external certificate import script][hanscees-renewcerts].
 
-This is a community contributed script, and in most cases you will have better support via our _Change Detection_ service (_automatic for `SSL_TYPE` of `manual` and `letsencrypt`_) - Unless you're using LDAP which disables the service.
+!!! attention "Only compatible with `docker-mailserver` releases < `v10.2`"
 
-!!! warning "Script Compatibility"
+    The script expects `/etc/postfix/ssl/cert` and `/etc/postfix/ssl/key` files to be configured paths for both Postfix and Dovecot to use.
 
-    - Relies on private filepaths `/etc/dms/tls/cert` and `/etc/dms/tls/key` intended for internal use only.
-    - Only supports hard-coded `fullchain.key` + `privkey.pem` as your mounted file names. That may not align with your provisioning method.
-    - No support for `ALT` fallback certificates (_for supporting dual/hybrid, RSA + ECDSA_).
+    Since the `docker-mailserver` 10.2 release, certificate files have moved to `/etc/dms/tls/`, and the file name may differ depending on provisioning method.
+
+    This third-party script also has `fullchain.pem` and `privkey.pem` as hard-coded, thus is incompatible with other filenames.
+
+    Additionally it has never supported handling `ALT` fallback certificates (for supporting dual/hybrid, RSA + ECDSA).
 
 The steps to follow are these:
 
@@ -845,7 +711,7 @@ export SITE_URL="mail.example.com"
 export SITE_IP_URL="192.168.0.72" # can also use `mail.example.com`
 export SITE_SSL_PORT="993" # imap port dovecot
 
-##works: check if certificate will expire in two weeks
+##works: check if certificate will expire in two weeks 
 #2 weeks is 1209600 seconds
 #3 weeks is 1814400
 #12 weeks is 7257600
@@ -873,7 +739,7 @@ You can of course run the script by cron once a week or something. In that way y
 ```sh
 # This script is run inside docker-mailserver via 'docker exec ...', using the 'mail' command to send alerts.
 ## code below will alert if certificate expires in less than two weeks
-## please adjust variables!
+## please adjust varables!
 ## make sure the 'mail -s' command works! Test!
 
 export SITE_URL="mail.example.com"
@@ -902,22 +768,22 @@ if [ "$certcheck_2weeks" = "Certificate will not expire" ]; then
     echo "Cert seems to be expiring pretty soon, within two weeks: $certcheck_2weeks"
     echo "we will send an alert email and log as well"
     logger Certwatch: cert $SITE_URL will expire in two weeks
-    echo "Certwatch: cert $SITE_URL will expire in two weeks" | mail -s "cert $SITE_URL expires in two weeks " $ALERT_EMAIL_ADDR
+    echo "Certwatch: cert $SITE_URL will expire in two weeks" | mail -s "cert $SITE_URL expires in two weeks " $ALERT_EMAIL_ADDR 
 fi
 ```
 
 ## Custom DH Parameters
 
-By default DMS uses [`ffdhe4096`][ffdhe4096-src] from [IETF RFC 7919][ietf::rfc::ffdhe]. These are standardized pre-defined DH groups and the only available DH groups for TLS 1.3. It is [discouraged to generate your own DH parameters][dh-avoid-selfgenerated] as it is often less secure.
+By default `docker-mailserver` uses [`ffdhe4096`][ffdhe4096-src] from [IETF RFC 7919][ietf::rfc::ffdhe]. These are standardized pre-defined DH groups and the only available DH groups for TLS 1.3. It is [discouraged to generate your own DH parameters][dh-avoid-selfgenerated] as it is often less secure.
 
 Despite this, if you must use non-standard DH parameters or you would like to swap `ffdhe4096` for a different group (eg `ffdhe2048`); Add your own PEM encoded DH params file via a volume to `/tmp/docker-mailserver/dhparams.pem`. This will replace DH params for both Dovecot and Postfix services during container startup.
 
 [docs-env::ssl-type]: ../environment.md#ssl_type
-[docs::dms-volumes-config]: ../advanced/optional-config.md#volumes-config
-[docs-faq-baredomain]: ../../faq.md#can-i-use-a-nakedbare-domain-ie-no-hostname
+[docs-optional-config]: ../advanced/optional-config.md
 
-[github-file-compose]: https://github.com/docker-mailserver/docker-mailserver/blob/master/compose.yaml
+[github-file-compose]: https://github.com/docker-mailserver/docker-mailserver/blob/master/docker-compose.yml
 [github-file::tls-readme]: https://github.com/docker-mailserver/docker-mailserver/blob/3b8059f2daca80d967635e04d8d81e9abb755a4d/test/test-files/ssl/example.test/README.md
+[github-issue-1440]: https://github.com/docker-mailserver/docker-mailserver/issues/1440
 [hanscees-renewcerts]: https://github.com/hanscees/dockerscripts/blob/master/scripts/tomav-renew-certs
 
 [traefik::github]: https://github.com/containous/traefik
@@ -940,7 +806,6 @@ Despite this, if you must use non-standard DH parameters or you would like to sw
 [certbot::standalone]: https://certbot.eff.org/docs/using.html#standalone
 [certbot::renew]: https://certbot.eff.org/docs/using.html#renewing-certificates
 [certbot::automated-renewal]: https://certbot.eff.org/docs/using.html#automated-renewals
-[certbot::automated-renewal::example-systemd-timer]: https://github.com/orgs/docker-mailserver/discussions/3917#discussioncomment-8661690
 [certbot::custom-ca]: https://certbot.eff.org/docs/using.htmlchanging-the-acme-server
 [certbot::webroot]: https://certbot.eff.org/docs/using.html#webroot
 
@@ -954,13 +819,3 @@ Despite this, if you must use non-standard DH parameters or you would like to sw
 [acme-companion::standalone]: https://github.com/nginx-proxy/acme-companion/blob/main/docs/Standalone-certificates.md
 [acme-companion::standalone-changes]: https://github.com/nginx-proxy/acme-companion/blob/main/docs/Standalone-certificates.md#picking-up-changes-to-letsencrypt_user_data
 [acme-companion::service-loop]: https://github.com/nginx-proxy/acme-companion/blob/main/docs/Container-utilities.md
-
-[web::caddy]: https://caddyserver.com
-[dockerhub::caddy]: https://hub.docker.com/_/caddy
-[github::caddy-docker-proxy]: https://github.com/lucaslorentz/caddy-docker-proxy
-[dms-pr-feedback::caddy-provisioning-gotcha]: https://github.com/docker-mailserver/docker-mailserver/pull/3485/files#r1297512818
-[caddy-docs::tls-internal]: https://caddyserver.com/docs/caddyfile/directives/tls#syntax
-[caddy-docs::key-type]: https://caddyserver.com/docs/caddyfile/options#key-type
-[caddy::restrict-acme-provisioner]: https://caddy.community/t/is-there-a-way-on-a-caddyfile-to-force-a-specific-acme-ca/14506
-
-[dms-discussion::gotcha-fqdn-bad-dns]: https://github.com/docker-mailserver/docker-mailserver/issues/3955#issuecomment-2027882633

docs/content/config/security/understanding-the-ports.md

@@ -4,159 +4,105 @@ title: 'Security | Understanding the Ports'
 
 ## Quick Reference
 
-Prefer ports with Implicit [TLS][wikipedia-tls] ports, they're more secure than ports using Explicit TLS, and if you use a Reverse Proxy should be less hassle.
+Prefer Implicit TLS ports, they're more secure and if you use a Reverse Proxy, should be less hassle (although it's probably wiser to expose these ports directly to `docker-mailserver`).
 
 ## Overview of Email Ports
 
-| Protocol                 | Explicit TLS<sup>1</sup> | Implicit TLS    | Purpose              | Enabled by Default |
-|--------------------------|--------------------------|-----------------|----------------------|--------------------|
-| [ESMTP][wikipedia-esmtp] | 25                       | N/A             | Transfer<sup>2</sup> | Yes                |
-| ESMTP                    | 587                      | 465<sup>3</sup> | Submission           | Yes                |
-| POP3                     | 110                      | 995             | Retrieval            | No                 |
-| IMAP4                    | 143                      | 993             | Retrieval            | Yes                |
+| Protocol | Explicit TLS<sup>1</sup> | Implicit TLS    | Purpose              |
+|----------|--------------------------|-----------------|----------------------|
+| SMTP     | 25                       | N/A             | Transfer<sup>2</sup> |
+| ESMTP    | 587                      | 465<sup>3</sup> | Submission           |
+| POP3     | 110                      | 995             | Retrieval            |
+| IMAP4    | 143                      | 993             | Retrieval            |
 
-1. A connection _may_ be secured over TLS when both ends support `STARTTLS`. On ports 110, 143 and 587, DMS will reject a connection that cannot be secured. Port 25 is [required][ref-port25-mandatory] to support insecure connections.
-2. Receives email, DMS additionally filters for spam and viruses. For submitting email to the server to be sent to third-parties, you should prefer the _submission_ ports (465, 587) - which require authentication. Unless a relay host is configured (eg: SendGrid), outgoing email will leave the server via port 25 (_thus outbound traffic must not be blocked by your provider or firewall_).
-3. A _submission_ port since 2018 ([RFC 8314][rfc-8314]).
-
-??? warning "Beware of outdated advice on port 465"
-
-    There is a common misconception of this port due to it's history detailed by various communities and blogs articles on the topic (_including by popular mail relay services_).
-
-    Port 465 was [briefly assigned the role of SMTPS in 1997][wikipedia-smtps] as an secure alternative to Port 25 between MTA exchanges. Then RFC 2487 (`STARTTLS`) [while still in a draft status in late 1998 had IANA revoke the SMTPS assignment][history-465-revoked]. The [draft history was modified to exclude all mention of port 465 and SMTPS][history-465-politics].
-
-    In 2018 [RFC 8314][rfc-8314] was published which revives Port 465 as an Implicit TLS alternative to Port 587 for mail submission. It details very clearly that gaining adoption of 465 as the preferred port will take time. IANA reassigned [port 465 as the `submissions` service][iana-services-465]. Any unofficial usage as **SMTPS is legacy and has been for over two decades**.
-
-    Understand that port 587 is more broadly supported due to this history and that lots of software in that time has been built or configured with that port in mind. [`STARTTLS` is known to have various CVEs discovered even in recent years][starttls-vulnerabilities], do not be misled by any advice implying it should be preferred over implicit TLS. Trust in more official sources, such as the [config Postfix has][postfix-upstream-config-mastercf] which acknowledges the `submissions` port (465).
+1. A connection *may* be secured over TLS when both ends support `STARTTLS`. On ports 110, 143 and 587, `docker-mailserver` will reject a connection that cannot be secured. Port 25 is [required][ref-port25-mandatory] to support insecure connections.
+2. Receives email, `docker-mailserver` additionally filters for spam and viruses. For submitting email to the server to be sent to third-parties, you should prefer the *submission* ports(465, 587) - which require authentication. Unless a relay host is configured(eg SendGrid), outgoing email will leave the server via port 25(thus outbound traffic must not be blocked by your provider or firewall).
+3. A *submission* port since 2018 ([RFC 8314][rfc-8314]). Previously a secure variant of port 25.
 
 ### What Ports Should I Use? (SMTP)
 
-```mermaid
-flowchart LR
-    subgraph your-server ["Your Server"]
-        in_25(25) --> server
-        in_465(465) --> server
-        server(("docker-mailserver<br/>hello@world.com"))
-        server --- out_25(25)
-        server --- out_465(465)
-    end
+[![Best Practice - Ports (SMTP)][asset-external-mermaid-smtp]][ref-mermaid-live-smtp]
 
-    third-party("Third-party<br/>(sending you email)") ---|"Receive email for<br/>hello@world.com"| in_25
+??? "Flowchart - Mermaid.js source:"
 
-    subgraph clients ["Clients (MUA)"]
-        mua-client(Thunderbird,<br/>Webmail,<br/>Mutt,<br/>etc)
-        mua-service(Backend software<br/>on another server)
-    end
-    clients ---|"Send email as<br/>hello@world.com"| in_465
+    View in the [Live Editor][ref-mermaid-live-smtp].
 
-    out_25(25) -->|"Direct<br/>Delivery"| tin_25
-    out_465(465) --> relay("MTA<br/>Relay Server") --> tin_25(25)
+    ```mermaid
+    flowchart LR
+        subgraph your-server ["Your Server"]
+            in_25(25) --> server
+            in_465(465) --> server
+            server(("docker-mailserver<br/>hello@world.com"))
+            server --- out_25(25)
+            server --- out_465(465)
+        end
 
-    subgraph third-party-server["Third-party Server"]
-        third-party-mta("MTA<br/>friend@example.com")
-        tin_25(25) --> third-party-mta
-    end
-```
+        third-party("Third-party<br/>(sending you email)") ---|"Receive email for<br/>hello@world.com"| in_25
+
+        subgraph clients ["Clients (MUA)"]
+            mua-client(Thunderbird,<br/>Webmail,<br/>Mutt,<br/>etc)
+            mua-service(Backend software<br/>on another server)
+        end
+        clients ---|"Send email as<br/>hello@world.com"| in_465
+
+        out_25(25) -->|"Direct<br/>Delivery"| tin_25
+        out_465(465) --> relay("MTA<br/>Relay Server") --> tin_25(25)
+
+        subgraph third-party-server["Third-party Server"]
+            third-party-mta("MTA<br/>friend@example.com")
+            tin_25(25) --> third-party-mta
+        end
+    ```
 
 ---
 
 #### Inbound Traffic (On the left)
 
-Mail arriving at your server will be processed and stored in a mailbox, or sent outbound to another mail server.
-
-- **Port 25:**
-    - Think of this like a physical mailbox, anyone can deliver mail to you here. Typically most mail is delivered to you on this port.
-    - DMS will actively filter email delivered on this port for spam or viruses, and refuse mail from known bad sources.
-    - Connections to this port may be secure through STARTTLS, but is not mandatory as [mail is allowed to arrive via an unencrypted connection][ref-port25-mandatory].
-    - It is possible for internal clients to submit mail to be sent outbound (_without requiring authentication_), but that is discouraged. Prefer the _submission_ ports.
-- **Port 465 and 587:**
-    - This is the equivalent of a post office box where you would send email to be delivered on your behalf (_DMS is that metaphorical post office, aka the MTA_).
-    - These two ports are known as the _submission_ ports, they enable mail to be sent outbound to another MTA (eg: Outlook or Gmail) but require authentication via a [mail account][docs-accounts].
-    - For inbound traffic, this is relevant when you send mail from your MUA (eg: ThunderBird). It's also used when DMS is configured as a mail relay, or when you have a service sending transactional mail (_eg: order confirmations, password resets, notifications_) through DMS.
-    - _**Prefer port 465**_ over port 587, as 465 provides Implicit TLS.
-
-!!! note
-
-    When submitting mail (inbound) to be sent (outbound), this involves two separate connections to negotiate and secure. There may be additional intermediary connections which DMS is not involved in, and thus unable to ensure encrypted transit throughout delivery.
+- **Port 25:** Think of this like a physical mailbox, it is open to receive email from anyone who wants to. `docker-mailserver` will actively filter email delivered on this port for spam or viruses and refuse mail from known bad sources. While you could also use this port internally to send email outbound without requiring authentication, you really should prefer the *Submission* ports(587, 465).
+- **Port 465(*and 587*):** This is the equivalent of a post office box where you would send email to be delivered on your behalf(`docker-mailserver` is that metaphorical post office, aka the MTA). Unlike port 25, these two ports are known as the *Submission* ports and require a valid email account on the server with a password to be able to send email to anyone outside of the server(an MTA you do not control, eg Outlook or Gmail). Prefer port 465 which provides Implicit TLS.
 
 #### Outbound Traffic (On the Right)
 
-Mail being sent from your server is either being relayed through another MTA (eg: SendGrid), or direct to an MTA responsible for an email address (eg: Gmail).
-
-- **Port 25:**
-    - As most MTA use port 25 to receive inbound mail, when no authenticated relay is involved this is the outbound port used.
-    - Outbound traffic on this port is often blocked by service providers (eg: VPS, ISP) to prevent abuse by spammers. If the port cannot be unblocked, you will need to relay outbound mail through a service to send on your behalf.
-- **Port 465 and 587:**
-    - Submission ports for outbound traffic establish trust to forward mail through a third-party relay service. This requires [authenticating to an account on the relay service][docs-relays]. The relay will then deliver the mail through port 25 on your behalf.
-    - These are the two typical ports used, but smart hosts like SendGrid often document support for additional non-standard ports as alternatives if necessary.
-    - Usually you'll only use these outbound ports for relaying. It is possible to deliver directly to the relevant MTA for email address, but requires having credentials for each MTA.
-
-!!! tip
-
-    DMS can function as a relay too, but professional relay services have a trusted reputation (_which increases success of delivery_).
-
-    An MTA with low reputation can affect if mail is treated as junk, or even rejected.
-
-!!! note
-
-    At best, you can only ensure a secure connection between the MTA you directly connect to. The receiving MTA may relay that mail to another MTA (_and so forth_), each connection may not be enforcing TLS.
-
+- **Port 25:** Send the email directly to the given email address MTA as possible. Like your own `docker-mailserver` port 25, this is the standard port for receiving email on, thus email will almost always arrive to the final MTA on this port. Note that, there may be additional MTAs further in the chain, but this would be the public facing one representing that email address.
+- **Port 465(*and 587*):** SMTP Relays are a popular choice to hand-off delivery of email through. Services like SendGrid are useful for bulk email(marketing) or when your webhost or ISP are preventing you from using standard ports like port 25 to send out email(which can be abused by spammers). 
+  
+  `docker-mailserver` can serve as a relay too, but the difference between a DIY relay and a professional service is reputation, which is referenced by MTAs you're delivering to such as Outlook, Gmail or others(perhaps another `docker-mailserver` server!), when deciding if email should be marked as junked or potentially not delivered at all. As a service like SendGrid has a reputation to maintain, relay is restricted to registered users who must authenticate(even on port 25), they do not store email, merely forward it to another MTA which could be delivered on a different port like 25.
 
 ### Explicit vs Implicit TLS
 
 #### Explicit TLS (aka Opportunistic TLS) - Opt-in Encryption
 
-Communication on these ports begin in [cleartext][ref-clear-vs-plain]. Upgrading to an encrypted connection must be requested explicitly through the `STARTTLS` protocol **and** successfully negotiated.
+Communication on these ports begin in [cleartext][ref-clear-vs-plain], indicating support for `STARTTLS`. If both client and server support `STARTTLS` the connection will be secured over TLS, otherwise no encryption will be used.
 
-Sometimes a reverse-proxy is involved, but is misconfigured or lacks support for the `STARTTLS` negotiation to succeed.
-
-!!! note
-
-    - By default, DMS is configured to reject connections that fail to establish a secure connection (_when authentication is required_), rather than allow an insecure connection.
-    - Port 25 does not require authentication. If `STARTTLS` is unsuccessful, mail can be received over an unencrypted connection. You can better secure this port between trusted parties with the addition of MTA-STS, [STARTTLS Policy List][starttls-policy-list], DNSSEC and DANE.
-
-!!! warning
-
-    `STARTTLS` [continues to have vulnerabilities found][starttls-vulnerabilities] (Nov 2021 article), as per [RFC 8314 (Section 4.1)][rfc-8314-s41] you are encouraged to **prefer Implicit TLS where possible**.
-
-    Support for `STARTTLS` is not always implemented correctly, which can lead to leaking credentials (like a client sending too early) prior to a TLS connection being established. Third-parties such as some ISPs have also been known to intercept the `STARTTLS` exchange, modifying network traffic to prevent establishing a secure connection.
+Support for `STARTTLS` is not always implemented correctly, which can lead to leaking credentials(client sending too early) prior to a TLS connection being established. Third-parties such as some ISPs have also been known to intercept the `STARTTLS` exchange, modifying network traffic to prevent establishing a secure connection.
 
+Due to these security concerns, [RFC 8314 (Section 4.1)][rfc-8314-s41] encourages you to **prefer Implicit TLS ports where possible**. 
 
 #### Implicit TLS - Enforced Encryption
 
-Communication on these ports are always encrypted (_enforced, thus implicit_), avoiding the potential risks with `STARTTLS` (Explicit TLS).
+Communication is always encrypted, avoiding the above mentioned issues with Explicit TLS.
 
-While Explicit TLS can provide the same benefit (_when `STARTTLS` is successfully negotiated_), Implicit TLS more reliably avoids concerns with connection manipulation and compatibility.
+You may know of these ports as **SMTPS, POP3S, IMAPS**, which indicate the protocol in combination with a TLS connection. However, Explicit TLS ports provide the same benefit when `STARTTLS` is successfully negotiated; Implicit TLS better communicates the improved security to all three protocols (SMTP/POP3/IMAP over Implicit TLS).
 
+Additionally, referring to port 465 as *SMTPS* would be incorrect, as it is a submissions port requiring authentication to proceed via *ESMTP*, whereas ESMTPS has a different meaning(STARTTLS supported). Port 25 may lack Implicit TLS, but can be configured to be more secure between trusted parties via MTA-STS, STARTTLS Policy List, DNSSEC and DANE.
 
 ## Security
 
 !!! todo
-
     This section should provide any related configuration advice, and probably expand on and link to resources about DANE, DNSSEC, MTA-STS and STARTTLS Policy list, with advice on how to configure/setup these added security layers.
 
 !!! todo
-
     A related section or page on ciphers used may be useful, although less important for users to be concerned about.
 
-### TLS connections for a Mail Server, compared to web browsers
+### TLS connections for a Mail-Server, compared to web browsers
 
-Unlike with HTTP where a web browser client communicates directly with the server providing a website, a secure TLS connection as discussed below does not provide the equivalent safety that HTTPS does when the transit of email (receiving or sending) is sent through third-parties, as the secure connection is only between two machines, any additional machines (MTAs) between the MUA and the MDA depends on them establishing secure connections between one another successfully.
+Unlike with HTTP where a web browser client communicates directly with the server providing a website, a secure TLS connection as discussed below is not the equivalent safety that HTTPS provides when the transit of email (receiving or sending) is sent through third-parties, as the secure connection is only between two machines, any additional machines (MTAs) between the MUA and the MDA depends on them establishing secure connections between one another successfully.
 
-Other machines that facilitate a connection that generally aren't taken into account can exist between a client and server, such as those where your connection passes through your ISP provider are capable of compromising a `cleartext` connection through interception.
+Other machines that facilitate a connection that generally aren't taken into account can exist between a client and server, such as those where your connection passes through your ISP provider are capable of compromising a cleartext connection through interception.
 
-[docs-accounts]: ../account-management/overview.md#accounts
-[docs-relays]: ../advanced/mail-forwarding/relay-hosts.md
-[iana-services-465]: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml?search=465
-[starttls-policy-list]: https://github.com/EFForg/starttls-everywhere#email-security-database-starttls-policy-list
-[starttls-vulnerabilities]: https://blog.apnic.net/2021/11/18/vulnerabilities-show-why-starttls-should-be-avoided-if-possible/
+[asset-external-mermaid-smtp]: https://mermaid.ink/img/eyJjb2RlIjoiZmxvd2NoYXJ0IExSXG4gICAgc3ViZ3JhcGggeW91ci1zZXJ2ZXIgW1wiWW91ciBTZXJ2ZXJcIl1cbiAgICAgICAgaW5fMjUoMjUpIC0tPiBzZXJ2ZXJcbiAgICAgICAgaW5fNDY1KDQ2NSkgLS0-IHNlcnZlclxuICAgICAgICBzZXJ2ZXIoKFwiZG9ja2VyLW1haWxzZXJ2ZXI8YnIvPmhlbGxvQHdvcmxkLmNvbVwiKSlcbiAgICAgICAgc2VydmVyIC0tLSBvdXRfMjUoMjUpXG4gICAgICAgIHNlcnZlciAtLS0gb3V0XzQ2NSg0NjUpXG4gICAgZW5kXG5cbiAgICB0aGlyZC1wYXJ0eShcIlRoaXJkLXBhcnR5PGJyLz4oc2VuZGluZyB5b3UgZW1haWwpXCIpIC0tLXxcIlJlY2VpdmUgZW1haWwgZm9yPGJyLz5oZWxsb0B3b3JsZC5jb21cInwgaW5fMjVcblxuICAgIHN1YmdyYXBoIGNsaWVudHMgW1wiQ2xpZW50cyAoTVVBKVwiXVxuICAgICAgICBtdWEtY2xpZW50KFRodW5kZXJiaXJkLDxici8-V2VibWFpbCw8YnIvPk11dHQsPGJyLz5ldGMpXG4gICAgICAgIG11YS1zZXJ2aWNlKEJhY2tlbmQgc29mdHdhcmU8YnIvPm9uIGFub3RoZXIgc2VydmVyKVxuICAgIGVuZFxuICAgIGNsaWVudHMgLS0tfFwiU2VuZCBlbWFpbCBhczxici8-aGVsbG9Ad29ybGQuY29tXCJ8IGluXzQ2NVxuXG4gICAgb3V0XzI1KDI1KSAtLT58XCJEaXJlY3Q8YnIvPkRlbGl2ZXJ5XCJ8IHRpbl8yNVxuICAgIG91dF80NjUoNDY1KSAtLT4gcmVsYXkoXCJNVEE8YnIvPlJlbGF5IFNlcnZlclwiKSAtLT4gdGluXzI1KDI1KVxuXG4gICAgc3ViZ3JhcGggdGhpcmQtcGFydHktc2VydmVyW1wiVGhpcmQtcGFydHkgU2VydmVyXCJdXG4gICAgICAgIHRoaXJkLXBhcnR5LW10YShcIk1UQTxici8-ZnJpZW5kQGV4YW1wbGUuY29tXCIpXG4gICAgICAgIHRpbl8yNSgyNSkgLS0-IHRoaXJkLXBhcnR5LW10YVxuICAgIGVuZCIsIm1lcm1haWQiOnsidGhlbWUiOiJkZWZhdWx0In0sInVwZGF0ZUVkaXRvciI6ZmFsc2V9
 [ref-clear-vs-plain]: https://www.denimgroup.com/resources/blog/2007/10/cleartext-vs-pl
 [ref-port25-mandatory]: https://serverfault.com/questions/623692/is-it-still-wrong-to-require-starttls-on-incoming-smtp-messages
+[ref-mermaid-live-smtp]: https://mermaid-js.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoiZmxvd2NoYXJ0IExSXG4gICAgc3ViZ3JhcGggeW91ci1zZXJ2ZXIgW1wiWW91ciBTZXJ2ZXJcIl1cbiAgICAgICAgaW5fMjUoMjUpIC0tPiBzZXJ2ZXJcbiAgICAgICAgaW5fNDY1KDQ2NSkgLS0-IHNlcnZlclxuICAgICAgICBzZXJ2ZXIoKFwiZG9ja2VyLW1haWxzZXJ2ZXI8YnIvPmhlbGxvQHdvcmxkLmNvbVwiKSlcbiAgICAgICAgc2VydmVyIC0tLSBvdXRfMjUoMjUpXG4gICAgICAgIHNlcnZlciAtLS0gb3V0XzQ2NSg0NjUpXG4gICAgZW5kXG5cbiAgICB0aGlyZC1wYXJ0eShcIlRoaXJkLXBhcnR5PGJyLz4oc2VuZGluZyB5b3UgZW1haWwpXCIpIC0tLXxcIlJlY2VpdmUgZW1haWwgZm9yPGJyLz5oZWxsb0B3b3JsZC5jb21cInwgaW5fMjVcblxuICAgIHN1YmdyYXBoIGNsaWVudHMgW1wiQ2xpZW50cyAoTVVBKVwiXVxuICAgICAgICBtdWEtY2xpZW50KFRodW5kZXJiaXJkLDxici8-V2VibWFpbCw8YnIvPk11dHQsPGJyLz5ldGMpXG4gICAgICAgIG11YS1zZXJ2aWNlKEJhY2tlbmQgc29mdHdhcmU8YnIvPm9uIGFub3RoZXIgc2VydmVyKVxuICAgIGVuZFxuICAgIGNsaWVudHMgLS0tfFwiU2VuZCBlbWFpbCBhczxici8-aGVsbG9Ad29ybGQuY29tXCJ8IGluXzQ2NVxuXG4gICAgb3V0XzI1KDI1KSAtLT58XCJEaXJlY3Q8YnIvPkRlbGl2ZXJ5XCJ8IHRpbl8yNVxuICAgIG91dF80NjUoNDY1KSAtLT4gcmVsYXkoXCJNVEE8YnIvPlJlbGF5IFNlcnZlclwiKSAtLT4gdGluXzI1KDI1KVxuXG4gICAgc3ViZ3JhcGggdGhpcmQtcGFydHktc2VydmVyW1wiVGhpcmQtcGFydHkgU2VydmVyXCJdXG4gICAgICAgIHRoaXJkLXBhcnR5LW10YShcIk1UQTxici8-ZnJpZW5kQGV4YW1wbGUuY29tXCIpXG4gICAgICAgIHRpbl8yNSgyNSkgLS0-IHRoaXJkLXBhcnR5LW10YVxuICAgIGVuZCIsIm1lcm1haWQiOnsidGhlbWUiOiJkZWZhdWx0In0sInVwZGF0ZUVkaXRvciI6ZmFsc2V9
 [rfc-8314]: https://tools.ietf.org/html/rfc8314
 [rfc-8314-s41]: https://tools.ietf.org/html/rfc8314#section-4.1
-[history-465-revoked]: https://web.archive.org/web/20150603202057/http://www.imc.org/ietf-apps-tls/mail-archive/msg00204.html
-[history-465-politics]: https://mailing.postfix.users.narkive.com/F3ACwg2F/which-port-to-use-for-ssl-tls#post21
-[postfix-upstream-config-mastercf]: https://github.com/vdukhovni/postfix/blob/62931e5b1f9f1e80d02a496c7fd0062a5aae1d25/postfix/conf/master.cf#L38-L41
-[wikipedia-smtps]: https://en.wikipedia.org/wiki/SMTPS#History
-[wikipedia-esmtp]: https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol#Modern_SMTP
-[wikipedia-tls]: https://en.wikipedia.org/wiki/Transport_Layer_Security

docs/content/config/setup.sh.md

@@ -1,28 +1,125 @@
 ---
-title: About setup.sh
+title: Your best friend setup.sh
 hide:
   - toc
 ---
 
-!!! note
+[`setup.sh`][github-file-setupsh] is an administration script that helps with the most common tasks, including initial configuration. It is intended to be run from the host machine, _not_ from inside your running container.
 
-    `setup.sh` is not required. We encourage you to use `docker exec -ti <CONTAINER NAME> setup` instead.
-
-!!! warning
-
-    This script assumes Docker or Podman is used. You will not be able to use `setup.sh` with other container orchestration tools.
-
-[`setup.sh`][github-file-setupsh] is a script that is complimentary to the internal `setup` command in DMS.
-
-It mostly provides the convenience of aliasing `docker exec -ti <CONTAINER NAME> setup`, inferring the container name of a running DMS instance or running a new instance and bind mounting necessary volumes implicitly.
-
-It is intended to be run from the host machine, _not_ from inside your running container. The latest version of the script is included in the DMS repository. You may retrieve it at any time by running this command in your console:
+The latest version of the script is included in the `docker-mailserver` repository. You may retrieve it at any time by running this command in your console:
 
 ```sh
 wget https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/master/setup.sh
 chmod a+x ./setup.sh
 ```
 
-For more information on using the script run: `./setup.sh help`.
+!!! warning "`setup.sh` for `docker-mailserver` version `v10.1.x` and below"
+
+    If you're using `docker-mailserver` version `v10.1.x` or below, you will need to get `setup.sh` with a specific version. Substitute `<VERSION>` with the [tagged release version](https://github.com/docker-mailserver/docker-mailserver/tags) that you're using:
+    
+    `wget https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/<VERSION>/setup.sh`.
+
+## Usage
+
+Run `./setup.sh help` and you'll get ~~all you have ever wanted~~ some usage information:
+
+```TXT
+SETUP(1)
+
+NAME
+    setup.sh - docker-mailserver administration script
+
+SYNOPSIS
+    ./setup.sh [ OPTIONS... ] COMMAND [ help | ARGUMENTS... ]
+
+    COMMAND := { email | alias | quota | config | relay | debug } SUBCOMMAND
+
+DESCRIPTION
+    This is the main administration script that you use for all your interactions with
+    'docker-mailserver'. Setup, configuration and much more is done with this script.
+
+    Please note that the script executes most of the commands inside the container itself.
+    If the image was not found, this script will pull the ':latest' tag of
+    'mailserver/docker-mailserver'. This tag refers to the latest release,
+    see the tagging convention in the README under
+    https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md
+
+    You will be able to see detailed information about the script you're invoking and
+    its arguments by appending help after your command. Currently, this
+    does not work with all scripts.
+
+[SUB]COMMANDS
+    COMMAND email :=
+        ./setup.sh email add <EMAIL ADDRESS> [<PASSWORD>]
+        ./setup.sh email update <EMAIL ADDRESS> [<PASSWORD>]
+        ./setup.sh email del [ OPTIONS... ] <EMAIL ADDRESS> [ <EMAIL ADDRESS>... ]
+        ./setup.sh email restrict <add|del|list> <send|receive> [<EMAIL ADDRESS>]
+        ./setup.sh email list
+
+    COMMAND alias :=
+        ./setup.sh alias add <EMAIL ADDRESS> <RECIPIENT>
+        ./setup.sh alias del <EMAIL ADDRESS> <RECIPIENT>
+        ./setup.sh alias list
+
+    COMMAND quota :=
+        ./setup.sh quota set <EMAIL ADDRESS> [<QUOTA>]
+        ./setup.sh quota del <EMAIL ADDRESS>
+
+    COMMAND config :=
+        ./setup.sh config dkim [ ARGUMENTS... ]
+
+    COMMAND relay :=
+        ./setup.sh relay add-domain <DOMAIN> <HOST> [<PORT>]
+        ./setup.sh relay add-auth <DOMAIN> <USERNAME> [<PASSWORD>]
+        ./setup.sh relay exclude-domain <DOMAIN>
+
+    COMMAND debug :=
+        ./setup.sh debug fetchmail
+        ./setup.sh debug fail2ban [unban <IP>]
+        ./setup.sh debug show-mail-logs
+        ./setup.sh debug inspect
+        ./setup.sh debug login <COMMANDS>
+
+EXAMPLES
+    ./setup.sh email add test@example.com
+        Add the email account test@example.com. You will be prompted
+        to input a password afterwards since no password was supplied.
+
+    ./setup.sh config dkim keysize 2048 domain 'example.com,not-example.com'
+        Creates keys of length 2048 but in an LDAP setup where domains are not known to
+        Postfix by default, so you need to provide them yourself in a comma-separated list.
+
+    ./setup.sh config dkim help
+        This will provide you with a detailed explanation on how to use the
+        config dkim command, showing what arguments can be passed and what they do.
+
+OPTIONS
+    Config path, container or image adjustments
+        -i IMAGE_NAME
+            Provides the name of the 'docker-mailserver' image. The default value is
+            'docker.io/mailserver/docker-mailserver:latest'
+
+        -c CONTAINER_NAME
+            Provides the name of the running container.
+
+        -p PATH
+            Provides the config folder path to the temporary container
+            (does not work if a 'docker-mailserver' container already exists).
+
+    SELinux
+        -z
+            Allows container access to the bind mount content that is shared among
+            multiple containers on a SELinux-enabled host.
+
+        -Z
+            Allows container access to the bind mount content that is private and
+            unshared with other containers on a SELinux-enabled host.
+
+EXIT STATUS
+    Exit status is 0 if the command was successful. If there was an unexpected error, an error
+    message is shown describing the error. In case of an error, the script will exit with exit
+    status 1.
+
+```
 
 [github-file-setupsh]: https://github.com/docker-mailserver/docker-mailserver/blob/master/setup.sh

docs/content/config/troubleshooting/debugging.md

@@ -0,0 +1,65 @@
+---
+title: 'Troubleshooting | Debugging'
+---
+
+!!! info "Contributions Welcome!"
+    Please contribute your solutions to help the community :heart:
+
+## Enable Verbose Debugging Output
+
+You may find it useful to enable the [`DMS_DEBUG`][docs-environment-dmsdebug] environment variable.
+
+## Invalid Username or Password
+
+1. Shell into the container:
+
+    ```sh
+    docker exec -it <my-container> bash
+    ```
+
+2. Check log files in `/var/log/mail` could not find any mention of incorrect logins here neither in the dovecot logs.
+
+3. Check the supervisors logs in `/var/log/supervisor`. You can find the logs for startup of fetchmail, postfix and others here - they might indicate problems during startup.
+
+4. Make sure you set your hostname to `mail` or whatever you specified in your `docker-compose.yml` file or else your FQDN will be wrong.
+
+## Installation Errors
+
+During setup, if you get errors trying to edit files inside of the container, you likely need to install `vi`:
+
+```sh
+sudo su
+docker exec -it <my-container> apt-get install -y vim
+```
+
+## Testing Connection
+
+I spent HOURS trying to debug "Connection Refused" and "Connection closed by foreign host" errors when trying to use telnet to troubleshoot my connection. I was also trying to connect from my email client (macOS mail) around the same time. Telnet had also worked earlier, so I was extremely confused as to why it suddenly stopped working. I stumbled upon `fail2ban.log` in my container. In short, when trying to get my macOS client working, I exceeded the number of failed login attempts and fail2ban put dovecot and postfix in jail! I got around it by whitelisting my ipaddresses (my ec2 instance and my local computer)
+
+```sh
+sudo su
+docker exec -it mailserver bash
+cd /var/log
+cat fail2ban.log | grep dovecot
+
+# Whitelist IP addresses:
+fail2ban-client set dovecot addignoreip <server ip>  # Server
+fail2ban-client set postfix addignoreip <server ip>
+fail2ban-client set dovecot addignoreip <client ip>  # Client
+fail2ban-client set postfix addignoreip <client ip>
+
+# This will delete the jails entirely - nuclear option
+fail2ban-client stop dovecot
+fail2ban-client stop postfix
+```
+
+## Sent email is never received
+
+Some hosting provides have a stealth block on port 25. Make sure to check with your hosting provider that traffic on port 25 is allowed
+
+Common hosting providers known to have this issue:
+
+- [Azure](https://docs.microsoft.com/en-us/azure/virtual-network/troubleshoot-outbound-smtp-connectivity)
+- [AWS EC2](https://aws.amazon.com/premiumsupport/knowledge-center/ec2-port-25-throttle/)
+
+[docs-environment-dmsdebug]: ../environment.md#dms_debug

docs/content/config/user-management/accounts.md

@@ -0,0 +1,47 @@
+---
+title: 'User Management | Accounts'
+hide:
+  - toc # Hide Table of Contents for this page
+---
+
+## Adding a New Account
+
+Users (email accounts) are managed in `/tmp/docker-mailserver/postfix-accounts.cf`. **_The best way to manage accounts is to use the reliable [`setup.sh`][docs-setupsh] script_**. Or you may directly add the _full_ email address and its encrypted password, separated by a pipe:
+
+```cf
+user1@example.com|{SHA512-CRYPT}$6$2YpW1nYtPBs2yLYS$z.5PGH1OEzsHHNhl3gJrc3D.YMZkvKw/vp.r5WIiwya6z7P/CQ9GDEJDr2G2V0cAfjDFeAQPUoopsuWPXLk3u1
+user2@not-example.com|{SHA512-CRYPT}$6$2YpW1nYtPBs2yLYS$z.5PGH1OEzsHHNhl3gJrc3D.YMZkvKw/vp.r5WIiwya6z7P/CQ9GDEJDr2G2V0cAfjDFeAQPUoopsuWPXLk3u1
+```
+
+In the example above, we've added 2 mail accounts for 2 different domains. Consequently, the mail-server will automatically be configured for multi-domains. Therefore, to generate a new mail account data, directly from your docker host, you could for example run the following:
+
+```sh
+docker run --rm \
+  -e MAIL_USER=user1@example.com \
+  -e MAIL_PASS=mypassword \
+  -it mailserver/docker-mailserver:latest \
+  /bin/sh -c 'echo "$MAIL_USER|$(doveadm pw -s SHA512-CRYPT -u $MAIL_USER -p $MAIL_PASS)"' >> docker-data/dms/config/postfix-accounts.cf
+```
+
+You will then be asked for a password, and be given back the data for a new account entry, as text. To actually _add_ this new account, just copy all the output text in `docker-data/dms/config/postfix-accounts.cf` file of your running container.
+
+!!! note
+
+    `doveadm pw` command lets you choose between several encryption schemes for the password.
+
+    Use `doveadm pw -l` to get a list of the currently supported encryption schemes.
+
+!!! note
+
+    Changes to the accounts list require a restart of the container, using `supervisord`. See [#552][github-issue-552].
+
+---
+
+### Notes
+
+- `imap-quota` is enabled and allow clients to query their mailbox usage.
+- When the mailbox is deleted, the quota directive is deleted as well.
+- Dovecot quotas support LDAP, **but it's not implemented** (_PRs are welcome!_).
+
+[docs-setupsh]: ../setup.sh.md
+[github-issue-552]: https://github.com/docker-mailserver/docker-mailserver/issues/552

docs/content/config/user-management/aliases.md

@@ -0,0 +1,42 @@
+---
+title: 'User Management | Aliases'
+---
+
+Please read the [Postfix documentation on virtual aliases](http://www.postfix.org/VIRTUAL_README.html#virtual_alias) first.
+
+You can use [`setup.sh`][docs-setupsh] instead of creating and editing files manually. Aliases are managed in `/tmp/docker-mailserver/postfix-virtual.cf`. An alias is a _full_ email address that will either be:
+
+* delivered to an existing account registered in `/tmp/docker-mailserver/postfix-accounts.cf`
+* redirected to one or more other email addresses
+
+Alias and target are space separated. An example on a server with example.com as its domain:
+
+```cf
+# Alias delivered to an existing account
+alias1@example.com user1@example.com
+
+# Alias forwarded to an external email address
+alias2@example.com external-account@gmail.com
+```
+
+## Configuring RegExp Aliases
+
+Additional regexp aliases can be configured by placing them into `docker-data/dms/config/postfix-regexp.cf`. The regexp aliases get evaluated after the virtual aliases (container path: `/tmp/docker-mailserver/postfix-virtual.cf`). For example, the following `docker-data/dms/config/postfix-regexp.cf` causes all email sent to "test" users to be delivered to `qa@example.com` instead:
+
+```cf
+/^test[0-9][0-9]*@example.com/ qa@example.com
+```
+
+## Address Tags (Extension Delimiters) an Alternative to Aliases
+
+Postfix supports so-called address tags, in the form of plus (+) tags - i.e. `address+tag@example.com` will end up at `address@example.com`. This is configured by default and the (configurable !) separator is set to `+`. For more info, see [How to use Address Tagging (`user+tag@example.com`) with Postfix](https://www.stevejenkins.com/blog/2011/03/how-to-use-address-tagging-usertagexample-com-with-postfix/) and the [official documentation](http://www.postfix.org/postconf.5.html#recipient_delimiter).
+
+!!! note
+
+    If you do decide to change the configurable separator, you must add the same line to *both* `docker-data/dms/config/postfix-main.cf` and `docker-data/dms/config/dovecot.cf`, because Dovecot is acting as the delivery agent. For example, to switch to `-`, add:
+
+```cf
+recipient_delimiter = -
+```
+
+[docs-setupsh]: ../setup.sh.md

docs/content/contributing/coding-style.md

@@ -0,0 +1,158 @@
+---
+title: 'Contributing | Coding Style'
+---
+
+## Bash and Shell
+
+When refactoring, writing or altering scripts, that is Shell and bash scripts, in any way, adhere to these rules:
+
+1. **Adjust your style of coding to the style that is already present**! Even if you do not like it, this is due to consistency. There was a lot of work involved in making all scripts consistent.
+2. **Use `shellcheck` to check your scripts**! Your contributions are checked by GitHub Actions too, so you will need to do this. You can **lint your work with `make lint`** to check against all targets.
+3. **Use the provided `.editorconfig`** file.
+4. Use `/bin/bash` instead of `/bin/sh`. Adjust the style accordingly.
+5. `setup.sh` provides a good starting point to look for.
+6. When appropriate, use the `set` builtin. We recommend `set -euEo pipefail` or `set -uE`.
+
+## Styling rules
+
+### If-Else-Statements
+
+```bash
+# when using braces, use double braces
+# remember you do not need "" when using [[ ]]
+if [[ <CONDITION1> ]] && [[ -f ${FILE} ]]
+then
+  <CODE TO RUN>
+# when running commands, you don't need braces
+elif <COMMAND TO RUN>
+  <CODE TO TUN>
+else
+  <CODE TO TUN>
+fi
+
+# equality checks with numbers are done
+# with -eq/-ne/-lt/-ge, not != or ==
+if [[ ${VAR} -ne 42 ]] || [[ ${SOME_VAR} -eq 6 ]]
+then
+  <CODE TO RUN>
+fi
+```
+
+### Variables & Braces
+
+!!! attention
+
+    Variables are always uppercase. We always use braces.
+
+If you forgot this and want to change it later, you can use [this link][regex]. The used regex is `\$([^{("\\'\/])([a-zA-Z0-9_]*)([^}\/ \t'"\n.\]:(=\\-]*)`, where you should in practice be able to replace all variable occurrences without braces with occurrences with braces.
+
+```bash
+# good
+local VAR="good"
+local NEW="${VAR}"
+
+# bad -> CI will fail
+var="bad"
+new=$var
+```
+
+### Loops
+
+Like `if-else`, loops look like this
+
+```bash
+for / while <LOOP CONDITION>
+do
+  <CODE TO RUN>
+done
+```
+
+### Functions
+
+It's always nice to see the use of functions as it also provides a clear structure. If scripts are small, this is unnecessary, but if they become larger, please consider using functions. When doing so, provide `function _main`.
+
+```bash
+function _<name_underscored_and_lowercase>
+{
+  <CODE TO RUN>
+
+  # variables that can be local should be local
+  local <LOCAL_VARIABLE_NAME>
+}
+```
+
+### Error Tracing
+
+A construct to trace error in your scripts looks like this. Remember: Remove `set -x` in the end. This is for debugging purposes only.
+
+```bash
+set -xeuEo pipefail
+trap '__err "${BASH_SOURCE}" "${FUNCNAME[0]:-?}" "${BASH_COMMAND:-?}" "${LINENO:-?}" "${?:-?}"' ERR
+
+function __err
+{
+  local RED="\e[31m\e[1m"
+  local RESET="\e[0m"
+  local ERR_MSG="\n--- ${RED}UNCHECKED ERROR${RESET}"
+  ERR_MSG+="\n  - script    = ${1}"
+  ERR_MSG+="\n  - function  = ${2}"
+  ERR_MSG+="\n  - command   = ${3}"
+  ERR_MSG+="\n  - line      = ${4}"
+  ERR_MSG+="\n  - exit code = ${5}"
+
+  echo -e "${ERR_MSG}"
+
+  <CODE TO RUN AFTERWARDS>
+}
+```
+
+### Comments, Descriptiveness & An Example
+
+Comments should only describe non-obvious matters. Comments should start lowercase when they aren't sentences. Make the code **self-descriptive** by using meaningful names! Make comments not longer than approximately 80 columns, then wrap the line.
+
+A positive example, which is taken from `setup-stack.sh`, would be
+
+```bash
+function _setup_postfix_aliases
+{
+  _notify 'task' 'Setting up Postfix Aliases'
+
+  : >/etc/postfix/virtual
+  : >/etc/postfix/regexp
+
+  if [[ -f /tmp/docker-mailserver/postfix-virtual.cf ]]
+  then
+    # fixing old virtual user file
+    if grep -q ",$" /tmp/docker-mailserver/postfix-virtual.cf
+    then
+      sed -i -e "s/, /,/g" -e "s/,$//g" /tmp/docker-mailserver/postfix-virtual.cf
+    fi
+
+    cp -f /tmp/docker-mailserver/postfix-virtual.cf /etc/postfix/virtual
+
+    # the `to` is important, don't delete it
+    # shellcheck disable=SC2034
+    while read -r FROM TO
+    do
+      # Setting variables for better readability
+      UNAME=$(echo "${FROM}" | cut -d @ -f1)
+      DOMAIN=$(echo "${FROM}" | cut -d @ -f2)
+
+      # if they are equal it means the line looks like: "user1     other@example.com"
+      [[ "${UNAME}" != "${DOMAIN}" ]] && echo "${DOMAIN}" >> /tmp/vhost.tmp
+    done < <(grep -v "^\s*$\|^\s*\#" /tmp/docker-mailserver/postfix-virtual.cf || true)
+  else
+    _notify 'inf' "Warning '/tmp/docker-mailserver/postfix-virtual.cf' is not provided. No mail alias/forward created."
+  fi
+
+  ...
+}
+```
+
+## YAML
+
+When formatting YAML files, use [Prettier][prettier], an opinionated formatter. There are many plugins for IDEs around.
+
+[semver]: https://semver.org/
+[regex]: https://regex101.com/r/ikzJpF/7
+[prettier]: https://prettier.io

docs/content/contributing/documentation.md

@@ -0,0 +1,53 @@
+---
+title: 'Contributing | Documentation'
+---
+
+## Prerequisites
+
+You will need have Python and Python pip installed. Or just docker.
+
+## Building and serving the documentation
+
+This tutorial was written using Python `2.7.18` and Python pip `20.3.4`.
+And Docker `19.03.6`.
+
+### Python way
+
+#### Install the modules
+
+The documentation builder
+
+```sh
+pip install mkdocs
+```
+
+Now the theme
+
+```sh
+pip install mkdocs-material
+```
+
+#### Serve
+
+!!! note "Note: be sure to be in the docs folder (`cd ./docs/`)"
+
+```sh
+mkdocs serve
+```
+
+Wait for it to build and open the URL in your browser.
+Each change will be hot-reloaded onto the page you view, just edit, save and look at the result.
+
+### Docker way
+
+Using the official image ([squidfunk/mkdocs-material](https://hub.docker.com/r/squidfunk/mkdocs-material)) for our documentation theme.
+
+#### Serve
+
+!!! note "Note: be sure to be in the docs folder (`cd ./docs/`)"
+
+```sh
+docker run --rm -it -p 8000:8000 -v "${PWD}:/docs" squidfunk/mkdocs-material
+```
+
+Each change will be hot-reloaded onto the page you view, just edit, save and look at the result.

docs/content/contributing/general.md

@@ -1,34 +0,0 @@
----
-title: 'Contributing | General Information'
----
-
-## Coding Style
-
-When refactoring, writing or altering scripts or other files, adhere to these rules:
-
-1. **Adjust your style of coding to the style that is already present**! Even if you do not like it, this is due to consistency. There was a lot of work involved in making all scripts consistent.
-2. **Use `shellcheck` to check your scripts**! Your contributions are checked by GitHub Actions too, so you will need to do this. You can **lint your work with `make lint`** to check against all targets.
-3. **Use the provided `.editorconfig`** file.
-4. Use `/bin/bash` instead of `/bin/sh` in scripts
-
-## Documentation
-
-Make sure to select `edge` in the dropdown menu at the top. Navigate to the page you would like to edit and click the edit button in the top right. This allows you to make changes and create a pull-request.
-
-Alternatively you can make the changes locally. For that you'll need to have Docker installed and run:
-
-```sh
-# From the root directory of the git clone:
-docker run --rm -it -p 8000:8000 -v "./docs:/docs" squidfunk/mkdocs-material
-```
-
-This serves the documentation on your local machine on port `8000`. Each change will be hot-reloaded onto the page you view, just edit, save and look at the result.
-
-!!! note
-
-    The container logs will inform you of invalid links detected, but a [few are false-positives][gh-dms::mkdocs-link-error-false-positives] due to our usage of linking to specific [content tabs][mkdocs::content-tabs].
-
-[get-docker]: https://docs.docker.com/get-docker/
-[docs-bats-parallel]: https://bats-core.readthedocs.io/en/v1.8.2/usage.html#parallel-execution
-[gh-dms::mkdocs-link-error-false-positives]: https://github.com/docker-mailserver/docker-mailserver/pull/4366
-[mkdocs::content-tabs]: https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#anchor-links