This commit is contained in:
github-actions[bot] 2025-02-16 09:23:01 +00:00
parent 84cd41f0c0
commit 40b1176cb0
56 changed files with 3753 additions and 215 deletions

View file

@ -22,7 +22,7 @@
<link rel="icon" href="../../assets/logo/favicon-32x32.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.50">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.4">
@ -30,7 +30,7 @@
<link rel="stylesheet" href="../../assets/stylesheets/main.a40c8224.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.8608ea7d.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
@ -442,6 +442,7 @@
<span class="md-ellipsis">
Home
</span>
@ -462,6 +463,7 @@
<span class="md-ellipsis">
Introduction
</span>
@ -482,6 +484,7 @@
<span class="md-ellipsis">
Usage
</span>
@ -517,6 +520,7 @@
<span class="md-ellipsis">
Configuration
</span>
@ -542,6 +546,7 @@
<span class="md-ellipsis">
Environment Variables
</span>
@ -578,6 +583,7 @@
<span class="md-ellipsis">
Account Management
</span>
@ -603,6 +609,7 @@
<span class="md-ellipsis">
Overview
</span>
@ -639,6 +646,7 @@
<span class="md-ellipsis">
Provisioner
</span>
@ -664,6 +672,7 @@
<span class="md-ellipsis">
File Based
</span>
@ -685,6 +694,7 @@
<span class="md-ellipsis">
LDAP Service
</span>
@ -729,6 +739,7 @@
<span class="md-ellipsis">
Supplementary
</span>
@ -754,6 +765,7 @@
<span class="md-ellipsis">
Master Accounts
</span>
@ -775,6 +787,7 @@
<span class="md-ellipsis">
OAuth2 Authentication
</span>
@ -827,6 +840,7 @@
<span class="md-ellipsis">
Best Practices
</span>
@ -852,6 +866,7 @@
<span class="md-ellipsis">
Auto-discovery
</span>
@ -873,6 +888,7 @@
<span class="md-ellipsis">
DKIM, DMARC & SPF
</span>
@ -894,6 +910,7 @@
<span class="md-ellipsis">
MTA-STS
</span>
@ -938,6 +955,7 @@
<span class="md-ellipsis">
Security
</span>
@ -963,6 +981,7 @@
<span class="md-ellipsis">
Understanding the Ports
</span>
@ -984,6 +1003,7 @@
<span class="md-ellipsis">
SSL/TLS
</span>
@ -1005,6 +1025,7 @@
<span class="md-ellipsis">
Fail2Ban
</span>
@ -1026,6 +1047,7 @@
<span class="md-ellipsis">
Mail Encryption
</span>
@ -1047,6 +1069,7 @@
<span class="md-ellipsis">
Rspamd
</span>
@ -1076,6 +1099,7 @@
<span class="md-ellipsis">
Debugging
</span>
@ -1097,6 +1121,7 @@
<span class="md-ellipsis">
Mail Delivery with POP3
</span>
@ -1118,6 +1143,7 @@
<span class="md-ellipsis">
About setup.sh
</span>
@ -1154,6 +1180,7 @@
<span class="md-ellipsis">
Advanced Configuration
</span>
@ -1179,6 +1206,7 @@
<span class="md-ellipsis">
Optional Configuration
</span>
@ -1215,6 +1243,7 @@
<span class="md-ellipsis">
Maintenance
</span>
@ -1240,6 +1269,7 @@
<span class="md-ellipsis">
Update and Cleanup
</span>
@ -1284,6 +1314,7 @@
<span class="md-ellipsis">
Override the Default Configs
</span>
@ -1309,6 +1340,7 @@
<span class="md-ellipsis">
Dovecot
</span>
@ -1330,6 +1362,7 @@
<span class="md-ellipsis">
Postfix
</span>
@ -1351,6 +1384,7 @@
<span class="md-ellipsis">
Modifications via Script
</span>
@ -1380,6 +1414,7 @@
<span class="md-ellipsis">
Email Filtering with Sieve
</span>
@ -1401,6 +1436,7 @@
<span class="md-ellipsis">
Email Gathering with Fetchmail
</span>
@ -1422,6 +1458,7 @@
<span class="md-ellipsis">
Email Gathering with Getmail
</span>
@ -1458,6 +1495,7 @@
<span class="md-ellipsis">
Email Forwarding
</span>
@ -1483,6 +1521,7 @@
<span class="md-ellipsis">
Relay Hosts
</span>
@ -1504,6 +1543,7 @@
<span class="md-ellipsis">
AWS SES
</span>
@ -1525,6 +1565,7 @@
<span class="md-ellipsis">
Configure Gmail as a relay host
</span>
@ -1554,6 +1595,7 @@
<span class="md-ellipsis">
Full-Text Search
</span>
@ -1575,6 +1617,7 @@
<span class="md-ellipsis">
Kubernetes
</span>
@ -1596,6 +1639,7 @@
<span class="md-ellipsis">
IPv6
</span>
@ -1617,6 +1661,7 @@
<span class="md-ellipsis">
Podman
</span>
@ -1668,6 +1713,7 @@
<span class="md-ellipsis">
Examples
</span>
@ -1708,6 +1754,7 @@
<span class="md-ellipsis">
Tutorials
</span>
@ -1733,6 +1780,7 @@
<span class="md-ellipsis">
Basic Installation
</span>
@ -1754,6 +1802,7 @@
<span class="md-ellipsis">
Mailserver behind Proxy
</span>
@ -1775,6 +1824,7 @@
<span class="md-ellipsis">
Crowdsec
</span>
@ -1796,6 +1846,7 @@
<span class="md-ellipsis">
Building your own Docker image
</span>
@ -1817,6 +1868,7 @@
<span class="md-ellipsis">
Blog Posts
</span>
@ -1838,6 +1890,7 @@
<span class="md-ellipsis">
Dovecot FTS with Apache Solr
</span>
@ -1882,6 +1935,7 @@
<span class="md-ellipsis">
Use Cases
</span>
@ -1907,6 +1961,7 @@
<span class="md-ellipsis">
Forward-Only Mail-Server with LDAP
</span>
@ -1928,6 +1983,7 @@
<span class="md-ellipsis">
Customize IMAP Folders
</span>
@ -1949,6 +2005,7 @@
<span class="md-ellipsis">
iOS Mail Push Support
</span>
@ -1970,6 +2027,7 @@
<span class="md-ellipsis">
Lua Authentication
</span>
@ -1991,6 +2049,7 @@
<span class="md-ellipsis">
Bind outbound SMTP to a specific network
</span>
@ -2012,6 +2071,7 @@
<span class="md-ellipsis">
Relay inbound and outbound mail for an internal DMS
</span>
@ -2048,6 +2108,7 @@
<span class="md-ellipsis">
FAQ
</span>
@ -2086,6 +2147,7 @@
<span class="md-ellipsis">
Contributing
</span>
@ -2118,6 +2180,7 @@
<span class="md-ellipsis">
General Information
</span>
@ -2129,6 +2192,7 @@
<span class="md-ellipsis">
General Information
</span>
@ -2186,6 +2250,7 @@
<span class="md-ellipsis">
Tests
</span>
@ -2207,6 +2272,7 @@
<span class="md-ellipsis">
Issues and Pull Requests
</span>
@ -2235,6 +2301,7 @@
<span class="md-ellipsis">
<span class="icon-external-link"></span>DockerHub
</span>
@ -2255,6 +2322,7 @@
<span class="md-ellipsis">
<span class="icon-external-link"></span>GHCR
</span>
@ -2319,6 +2387,7 @@
<a href="https://github.com/docker-mailserver/docker-mailserver/edit/master/docs/content/contributing/general.md" title="Edit this page" class="md-content__button md-icon">
@ -2348,10 +2417,15 @@
</ol>
<h2 id="documentation"><a class="toclink" href="#documentation">Documentation</a></h2>
<p>Make sure to select <code>edge</code> 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.</p>
<p>Alternatively you can make the changes locally. For that you'll need to have Docker installed. Navigate into the <code>docs/</code> directory. Then run:</p>
<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span>-it<span class="w"> </span>-p<span class="w"> </span><span class="m">8000</span>:8000<span class="w"> </span>-v<span class="w"> </span><span class="s2">&quot;</span><span class="si">${</span><span class="nv">PWD</span><span class="si">}</span><span class="s2">:/docs&quot;</span><span class="w"> </span>squidfunk/mkdocs-material
<p>Alternatively you can make the changes locally. For that you'll need to have Docker installed and run:</p>
<div class="highlight"><pre><span></span><code><span class="c1"># From the root directory of the git clone:</span>
docker<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span>-it<span class="w"> </span>-p<span class="w"> </span><span class="m">8000</span>:8000<span class="w"> </span>-v<span class="w"> </span><span class="s2">&quot;./docs:/docs&quot;</span><span class="w"> </span>squidfunk/mkdocs-material
</code></pre></div>
<p>This serves the documentation on your local machine on port <code>8000</code>. Each change will be hot-reloaded onto the page you view, just edit, save and look at the result.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The container logs will inform you of invalid links detected, but a <a href="https://github.com/docker-mailserver/docker-mailserver/pull/4366">few are false-positives</a> due to our usage of linking to specific <a href="https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#anchor-links">content tabs</a>.</p>
</div>
@ -2414,7 +2488,7 @@
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.top", "navigation.expand", "navigation.instant", "content.action.edit", "content.action.view", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
<script src="../../assets/javascripts/bundle.60a45f97.min.js"></script>
<script src="../../assets/javascripts/bundle.f1b6f286.min.js"></script>
</body>