mirror/docker-mailserver.docker-mailserver
1
0
Fork 0
mirror of https://github.com/docker-mailserver/docker-mailserver.git synced 2025-08-03 17:44:49 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

deploy: 5449efd8d4

Browse source
This commit is contained in:
github-actions[bot] 2021-05-11 10:16:04 +00:00
parent 6ed514e8f5
commit 6da4cf11f0
41 changed files with 5203 additions and 984 deletions
Download patch file Download diff file Expand all files Collapse all files

192
edge/config/setup.sh/index.html
View file

@ -457,18 +457,30 @@
<li class="md-nav__item">
<a href="../environment/" class="md-nav__link">
Environment Variables
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_2" checked>
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_3" data-md-state="indeterminate" type="checkbox" id="__nav_3_3" checked>
<label class="md-nav__link" for="__nav_3_2">
<label class="md-nav__link" for="__nav_3_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_2">
<label class="md-nav__title" for="__nav_3_3">
<span class="md-nav__icon md-icon"></span>
User Management
</label>
@ -512,14 +524,14 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_3" data-md-state="indeterminate" type="checkbox" id="__nav_3_3" checked>
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_4" data-md-state="indeterminate" type="checkbox" id="__nav_3_4" checked>
<label class="md-nav__link" for="__nav_3_3">
<label class="md-nav__link" for="__nav_3_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_3">
<label class="md-nav__title" for="__nav_3_4">
<span class="md-nav__icon md-icon"></span>
Best Practices
</label>
@ -587,14 +599,14 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_4" data-md-state="indeterminate" type="checkbox" id="__nav_3_4" checked>
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_5" data-md-state="indeterminate" type="checkbox" id="__nav_3_5" checked>
<label class="md-nav__link" for="__nav_3_4">
<label class="md-nav__link" for="__nav_3_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_4">
<label class="md-nav__title" for="__nav_3_5">
<span class="md-nav__icon md-icon"></span>
Security
</label>
@ -662,14 +674,14 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_5" data-md-state="indeterminate" type="checkbox" id="__nav_3_5" checked>
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_6" data-md-state="indeterminate" type="checkbox" id="__nav_3_6" checked>
<label class="md-nav__link" for="__nav_3_5">
<label class="md-nav__link" for="__nav_3_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_5">
<label class="md-nav__title" for="__nav_3_6">
<span class="md-nav__icon md-icon"></span>
Troubleshooting
</label>
@ -713,14 +725,14 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_7" data-md-state="indeterminate" type="checkbox" id="__nav_3_7" checked>
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_8" data-md-state="indeterminate" type="checkbox" id="__nav_3_8" checked>
<label class="md-nav__link" for="__nav_3_7">
<label class="md-nav__link" for="__nav_3_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_7">
<label class="md-nav__title" for="__nav_3_8">
<span class="md-nav__icon md-icon"></span>
Advanced Configuration
</label>
@ -746,14 +758,14 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_7_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_7_2" checked>
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_8_2" data-md-state="indeterminate" type="checkbox" id="__nav_3_8_2" checked>
<label class="md-nav__link" for="__nav_3_7_2">
<label class="md-nav__link" for="__nav_3_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_7_2">
<label class="md-nav__title" for="__nav_3_8_2">
<span class="md-nav__icon md-icon"></span>
Maintenance
</label>
@ -785,14 +797,14 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_7_3" data-md-state="indeterminate" type="checkbox" id="__nav_3_7_3" checked>
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_8_3" data-md-state="indeterminate" type="checkbox" id="__nav_3_8_3" checked>
<label class="md-nav__link" for="__nav_3_7_3">
<label class="md-nav__link" for="__nav_3_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_7_3">
<label class="md-nav__title" for="__nav_3_8_3">
<span class="md-nav__icon md-icon"></span>
Override the Default Configs
</label>
@ -884,14 +896,14 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_7_7" data-md-state="indeterminate" type="checkbox" id="__nav_3_7_7" checked>
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_8_7" data-md-state="indeterminate" type="checkbox" id="__nav_3_8_7" checked>
<label class="md-nav__link" for="__nav_3_7_7">
<label class="md-nav__link" for="__nav_3_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_7_7">
<label class="md-nav__title" for="__nav_3_8_7">
<span class="md-nav__icon md-icon"></span>
Email Forwarding
</label>
@ -1280,69 +1292,111 @@ chmod a+x ./setup.sh
</div>
<h2 id="usage"><a class="toclink" href="#usage">Usage</a></h2>
<p>Run <code>./setup.sh help</code> and you'll get some usage information:</p>
<div class="highlight"><pre><span></span><code>setup.sh Bootstrapping Script
<div class="highlight"><pre><span></span><code>SETUP(1)
Usage: ./setup.sh <span class="o">[</span>-i IMAGE_NAME<span class="o">]</span> <span class="o">[</span>-c CONTAINER_NAME<span class="o">]</span> &lt;subcommand&gt; &lt;subcommand&gt; <span class="o">[</span>args<span class="o">]</span>
NAME
setup.sh - docker-mailserver administration script
OPTIONS:
SYNOPSIS
./setup.sh [ OPTIONS... ] COMMAND [ help | ARGUMENTS... ]
-i IMAGE_NAME The name of the docker-mailserver image
The default value is
<span class="s1">&#39;docker.io/mailserver/docker-mailserver:latest&#39;</span>
COMMAND := { email | alias | quota | config | relay | debug } SUBCOMMAND
-c CONTAINER_NAME The name of the running container.
DESCRIPTION
This is the main administration script that you use for all interactions with your
mail server. Setup, configuration and much more is done with this script.
-p PATH Config folder path <span class="o">(</span>default: /home/georg/github/docker-mailserver/config<span class="o">)</span>
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
-h Show this <span class="nb">help</span> dialogue
You will be able to see detailed information about the script you are invoking and
its arguments by appending help after your command. Currently, this
does not work with all scripts.
-z Allow container access to the <span class="nb">bind</span> mount content
that is shared among multiple containers
on a SELinux-enabled host.
VERSION
The current version of this script is backwards compatible with versions of
docker-mailserver after 8.0.1. In case that there is not a more recent release,
this script is currently only working with the :edge tag.
-Z Allow container access to the <span class="nb">bind</span> mount content
that is private and unshared with other containers
on a SELinux-enabled host.
You can download the script for your release by substituting TAG from the
following URL, where TAG looks like &#39;vX.X.X&#39;:
https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/TAG/setup.sh
SUBCOMMANDS:
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
email:
-c CONTAINER_NAME
Provides the name of the running container.
./setup.sh email add &lt;email&gt; <span class="o">[</span>&lt;password&gt;<span class="o">]</span>
./setup.sh email update &lt;email&gt; <span class="o">[</span>&lt;password&gt;<span class="o">]</span>
./setup.sh email del &lt;email&gt;
./setup.sh email restrict &lt;add<span class="p">|</span>del<span class="p">|</span>list&gt; &lt;send<span class="p">|</span>receive&gt; <span class="o">[</span>&lt;email&gt;<span class="o">]</span>
./setup.sh email list
-p PATH
Provides the config folder path. The default is
/home/maxwell/Dokumente/github/docker-mailserver/config/
alias:
./setup.sh <span class="nb">alias</span> add &lt;email&gt; &lt;recipient&gt;
./setup.sh <span class="nb">alias</span> del &lt;email&gt; &lt;recipient&gt;
./setup.sh <span class="nb">alias</span> list
SELinux
-z
Allows container access to the bind mount content that is shared among
multiple containers on a SELinux-enabled host.
quota:
./setup.sh quota <span class="nb">set</span> &lt;email&gt; <span class="o">[</span>&lt;quota&gt;<span class="o">]</span>
./setup.sh quota del &lt;email&gt;
-Z
Allows container access to the bind mount content that is private and
unshared with other containers on a SELinux-enabled host.
config:
[SUB]COMMANDS
COMMAND email :=
./setup.sh email add &lt;EMAIL ADDRESS&gt; [&lt;PASSWORD&gt;]
./setup.sh email update &lt;EMAIL ADDRESS&gt; [&lt;PASSWORD&gt;]
./setup.sh email del [ OPTIONS... ] &lt;EMAIL ADDRESS&gt; [ &lt;EMAIL ADDRESS&gt;... ]
./setup.sh email restrict &lt;add|del|list&gt; &lt;send|receive&gt; [&lt;EMAIL ADDRESS&gt;]
./setup.sh email list
./setup.sh config dkim &lt;keysize&gt; <span class="o">(</span>default: <span class="m">4096</span><span class="o">)</span> &lt;domain.tld&gt; <span class="o">(</span>optional - <span class="k">for</span> LDAP setups<span class="o">)</span>
./setup.sh config ssl &lt;fqdn&gt;
COMMAND alias :=
./setup.sh alias add &lt;EMAIL ADDRESS&gt; &lt;RECIPIENT&gt;
./setup.sh alias del &lt;EMAIL ADDRESS&gt; &lt;RECIPIENT&gt;
./setup.sh alias list
relay:
COMMAND quota :=
./setup.sh quota set &lt;EMAIL ADDRESS&gt; [&lt;QUOTA&gt;]
./setup.sh quota del &lt;EMAIL ADDRESS&gt;
./setup.sh relay add-domain &lt;domain&gt; &lt;host&gt; <span class="o">[</span>&lt;port&gt;<span class="o">]</span>
./setup.sh relay add-auth &lt;domain&gt; &lt;username&gt; <span class="o">[</span>&lt;password&gt;<span class="o">]</span>
./setup.sh relay exclude-domain &lt;domain&gt;
COMMAND config :=
./setup.sh config dkim [ ARGUMENTS... ]
./setup.sh config ssl &lt;FQDN&gt; (ATTENTION: This is deprecated and will be removed soon.)
debug:
COMMAND relay :=
./setup.sh relay add-domain &lt;DOMAIN&gt; &lt;HOST&gt; [&lt;PORT&gt;]
./setup.sh relay add-auth &lt;DOMAIN&gt; &lt;USERNAME&gt; [&lt;PASSWORD&gt;]
./setup.sh relay exclude-domain &lt;DOMAIN&gt;
./setup.sh debug fetchmail
./setup.sh debug fail2ban <span class="o">[</span>&lt;unban&gt; &lt;ip-address&gt;<span class="o">]</span>
./setup.sh debug show-mail-logs
./setup.sh debug inspect
./setup.sh debug login &lt;commands&gt;
COMMAND debug :=
./setup.sh debug fetchmail
./setup.sh debug fail2ban [unban &lt;IP&gt;]
./setup.sh debug show-mail-logs
./setup.sh debug inspect
./setup.sh debug login &lt;COMMANDS&gt;
help: Show this <span class="nb">help</span> dialogue
EXAMPLES
./setup.sh email add test@domain.tld
Add the email account test@domain.tld. You will be prompted
to input a password afterwards since no password was supplied.
./setup.sh config dkim keysize 2048 domain &#39;whoami.com,whoareyou.org&#39;
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.
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.
</code></pre></div>
@ -1383,13 +1437,13 @@ SUBCOMMANDS:
</a>
<a href="../user-management/accounts/" class="md-footer__link md-footer__link--next" rel="next">
<a href="../environment/" class="md-footer__link md-footer__link--next" rel="next">
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Next
</span>
Accounts
Environment Variables
</div>
</div>
<div class="md-footer__button md-icon">