This commit is contained in:
github-actions[bot] 2025-06-02 07:22:28 +00:00
parent 95eb4e1465
commit c19e29b381
3 changed files with 64 additions and 54 deletions

View file

@ -5227,11 +5227,21 @@
</div>
<h4 id="general"><a class="toclink" href="#general">General</a></h4>
<h5 id="override_hostname"><a class="toclink" href="#override_hostname">OVERRIDE_HOSTNAME</a></h5>
<p>If you can't set your hostname (<em>eg: you're in a container platform that doesn't let you</em>) specify it via this environment variable. It will have priority over <code>docker run --hostname</code>, or the equivalent <code>hostname:</code> field in <code>compose.yaml</code>.</p>
<p>If you cannot set your DMS FQDN as your hostname (<em>eg: you're in a container runtime lacks the equivalent of Docker's <code>--hostname</code></em>), specify it via this environment variable.</p>
<ul>
<li><strong>empty</strong> =&gt; Uses the <code>hostname -f</code> command to get canonical hostname for DMS to use.</li>
<li><strong>empty</strong> =&gt; Internally uses the <code>hostname --fqdn</code> command to get the canonical hostname assigned to the DMS container.</li>
<li>=&gt; Specify an FQDN (fully-qualified domain name) to serve mail for. The hostname is required for DMS to function correctly.</li>
</ul>
<div class="admonition info">
<p class="admonition-title">Info</p>
<p><code>OVERRIDE_HOSTNAME</code> is checked early during DMS container setup. When set it will be preferred over querying the containers hostname via the <code>hostname --fqdn</code> command (<em>configured via <code>docker run --hostname</code> or the equivalent <code>hostname:</code> field in <code>compose.yaml</code></em>).</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Compatibility may differ</p>
<p><code>OVERRIDE_HOSTNAME</code> is not a complete replacement for adjusting the containers configured hostname. It is a best effort workaround for supporting deployment environments like Kubernetes or when using Docker with <code>--network=host</code>.</p>
<p>Typically this feature is only useful when software supports configuring a specific hostname to use, instead of a default fallback that infers the hostname (such as retrieving the hostname via libc / NSS). [Fetchmail is known to be incompatible][gh--issue::hostname-compatibility] with this ENV, requiring manual workarounds.</p>
<p>Compatibility differences are being <a href="https://github.com/docker-mailserver/docker-mailserver/issues/3520#issuecomment-1700191973">tracked here</a> as they become known.</p>
</div>
<h5 id="log_level"><a class="toclink" href="#log_level">LOG_LEVEL</a></h5>
<p>Set the log level for DMS. This is mostly relevant for container startup scripts and change detection event feedback.</p>
<p>Valid values (in order of increasing verbosity) are: <code>error</code>, <code>warn</code>, <code>info</code>, <code>debug</code> and <code>trace</code>. The default log level is <code>info</code>.</p>