This commit is contained in:
github-actions[bot] committed 2026-11-05 23:49:45 +00:00
1 parent 6e38b46ea9
commit 68fbc1e2bc
5 files changed
+8 -8

No files matched your search

@@ -3077,7 +3077,7 @@ setup relay exclude-domain <span class="s">&lt;domain&gt;</span>
</ul>
<div class="admonition abstract">
<p class="admonition-title">Postfix Settings</p>
<p>Internally this feature is implemented in DMS by <a href="https://github.com/docker-mailserver/docker-mailserver/blob/v16.0.0/target/scripts/helpers/relay.sh"><code>relay.sh</code></a>.</p>
<p>Internally this feature is implemented in DMS by <a href="https://github.com/docker-mailserver/docker-mailserver/blob/v17.0.0/target/scripts/helpers/relay.sh"><code>relay.sh</code></a>.</p>
<p>The <code>relay.sh</code> script manages configuring these Postfix settings:</p>
<div class="highlight"><pre><span></span><code><span class="c"># Send all outbound mail through this relay service:</span>
relayhost <span class="s">= [smtp.relay-service.com]</span><span class="p">:</span><span class="m">587</span>
+2 -2
View File
@@ -6566,9 +6566,9 @@ ClamAV must be enabled (ENABLE_CLAMAV=1) for this.</p>
<p>Add trailing white-space by quote wrapping the value: <code>SPAM_SUBJECT='[SPAM] '</code></p>
</details>
<h5 id="dms_config_poll"><a class="toclink" href="#dms_config_poll">DMS_CONFIG_POLL</a></h5>
<p>Defines how often DMS polls <a href="https://github.com/docker-mailserver/docker-mailserver/blob/v16.0.0/target/scripts/helpers/change-detection.sh#L30-L42">monitored config files</a> for changes in the DMS Config Volume. This also includes TLS certificates and is often relied on for applying changes managed via <code>setup</code> CLI commands.</p>
<p>Defines how often DMS polls <a href="https://github.com/docker-mailserver/docker-mailserver/blob/v17.0.0/target/scripts/helpers/change-detection.sh#L30-L42">monitored config files</a> for changes in the DMS Config Volume. This also includes TLS certificates and is often relied on for applying changes managed via <code>setup</code> CLI commands.</p>
<ul>
<li><strong><code>2</code></strong> =&gt; How often (in seconds) <a href="https://github.com/docker-mailserver/docker-mailserver/blob/v16.0.0/target/scripts/check-for-changes.sh#L37">change detection</a> is performed.</li>
<li><strong><code>2</code></strong> =&gt; How often (in seconds) <a href="https://github.com/docker-mailserver/docker-mailserver/blob/v17.0.0/target/scripts/check-for-changes.sh#L211">change detection</a> is performed.</li>
</ul>
<div class="admonition note">
<p class="admonition-title">Decreasing the frequency of polling for changes</p>
+3 -3
View File
@@ -3353,7 +3353,7 @@
<h1>Rspamd</h1>
<h2 id="about"><a class="toclink" href="#about">About</a></h2>
<p>Rspamd is a <a href="https://rspamd.com/">"fast, free and open-source spam filtering system"</a>. 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 <a href="https://github.com/docker-mailserver/docker-mailserver/tree/v16.0.0/target/rspamd"><code>target/rspamd/</code> inside the repository</a>.</p>
<p>Rspamd is a <a href="https://rspamd.com/">"fast, free and open-source spam filtering system"</a>. 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 <a href="https://github.com/docker-mailserver/docker-mailserver/tree/v17.0.0/target/rspamd"><code>target/rspamd/</code> inside the repository</a>.</p>
<h3 id="enable-rspamd"><a class="toclink" href="#enable-rspamd">Enable Rspamd</a></h3>
<p>Rspamd is presently opt-in for DMS, but intended to become the default anti-spam service in a future release.</p>
<p>DMS offers two anti-spam solutions:</p>
@@ -3415,7 +3415,7 @@
<p>And then there is a corresponding <code>X-Rspamd-Action</code> header, which shows the overall result and the action that is taken. In our example, it would be:</p>
<div class="highlight"><pre><span></span><code>X-Rspamd-Action no action
</code></pre></div>
<p>Since the score is <code>-2.80</code>, nothing will happen and the e-mail is not classified as spam. Our custom <a href="https://github.com/docker-mailserver/docker-mailserver/tree/v16.0.0/target/rspamd/local.d/actions.conf"><code>actions.conf</code></a> defines what to do at certain scores:</p>
<p>Since the score is <code>-2.80</code>, nothing will happen and the e-mail is not classified as spam. Our custom <a href="https://github.com/docker-mailserver/docker-mailserver/tree/v17.0.0/target/rspamd/local.d/actions.conf"><code>actions.conf</code></a> defines what to do at certain scores:</p>
<ol>
<li>At a score of 4, the e-mail is to be <em>greylisted</em>;</li>
<li>At a score of 6, the e-mail is <em>marked with a header</em> (<code>X-Spam: Yes</code>);</li>
@@ -3543,7 +3543,7 @@
<p class="admonition-title">Rspamd config overriding precedence</p>
<p>Rspamd has a layered approach for configuration with <a href="https://rspamd.com/doc/faq.html#what-are-the-locald-and-overrided-directories"><code>local.d</code> and <code>override.d</code> config directories</a>.</p>
<ul>
<li>DMS <a href="https://github.com/docker-mailserver/docker-mailserver/tree/v16.0.0/target/rspamd">extends the Rspamd default configs via <code>/etc/rspamd/local.d/</code></a>.</li>
<li>DMS <a href="https://github.com/docker-mailserver/docker-mailserver/tree/v17.0.0/target/rspamd">extends the Rspamd default configs via <code>/etc/rspamd/local.d/</code></a>.</li>
<li>User config changes should be handled separately as overrides via the <a href="../../advanced/optional-config/#volumes-config">DMS Config Volume</a> (<code>docker-data/dms/config/</code>) with either:<ul>
<li><code>./rspamd/override.d/</code> - Config files placed here are copied to <code>/etc/rspamd/override.d/</code> during container startup.</li>
<li><a href="#with-the-help-of-a-custom-file"><code>./rspamd/custom-commands.conf</code></a> - Applied after copying any provided configs from <code>rspamd/override.d/</code> (DMS Config volume) to <code>/etc/rspamd/override.d/</code>.</li>
+1 -1
View File
@@ -1 +1 @@
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"],"fields":{"title":{"boost":1000.0},"text":{"boost":1.0},"tags":{"boost":1000000.0}}},"docs":[{"location":"","title":"Welcome to the Documentation for <code>docker-mailserver</code>!","text":"<p>This Documentation is Versioned</p> <p>Make sure to select the correct version of this documentation! It should match the version of the image you are using. The default version corresponds to the <code>:latest</code> image tag - the most recent stable release.</p> <p>This documentation provides you not only with the basic setup and configuration of DMS but also with advanced configuration, elaborate usage scenarios, detailed examples, hints and more.</p>"},{"location":"#about","title":"About","text":"<p><code>docker-mailserver</code>, or DMS for short, is a production-ready fullstack but simple mail server (SMTP, IMAP, LDAP, Anti-spam, Anti-virus, etc.). It employs only configuration files, no SQL database. The image is focused around the slogan \"Keep it simple and versioned\".</p>"},{"location":"#contents","title":"Contents","text":""},{"location":"#getting-started","title":"Getting Started","text":"<p>If you're completely new to mail servers or you want to read up on them, check out our Introduction page. If you're new to DMS as a mail server appliance, make sure to read the Usage chapter first. If you want to look at examples for Docker Compose, we have an Examples page.</p> <p>There is also a script - <code>setup.sh</code> - supplied with this project. It supports you in configuring and administrating your server. Information on how to get it and how to use it is available on a dedicated page.</p>"},{"location":"#configuration","title":"Configuration","text":"<p>We have a dedicated configuration page. It contains most of the configuration and explanation you need to setup your mail server properly. Be aware that advanced tasks may still require reading through all parts of this documentation; it may also involve inspecting your running container for debugging purposes. After all, a mail server is a complex arrangement of various programs.</p> <p>Important</p> <p>If you'd like to change, patch or alter files or behavior of DMS, you can use a script. Just place a script called <code>user-patches.sh</code> in your <code>./docker-data/dms/config/</code> folder volume (which is mounted to <code>/tmp/docker-mailserver/</code> inside the container) and it will be run on container startup. See the 'Modifications via Script' page for additional documentation and an example.</p> <p>You might also want to check out:</p> <ol> <li>A list of all configuration options via ENV</li> <li>A list of all optional and automatically created configuration files and directories</li> <li>How to debug your mail server</li> </ol> <p>Tip</p> <p>Definitely check out the FAQ for more information and tips! Please do not open an issue before you have checked our documentation for answers, including the FAQ!</p>"},{"location":"#tests","title":"Tests","text":"<p>DMS employs a variety of tests. If you want to know more about our test suite, view our testing docs.</p>"},{"location":"#contributing","title":"Contributing","text":"<p>We are always happy to welcome new contributors. For guidelines and entrypoints please have a look at the Contributing section.</p>"},{"location":"faq/","title":"FAQ","text":""},{"location":"faq/#what-kind-of-database-are-you-using","title":"What kind of database are you using?","text":"<p>None! No database is required. The filesystem is the database. This image is based on config files that can be persisted using bind mounts (default) or Docker volumes, and as such versioned, backed up and so forth.</p>"},{"location":"faq/#where-are-emails-stored","title":"Where are emails stored?","text":"<p>Mails are stored in <code>/var/mail/${domain}/${username}</code>. Since <code>v9.0.0</code> it is possible to add custom <code>user_attributes</code> for each accounts to have a different mailbox configuration (See #1792).</p>"},{"location":"faq/#how-are-imap-mailboxes-aka-imap-folders-set-up","title":"How are IMAP mailboxes (aka IMAP Folders) set up?","text":"<p><code>INBOX</code> is setup by default with the special IMAP folders <code>Drafts</code>, <code>Sent</code>, <code>Junk</code> and <code>Trash</code>. You can learn how to modify or add your own folders (including additional special folders like <code>Archive</code>) by visiting our docs page Customizing IMAP Folders for more information.</p>"},{"location":"faq/#how-do-i-update-dms","title":"How do I update DMS?","text":"<p>Make sure to read the CHANGELOG before updating to new versions, to be prepared for possible breaking changes.</p> <p>Then, run the following commands:</p> <pre><code>docker compose pull\ndocker compose down\ndocker compose up -d\n</code></pre> <p>You should see the new version number on startup, for example: <code>[ INF ] Welcome to docker-mailserver 11.3.1</code>. AndLine truncated
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"],"fields":{"title":{"boost":1000.0},"text":{"boost":1.0},"tags":{"boost":1000000.0}}},"docs":[{"location":"","title":"Welcome to the Documentation for <code>docker-mailserver</code>!","text":"<p>This Documentation is Versioned</p> <p>Make sure to select the correct version of this documentation! It should match the version of the image you are using. The default version corresponds to the <code>:latest</code> image tag - the most recent stable release.</p> <p>This documentation provides you not only with the basic setup and configuration of DMS but also with advanced configuration, elaborate usage scenarios, detailed examples, hints and more.</p>"},{"location":"#about","title":"About","text":"<p><code>docker-mailserver</code>, or DMS for short, is a production-ready fullstack but simple mail server (SMTP, IMAP, LDAP, Anti-spam, Anti-virus, etc.). It employs only configuration files, no SQL database. The image is focused around the slogan \"Keep it simple and versioned\".</p>"},{"location":"#contents","title":"Contents","text":""},{"location":"#getting-started","title":"Getting Started","text":"<p>If you're completely new to mail servers or you want to read up on them, check out our Introduction page. If you're new to DMS as a mail server appliance, make sure to read the Usage chapter first. If you want to look at examples for Docker Compose, we have an Examples page.</p> <p>There is also a script - <code>setup.sh</code> - supplied with this project. It supports you in configuring and administrating your server. Information on how to get it and how to use it is available on a dedicated page.</p>"},{"location":"#configuration","title":"Configuration","text":"<p>We have a dedicated configuration page. It contains most of the configuration and explanation you need to setup your mail server properly. Be aware that advanced tasks may still require reading through all parts of this documentation; it may also involve inspecting your running container for debugging purposes. After all, a mail server is a complex arrangement of various programs.</p> <p>Important</p> <p>If you'd like to change, patch or alter files or behavior of DMS, you can use a script. Just place a script called <code>user-patches.sh</code> in your <code>./docker-data/dms/config/</code> folder volume (which is mounted to <code>/tmp/docker-mailserver/</code> inside the container) and it will be run on container startup. See the 'Modifications via Script' page for additional documentation and an example.</p> <p>You might also want to check out:</p> <ol> <li>A list of all configuration options via ENV</li> <li>A list of all optional and automatically created configuration files and directories</li> <li>How to debug your mail server</li> </ol> <p>Tip</p> <p>Definitely check out the FAQ for more information and tips! Please do not open an issue before you have checked our documentation for answers, including the FAQ!</p>"},{"location":"#tests","title":"Tests","text":"<p>DMS employs a variety of tests. If you want to know more about our test suite, view our testing docs.</p>"},{"location":"#contributing","title":"Contributing","text":"<p>We are always happy to welcome new contributors. For guidelines and entrypoints please have a look at the Contributing section.</p>"},{"location":"faq/","title":"FAQ","text":""},{"location":"faq/#what-kind-of-database-are-you-using","title":"What kind of database are you using?","text":"<p>None! No database is required. The filesystem is the database. This image is based on config files that can be persisted using bind mounts (default) or Docker volumes, and as such versioned, backed up and so forth.</p>"},{"location":"faq/#where-are-emails-stored","title":"Where are emails stored?","text":"<p>Mails are stored in <code>/var/mail/${domain}/${username}</code>. Since <code>v9.0.0</code> it is possible to add custom <code>user_attributes</code> for each accounts to have a different mailbox configuration (See #1792).</p>"},{"location":"faq/#how-are-imap-mailboxes-aka-imap-folders-set-up","title":"How are IMAP mailboxes (aka IMAP Folders) set up?","text":"<p><code>INBOX</code> is setup by default with the special IMAP folders <code>Drafts</code>, <code>Sent</code>, <code>Junk</code> and <code>Trash</code>. You can learn how to modify or add your own folders (including additional special folders like <code>Archive</code>) by visiting our docs page Customizing IMAP Folders for more information.</p>"},{"location":"faq/#how-do-i-update-dms","title":"How do I update DMS?","text":"<p>Make sure to read the CHANGELOG before updating to new versions, to be prepared for possible breaking changes.</p> <p>Then, run the following commands:</p> <pre><code>docker compose pull\ndocker compose down\ndocker compose up -d\n</code></pre> <p>You should see the new version number on startup, for example: <code>[ INF ] Welcome to docker-mailserver 11.3.1</code>. AndLine truncated
+1 -1
View File
@@ -3300,7 +3300,7 @@
</table>
<div class="admonition info">
<p class="admonition-title">Rebuilds of supported releases on package updates</p>
<p>Debian publishes security fixes continuously, but a release image is only built once. To pick those fixes up, the newest release of every supported major version (<em>currently <code>v16</code></em>) is checked every day. If its published image has package updates pending (<em>from Debian</em>), it is rebuilt without cached layers, tested, and published again:</p>
<p>Debian publishes security fixes continuously, but a release image is only built once. To pick those fixes up, the newest release of every supported major version (<em>currently <code>v16</code> and <code>v17</code></em>) is checked every day. If its published image has package updates pending (<em>from Debian</em>), it is rebuilt without cached layers, tested, and published again:</p>
<ul>
<li>The tags <code>X.Y.Z</code>, <code>X.Y</code> and <code>X</code> of the rebuilt release are moved to the rebuilt image. <code>latest</code> is only moved when the rebuilt release is the newest overall. Older minor and patch releases within a major are not rebuilt and keep their last image.</li>
<li>Each build also receives an immutable <code>X.Y.Z-rN</code> tag (<code>-r0</code> is the original release build, rebuilds count up from <code>-r1</code>). Use it to pin an exact build or to roll back, or pin the image digest.</li>