docs(fix): Update usage section manually

As edge (v13) is not to be released for some time and our docs point to the latest tag (v12.1), in the meantime a v13 docs improvement is being manually backported for better visibility as the referenced github files have been renamed for v13 docs.
This commit is contained in:
Brennan Kinney 2023-07-19 20:54:13 +12:00 committed by GitHub
parent a083c38270
commit 4e4314bd8c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1689,9 +1689,9 @@
<li>The host should be able to send/receive on the <a href="../config/security/understanding-the-ports/#overview-of-email-ports">necessary ports for mail</a></li> <li>The host should be able to send/receive on the <a href="../config/security/understanding-the-ports/#overview-of-email-ports">necessary ports for mail</a></li>
<li>You should be able to set a <code>PTR</code> record for your host; security-hardened mail servers might otherwise reject your mail server as the IP address of your host does not resolve correctly/at all to the DNS name of your server.</li> <li>You should be able to set a <code>PTR</code> record for your host; security-hardened mail servers might otherwise reject your mail server as the IP address of your host does not resolve correctly/at all to the DNS name of your server.</li>
</ol> </ol>
<p>On the host, you should have a suitable container runtime (like <em>Docker</em> or <em>Podman</em>) installed. We assume <a href="https://docs.docker.com/compose/"><em>Docker Compose</em></a> is <a href="https://docs.docker.com/compose/install/">installed</a>.</p> <div class="admonition note">
<div class="admonition info"> <p class="admonition-title">About the Container Runtime</p>
<p class="admonition-title">Podman Support</p> <p>On the host, you need to have a suitable container runtime (like <em>Docker</em> or <em>Podman</em>) installed. We assume <a href="https://docs.docker.com/compose/"><em>Docker Compose</em></a> is <a href="https://docs.docker.com/compose/install/">installed</a>. We have aligned file names and configuration conventions with the latest <a href="https://docs.docker.com/compose/compose-file/">Docker Compose (currently V2) specification</a>.</p>
<p>If you're using podman, make sure to read the related <a href="../config/advanced/podman/">documentation</a>.</p> <p>If you're using podman, make sure to read the related <a href="../config/advanced/podman/">documentation</a>.</p>
</div> </div>
<h3 id="minimal-dns-setup"><a class="toclink" href="#minimal-dns-setup">Minimal DNS Setup</a></h3> <h3 id="minimal-dns-setup"><a class="toclink" href="#minimal-dns-setup">Minimal DNS Setup</a></h3>
@ -1747,13 +1747,13 @@
</table> </table>
<h3 id="get-all-files"><a class="toclink" href="#get-all-files">Get All Files</a></h3> <h3 id="get-all-files"><a class="toclink" href="#get-all-files">Get All Files</a></h3>
<p>Issue the following commands to acquire the necessary files:</p> <p>Issue the following commands to acquire the necessary files:</p>
<div class="highlight"><pre><span></span><code><span class="nv">DMS_GITHUB_URL</span><span class="o">=</span><span class="s2">&quot;https://github.com/docker-mailserver/docker-mailserver/blob/latest&quot;</span> <div class="highlight"><pre><span></span><code><span class="nv">DMS_GITHUB_URL</span><span class="o">=</span><span class="s2">&quot;https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/master&quot;</span>
wget<span class="w"> </span><span class="s2">&quot;</span><span class="si">${</span><span class="nv">DMS_GITHUB_URL</span><span class="si">}</span><span class="s2">/docker-compose.yml&quot;</span> wget<span class="w"> </span><span class="s2">&quot;</span><span class="si">${</span><span class="nv">DMS_GITHUB_URL</span><span class="si">}</span><span class="s2">/compose.yaml&quot;</span>
wget<span class="w"> </span><span class="s2">&quot;</span><span class="si">${</span><span class="nv">DMS_GITHUB_URL</span><span class="si">}</span><span class="s2">/mailserver.env&quot;</span> wget<span class="w"> </span><span class="s2">&quot;</span><span class="si">${</span><span class="nv">DMS_GITHUB_URL</span><span class="si">}</span><span class="s2">/mailserver.env&quot;</span>
</code></pre></div> </code></pre></div>
<h3 id="configuration-steps"><a class="toclink" href="#configuration-steps">Configuration Steps</a></h3> <h3 id="configuration-steps"><a class="toclink" href="#configuration-steps">Configuration Steps</a></h3>
<ol> <ol>
<li>First edit <code>docker-compose.yml</code> to your liking<ul> <li>First edit <code>compose.yaml</code> to your liking<ul>
<li>Substitute <code>mail.example.com</code> according to your FQDN.</li> <li>Substitute <code>mail.example.com</code> according to your FQDN.</li>
<li>If you want to use SELinux for the <code>./docker-data/dms/config/:/tmp/docker-mailserver/</code> mount, append <code>-z</code> or <code>-Z</code>.</li> <li>If you want to use SELinux for the <code>./docker-data/dms/config/:/tmp/docker-mailserver/</code> mount, append <code>-z</code> or <code>-Z</code>.</li>
</ul> </ul>