mirror/docker-mailserver.docker-mailserver
1
0
Fork 0
mirror of https://github.com/docker-mailserver/docker-mailserver.git synced 2025-08-04 01:55:29 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

deploy: 853301338c

Browse source
This commit is contained in:
github-actions[bot] 2023-02-19 12:25:43 +00:00
parent e66b9b08c2
commit fccd00b0de
45 changed files with 5945 additions and 2622 deletions
Download patch file Download diff file Expand all files Collapse all files

255
edge/index.html
View file

@ -72,7 +72,7 @@
<div data-md-component="skip">
<a href="#welcome-to-the-extended-documentation-for-docker-mailserver" class="md-skip">
<a href="#welcome-to-the-documentation-for-docker-mailserver" class="md-skip">
Skip to content
</a>
@ -232,11 +232,23 @@
<li class="md-tabs__item">
<a href="usage/" class="md-tabs__link">
Usage
</a>
</li>
<li class="md-tabs__item">
<a href="config/setup.sh/" class="md-tabs__link">
<a href="config/environment/" class="md-tabs__link">
Configuration
</a>
</li>
@ -403,17 +415,51 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#getting-started" class="md-nav__link">
Getting Started
<a href="#about" class="md-nav__link">
About
</a>
</li>
<li class="md-nav__item">
<a href="#contents" class="md-nav__link">
Contents
</a>
<nav class="md-nav" aria-label="Contents">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#getting-started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="#configuration" class="md-nav__link">
Configuration
</a>
</li>
<li class="md-nav__item">
<a href="#tests" class="md-nav__link">
Tests
</a>
</li>
<li class="md-nav__item">
<a href="#contributing" class="md-nav__link">
Contributing
</a>
</li>
</ul>
</nav>
</li>
</ul>
@ -446,22 +492,37 @@
<li class="md-nav__item">
<a href="usage/" class="md-nav__link">
Usage
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" checked>
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
<label class="md-nav__link" for="__nav_3">
<label class="md-nav__link" for="__nav_4">
Configuration
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Configuration" data-md-level="1">
<label class="md-nav__title" for="__nav_3">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Configuration
</label>
@ -472,20 +533,6 @@
<li class="md-nav__item">
<a href="config/setup.sh/" class="md-nav__link">
Your Best Friend setup.sh
</a>
</li>
<li class="md-nav__item">
<a href="config/environment/" class="md-nav__link">
Environment Variables
@ -500,22 +547,36 @@
<li class="md-nav__item">
<a href="config/setup.sh/" class="md-nav__link">
Your Best Friend setup.sh
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_3_3" type="checkbox" id="__nav_3_3" checked>
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" checked>
<label class="md-nav__link" for="__nav_3_3">
<label class="md-nav__link" for="__nav_4_3">
User Management
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="User Management" data-md-level="2">
<label class="md-nav__title" for="__nav_3_3">
<label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span>
User Management
</label>
@ -565,18 +626,18 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_3_4" type="checkbox" id="__nav_3_4" checked>
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_4_4" type="checkbox" id="__nav_4_4" checked>
<label class="md-nav__link" for="__nav_3_4">
<label class="md-nav__link" for="__nav_4_4">
Best Practices
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Best Practices" data-md-level="2">
<label class="md-nav__title" for="__nav_3_4">
<label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span>
Best Practices
</label>
@ -654,18 +715,18 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_3_5" type="checkbox" id="__nav_3_5" checked>
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_4_5" type="checkbox" id="__nav_4_5" checked>
<label class="md-nav__link" for="__nav_3_5">
<label class="md-nav__link" for="__nav_4_5">
Security
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Security" data-md-level="2">
<label class="md-nav__title" for="__nav_3_5">
<label class="md-nav__title" for="__nav_4_5">
<span class="md-nav__icon md-icon"></span>
Security
</label>
@ -757,18 +818,18 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_3_6" type="checkbox" id="__nav_3_6" checked>
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_4_6" type="checkbox" id="__nav_4_6" checked>
<label class="md-nav__link" for="__nav_3_6">
<label class="md-nav__link" for="__nav_4_6">
Troubleshooting
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Troubleshooting" data-md-level="2">
<label class="md-nav__title" for="__nav_3_6">
<label class="md-nav__title" for="__nav_4_6">
<span class="md-nav__icon md-icon"></span>
Troubleshooting
</label>
@ -818,18 +879,18 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_3_8" type="checkbox" id="__nav_3_8" checked>
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_4_8" type="checkbox" id="__nav_4_8" checked>
<label class="md-nav__link" for="__nav_3_8">
<label class="md-nav__link" for="__nav_4_8">
Advanced Configuration
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Advanced Configuration" data-md-level="2">
<label class="md-nav__title" for="__nav_3_8">
<label class="md-nav__title" for="__nav_4_8">
<span class="md-nav__icon md-icon"></span>
Advanced Configuration
</label>
@ -858,18 +919,18 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_3_8_2" type="checkbox" id="__nav_3_8_2" checked>
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_4_8_2" type="checkbox" id="__nav_4_8_2" checked>
<label class="md-nav__link" for="__nav_3_8_2">
<label class="md-nav__link" for="__nav_4_8_2">
Maintenance
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Maintenance" data-md-level="3">
<label class="md-nav__title" for="__nav_3_8_2">
<label class="md-nav__title" for="__nav_4_8_2">
<span class="md-nav__icon md-icon"></span>
Maintenance
</label>
@ -905,18 +966,18 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_3_8_3" type="checkbox" id="__nav_3_8_3" checked>
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_4_8_3" type="checkbox" id="__nav_4_8_3" checked>
<label class="md-nav__link" for="__nav_3_8_3">
<label class="md-nav__link" for="__nav_4_8_3">
Override the Default Configs
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Override the Default Configs" data-md-level="3">
<label class="md-nav__title" for="__nav_3_8_3">
<label class="md-nav__title" for="__nav_4_8_3">
<span class="md-nav__icon md-icon"></span>
Override the Default Configs
</label>
@ -1022,18 +1083,18 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_3_8_7" type="checkbox" id="__nav_3_8_7" checked>
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_4_8_7" type="checkbox" id="__nav_4_8_7" checked>
<label class="md-nav__link" for="__nav_3_8_7">
<label class="md-nav__link" for="__nav_4_8_7">
Email Forwarding
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Email Forwarding" data-md-level="3">
<label class="md-nav__title" for="__nav_3_8_7">
<label class="md-nav__title" for="__nav_4_8_7">
<span class="md-nav__icon md-icon"></span>
Email Forwarding
</label>
@ -1168,18 +1229,18 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
<label class="md-nav__link" for="__nav_4">
<label class="md-nav__link" for="__nav_5">
Examples
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Examples" data-md-level="1">
<label class="md-nav__title" for="__nav_4">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Examples
</label>
@ -1194,18 +1255,18 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_4_1" type="checkbox" id="__nav_4_1" checked>
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" checked>
<label class="md-nav__link" for="__nav_4_1">
<label class="md-nav__link" for="__nav_5_1">
Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Tutorials" data-md-level="2">
<label class="md-nav__title" for="__nav_4_1">
<label class="md-nav__title" for="__nav_5_1">
<span class="md-nav__icon md-icon"></span>
Tutorials
</label>
@ -1283,18 +1344,18 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" checked>
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
<label class="md-nav__link" for="__nav_4_2">
<label class="md-nav__link" for="__nav_5_2">
Use Cases
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Use Cases" data-md-level="2">
<label class="md-nav__title" for="__nav_4_2">
<label class="md-nav__title" for="__nav_5_2">
<span class="md-nav__icon md-icon"></span>
Use Cases
</label>
@ -1367,18 +1428,18 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" checked>
<label class="md-nav__link" for="__nav_6">
<label class="md-nav__link" for="__nav_7">
Contributing
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Contributing" data-md-level="1">
<label class="md-nav__title" for="__nav_6">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Contributing
</label>
@ -1489,17 +1550,51 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#getting-started" class="md-nav__link">
Getting Started
<a href="#about" class="md-nav__link">
About
</a>
</li>
<li class="md-nav__item">
<a href="#contents" class="md-nav__link">
Contents
</a>
<nav class="md-nav" aria-label="Contents">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#getting-started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="#configuration" class="md-nav__link">
Configuration
</a>
</li>
<li class="md-nav__item">
<a href="#tests" class="md-nav__link">
Tests
</a>
</li>
<li class="md-nav__item">
<a href="#contributing" class="md-nav__link">
Contributing
</a>
</li>
</ul>
</nav>
</li>
</ul>
@ -1520,27 +1615,37 @@
<h1 id="welcome-to-the-extended-documentation-for-docker-mailserver"><a class="toclink" href="#welcome-to-the-extended-documentation-for-docker-mailserver">Welcome to the Extended Documentation for <code>docker-mailserver</code>!</a></h1>
<p>Please first have a look at the <a href="https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md"><code>README.md</code></a> to setup and configure this server.</p>
<p>This documentation provides you with advanced configuration, detailed examples, and hints.</p>
<h2 id="getting-started"><a class="toclink" href="#getting-started">Getting Started</a></h2>
<h1 id="welcome-to-the-documentation-for-docker-mailserver"><a class="toclink" href="#welcome-to-the-documentation-for-docker-mailserver">Welcome to the Documentation for <code>docker-mailserver</code>!</a></h1>
<div class="admonition info">
<p class="admonition-title">This Documentation is Versioned</p>
<p><strong>Make sure</strong> 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>:edge</code> image tag - <a href="./usage/#available-images-tags-tagging-convention">the most recent build, not the most recent stable release</a>.</p>
</div>
<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>
<h2 id="about"><a class="toclink" href="#about">About</a></h2>
<p><code>docker-mailserver</code>, or DMS for short, is a production-ready fullstack but simple mail server (SMTP, IMAP, LDAP, Antispam, Antivirus, etc.). It employs only configuration files, no SQL database. The image is focused around the slogan "Keep it simple and versioned".</p>
<h2 id="contents"><a class="toclink" href="#contents">Contents</a></h2>
<h3 id="getting-started"><a class="toclink" href="#getting-started">Getting Started</a></h3>
<p>If you're completely new to mail servers or you want to read up on them, check out our <a href="./introduction/"><em>Introduction</em> page</a>. If you're new to DMS as a mail server appliance, make sure to read the <a href="./usage/"><em>Usage</em> chapter</a> first. If you want to look at examples for Docker Compose, we have an <a href="./examples/tutorials/basic-installation/"><em>Examples</em> page</a>.</p>
<p>There is also a script - <a href="https://github.com/docker-mailserver/docker-mailserver/blob/master/setup.sh"><code>setup.sh</code></a> - 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 <a href="./config/setup.sh/">on a dedicated page</a>.</p>
<h3 id="configuration"><a class="toclink" href="#configuration">Configuration</a></h3>
<p>We have a <a href="./config/environment/">dedicated configuration page</a>. It contains most of the configuration and explanation you need to setup <em>your</em> 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>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>If you'd like to change, patch or alter files or behavior of <code>docker-mailserver</code>, 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 <a href="./faq/#how-to-adjust-settings-with-the-user-patchessh-script">'Modifications via Script' page</a> for additional documentation and an example.</p>
</div>
<p>You might also want to check out:</p>
<ol>
<li>The script <a href="https://github.com/docker-mailserver/docker-mailserver/blob/master/setup.sh"><code>setup.sh</code></a> is supplied with this project. It supports you in <strong>configuring and administrating</strong> your server. Information on how to get it and how to use it is available <a href="config/setup.sh/">on a dedicated page</a>.</li>
<li>Be aware that advanced tasks may still require tweaking environment variables, reading through documentation and sometimes inspecting your running container for debugging purposes. After all, a mail-server is a complex arrangement of various programs.</li>
<li>A list of all configuration options is documented on <a href="config/environment/">the ENV page</a>. The <a href="https://github.com/docker-mailserver/docker-mailserver/blob/master/README.md"><code>README.md</code></a> is a good starting point to understand what this image is capable of.</li>
<li>A list of all optional and automatically created configuration files and directories is available <a href="config/advanced/optional-config/">on the dedicated page</a>.</li>
<li>If you want to know more about our test suite, view our <a href="contributing/tests/">testing docs</a>.</li>
<li>A list of <a href="./config/environment/">all configuration options via ENV</a></li>
<li>A list of <a href="./config/advanced/optional-config/">all optional and automatically created configuration files and directories</a></li>
</ol>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>See the <a href="faq/">FAQ</a> for some more tips!</p>
<p>Definitely check out the <a href="./faq/">FAQ</a> for more information and tips! Please do not open an issue before you have checked our documentation for answers, including the <a href="./faq/">FAQ</a>!</p>
</div>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>If you'd like to change, patch or alter files or behavior of <code>docker-mailserver</code>, 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 and it will be run on container startup. See the <a href="config/advanced/override-defaults/user-patches/">'Modifications via Script' page</a>for additional documentation and an example.</p>
</div>
<h2 id="contributing"><a class="toclink" href="#contributing">Contributing</a></h2>
<p>We are always happy to welcome new contributors. For guidelines and entrypoints please have a look at the <a href="contributing/issues-and-pull-requests/">Contributing section</a>.</p>
<h3 id="tests"><a class="toclink" href="#tests">Tests</a></h3>
<p>DMS employs a variety of tests. If you want to know more about our test suite, view our <a href="./contributing/tests/">testing docs</a>.</p>
<h3 id="contributing"><a class="toclink" href="#contributing">Contributing</a></h3>
<p>We are always happy to welcome new contributors. For guidelines and entrypoints please have a look at the <a href="./contributing/issues-and-pull-requests/">Contributing section</a>.</p>
</article>