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

deploy: e58dd1b95b

Browse source
This commit is contained in:
github-actions[bot] 2023-03-18 15:33:20 +00:00
parent e40fda0454
commit 22a4f1de18
4 changed files with 184 additions and 117 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

206
edge/config/environment/index.html
View file

@ -545,20 +545,6 @@
TZ
</a>
</li>
<li class="md-nav__item">
<a href="#enable_rspamd" class="md-nav__link">
ENABLE_RSPAMD
</a>
</li>
<li class="md-nav__item">
<a href="#enable_rspamd_redis" class="md-nav__link">
ENABLE_RSPAMD_REDIS
</a>
</li>
<li class="md-nav__item">
@ -762,6 +748,47 @@
DOVECOT_INET_PROTOCOLS
</a>
</li>
<li class="md-nav__item">
<a href="#move_spam_to_junk" class="md-nav__link">
MOVE_SPAM_TO_JUNK
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#rspamd" class="md-nav__link">
Rspamd
</a>
<nav class="md-nav" aria-label="Rspamd">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#enable_rspamd" class="md-nav__link">
ENABLE_RSPAMD
</a>
</li>
<li class="md-nav__item">
<a href="#enable_rspamd_redis" class="md-nav__link">
ENABLE_RSPAMD_REDIS
</a>
</li>
<li class="md-nav__item">
<a href="#rspamd_learn" class="md-nav__link">
RSPAMD_LEARN
</a>
</li>
</ul>
@ -872,13 +899,6 @@
ENABLE_SPAMASSASSIN_KAM
</a>
</li>
<li class="md-nav__item">
<a href="#move_spam_to_junk" class="md-nav__link">
MOVE_SPAM_TO_JUNK
</a>
</li>
<li class="md-nav__item">
@ -2493,20 +2513,6 @@
TZ
</a>
</li>
<li class="md-nav__item">
<a href="#enable_rspamd" class="md-nav__link">
ENABLE_RSPAMD
</a>
</li>
<li class="md-nav__item">
<a href="#enable_rspamd_redis" class="md-nav__link">
ENABLE_RSPAMD_REDIS
</a>
</li>
<li class="md-nav__item">
@ -2710,6 +2716,47 @@
DOVECOT_INET_PROTOCOLS
</a>
</li>
<li class="md-nav__item">
<a href="#move_spam_to_junk" class="md-nav__link">
MOVE_SPAM_TO_JUNK
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#rspamd" class="md-nav__link">
Rspamd
</a>
<nav class="md-nav" aria-label="Rspamd">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#enable_rspamd" class="md-nav__link">
ENABLE_RSPAMD
</a>
</li>
<li class="md-nav__item">
<a href="#enable_rspamd_redis" class="md-nav__link">
ENABLE_RSPAMD_REDIS
</a>
</li>
<li class="md-nav__item">
<a href="#rspamd_learn" class="md-nav__link">
RSPAMD_LEARN
</a>
</li>
</ul>
@ -2820,13 +2867,6 @@
ENABLE_SPAMASSASSIN_KAM
</a>
</li>
<li class="md-nav__item">
<a href="#move_spam_to_junk" class="md-nav__link">
MOVE_SPAM_TO_JUNK
</a>
</li>
<li class="md-nav__item">
@ -3437,30 +3477,6 @@
<p>Note: you probably want to <a href="#postfix_inet_protocols">set <code>POSTFIX_INET_PROTOCOLS=ipv4</code></a> to make it work fine with Docker.</p>
<h5 id="tz"><a class="toclink" href="#tz">TZ</a></h5>
<p>Set the timezone. If this variable is unset, the container runtime will try to detect the time using <code>/etc/localtime</code>, which you can alternatively mount into the container. The value of this variable must follow the pattern <code>AREA/ZONE</code>, i.e. of you want to use Germany's time zone, use <code>Europe/Berlin</code>. You can lookup all available timezones <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List">here</a>.</p>
<h5 id="enable_rspamd"><a class="toclink" href="#enable_rspamd">ENABLE_RSPAMD</a></h5>
<p>Enable or disable Rspamd.</p>
<div class="admonition warning">
<p class="admonition-title">Current State</p>
<p>Rspamd-support is under active development. Be aware that breaking changes can happen at any time. To get more information, see <a href="../security/rspamd/">the detailed documentation page for Rspamd</a>.</p>
</div>
<ul>
<li><strong>0</strong> =&gt; disabled</li>
<li>1 =&gt; enabled</li>
</ul>
<h5 id="enable_rspamd_redis"><a class="toclink" href="#enable_rspamd_redis">ENABLE_RSPAMD_REDIS</a></h5>
<p>Explicit control over running a Redis instance within the container. By default, this value will match what is set for <a href="#enable_rspamd"><code>ENABLE_RSPAMD</code></a>.</p>
<p>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.</p>
<details class="note">
<summary>Configuring rspamd for an external Redis instance</summary>
<p>You will need to <a href="https://rspamd.com/doc/configuration/redis.html">provide configuration</a> at <code>/etc/rspamd/local.d/redis.conf</code> similar to:</p>
<div class="highlight"><pre><span></span><code>servers = &quot;redis.example.test:6379&quot;;
expand_keys = true;
</code></pre></div>
</details>
<ul>
<li>0 =&gt; Disabled</li>
<li>1 =&gt; Enabled</li>
</ul>
<h5 id="enable_amavis"><a class="toclink" href="#enable_amavis">ENABLE_AMAVIS</a></h5>
<p>Amavis content filter (used for ClamAV &amp; SpamAssassin)</p>
<ul>
@ -3651,6 +3667,57 @@ ClamAV must be enabled (ENABLE_CLAMAV=1) for this.</p>
<li>ipv6 =&gt; Listen only on IPv6 interfaces.</li>
</ul>
<p>Note: More information at <a href="https://dovecot.org/doc/dovecot-example.conf">https://dovecot.org/doc/dovecot-example.conf</a></p>
<h5 id="move_spam_to_junk"><a class="toclink" href="#move_spam_to_junk">MOVE_SPAM_TO_JUNK</a></h5>
<p>When enabled, e-mails marked with the</p>
<ol>
<li><code>X-Spam: Yes</code> header added by Rspamd</li>
<li><code>X-Spam-Flag: YES</code> header added by SpamAssassin (requires <a href="#spamassassin_spam_to_inbox"><code>SPAMASSASSIN_SPAM_TO_INBOX=1</code></a>)</li>
</ol>
<p>will be automatically moved to the Junk folder (with the help of a Sieve script).</p>
<ul>
<li>0 =&gt; Spam messages will be delivered in the mailbox.</li>
<li><strong>1</strong> =&gt; Spam messages will be delivered in the <code>Junk</code> folder.</li>
</ul>
<h4 id="rspamd"><a class="toclink" href="#rspamd">Rspamd</a></h4>
<h5 id="enable_rspamd"><a class="toclink" href="#enable_rspamd">ENABLE_RSPAMD</a></h5>
<p>Enable or disable Rspamd.</p>
<div class="admonition warning">
<p class="admonition-title">Current State</p>
<p>Rspamd-support is under active development. Be aware that breaking changes can happen at any time. To get more information, see <a href="../security/rspamd/">the detailed documentation page for Rspamd</a>.</p>
</div>
<ul>
<li><strong>0</strong> =&gt; disabled</li>
<li>1 =&gt; enabled</li>
</ul>
<h5 id="enable_rspamd_redis"><a class="toclink" href="#enable_rspamd_redis">ENABLE_RSPAMD_REDIS</a></h5>
<p>Explicit control over running a Redis instance within the container. By default, this value will match what is set for <a href="#enable_rspamd"><code>ENABLE_RSPAMD</code></a>.</p>
<p>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.</p>
<details class="note">
<summary>Configuring Rspamd for an external Redis instance</summary>
<p>You will need to <a href="https://rspamd.com/doc/configuration/redis.html">provide configuration</a> at <code>/etc/rspamd/local.d/redis.conf</code> similar to:</p>
<div class="highlight"><pre><span></span><code>servers = &quot;redis.example.test:6379&quot;;
expand_keys = true;
</code></pre></div>
</details>
<ul>
<li>0 =&gt; Disabled</li>
<li>1 =&gt; Enabled</li>
</ul>
<h5 id="rspamd_learn"><a class="toclink" href="#rspamd_learn">RSPAMD_LEARN</a></h5>
<p>When enabled,</p>
<ol>
<li>the "<a href="https://rspamd.com/doc/configuration/statistic.html#autolearning">autolearning</a>" feature is turned on;</li>
<li>the Bayes classifier will be trained when moving mails from or to the Junk folder (with the help of Sieve scripts).</li>
</ol>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>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.</p>
<p>This feature is suitably only for users who can tell ham from spam and users that can be trusted.</p>
</div>
<ul>
<li><strong>0</strong> =&gt; Disabled</li>
<li>1 =&gt; Enabled</li>
</ul>
<h4 id="reports"><a class="toclink" href="#reports">Reports</a></h4>
<h5 id="pflogsumm_trigger"><a class="toclink" href="#pflogsumm_trigger">PFLOGSUMM_TRIGGER</a></h5>
<p>Enables regular Postfix log summary ("pflogsumm") mail reports.</p>
@ -3738,13 +3805,6 @@ If this is not set and reports are enabled with the old options, logrotate will
<li><strong>0</strong> =&gt; KAM disabled</li>
<li>1 =&gt; KAM enabled</li>
</ul>
<h5 id="move_spam_to_junk"><a class="toclink" href="#move_spam_to_junk">MOVE_SPAM_TO_JUNK</a></h5>
<p>Spam messages can be moved in the Junk folder.
Note: this setting needs <code>SPAMASSASSIN_SPAM_TO_INBOX=1</code></p>
<ul>
<li>0 =&gt; Spam messages will be delivered in the mailbox.</li>
<li><strong>1</strong> =&gt; Spam messages will be delivered in the <code>Junk</code> folder.</li>
</ul>
<h5 id="sa_tag"><a class="toclink" href="#sa_tag">SA_TAG</a></h5>
<ul>
<li><strong>2.0</strong> =&gt; add spam info headers if at, or above that level</li>

7
edge/config/security/rspamd/index.html
View file

@ -1804,6 +1804,13 @@
<p>We are currently doing a best-effort installation of Rspamd for ARM64 (from the Debian backports repository for Debian 11). The current version difference is two minor versions (AMD64 is at version 3.4, ARM64 at 3.2 [13th Feb 2023]).</p>
<p>Maintainers noticed only few differences, some of them with a big impact though. For those running Rspamd on ARM64, we recommend <a href="#with-the-help-of-a-custom-file">disabling</a> the <a href="https://rspamd.com/doc/modules/dkim_signing.html">DKIM signing module</a> if you don't use it.</p>
</div>
<p>The following environment variables are related to Rspamd:</p>
<ol>
<li><a href="../../environment/#enable_rspamd"><code>ENABLE_RSPAMD</code></a></li>
<li><a href="../../environment/#enable_rspamd_redis"><code>ENABLE_RSPAMD_REDIS</code></a></li>
<li><a href="../../environment/#rspamd_learn"><code>RSPAMD_LEARN</code></a></li>
<li><a href="../../environment/#move_spam_to_junk"><code>MOVE_SPAM_TO_JUNK</code></a></li>
</ol>
<h2 id="the-default-configuration"><a class="toclink" href="#the-default-configuration">The Default Configuration</a></h2>
<h3 id="mode-of-operation"><a class="toclink" href="#mode-of-operation">Mode of Operation</a></h3>
<p>The proxy worker operates in <a href="https://rspamd.com/doc/workers/rspamd_proxy.html#self-scan-mode">self-scan mode</a>. This simplifies the setup as we do not require a normal worker. You can easily change this though by <a href="#providing-custom-settings-overriding-settings">overriding the configuration by DMS</a>.</p>

2
edge/search/search_index.json
View file

File diff suppressed because one or more lines are too long

86
edge/sitemap.xml
View file

@ -2,217 +2,217 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/faq/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/introduction/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/usage/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/environment/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/pop3/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/setup.sh/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/auth-ldap/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/dovecot-master-accounts/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/full-text-search/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/ipv6/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/kubernetes/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/mail-fetchmail/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/mail-sieve/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/optional-config/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/podman/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/mail-forwarding/aws-ses/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/mail-forwarding/relay-hosts/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/maintenance/update-and-cleanup/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/override-defaults/dovecot/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/override-defaults/postfix/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/override-defaults/user-patches/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/best-practices/autodiscover/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/best-practices/dkim/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/best-practices/dmarc/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/best-practices/spf/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/security/fail2ban/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/security/mail_crypt/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/security/rspamd/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/security/ssl/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/security/understanding-the-ports/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/troubleshooting/debugging/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/user-management/accounts/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/user-management/aliases/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/contributing/general/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/contributing/issues-and-pull-requests/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/contributing/tests/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/examples/tutorials/basic-installation/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/examples/tutorials/blog-posts/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/examples/tutorials/docker-build/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/examples/tutorials/mailserver-behind-proxy/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/examples/use-cases/forward-only-mailserver-with-ldap-authentication/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/examples/use-cases/imap-folders/</loc>
<lastmod>2023-03-12</lastmod>
<lastmod>2023-03-18</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>