github-com-docker-mailserver/docker-mailserver
1
0
Fork 0
mirror of https://github.com/docker-mailserver/docker-mailserver.git synced 2024-01-19 02:48:50 +00:00
Code Issues Projects Releases Wiki Activity

deploy: 623d53bea8

Browse source
This commit is contained in:
github-actions[bot] 2023-01-06 03:53:51 +00:00
parent 9e24826c2b
commit f0b523166f
3 changed files with 57 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
edge/contributing/general/index.html
View file

@ -1525,9 +1525,22 @@
<p>We do not support running linting, tests, etc on macOS at this time. Please use a linux VM.</p>
</div>
<details class="tip">
<summary>Running a Specific Test</summary>
<p>To run a specific test, use <code>make build generate-accounts test/&lt;TEST NAME&gt;</code>, where <code>&lt;TEST NAME&gt;</code> is the file name of the test (<em>for more precision use a relative path: <code>test/test/&lt;PATH&gt;</code></em>) excluding the <code>.bats</code> suffix.</p>
<p>To run only the tests in <code>template.bats</code>, use <code>make test/template</code> (or <code>make test/parallel/set2/template</code>).</p>
<summary>Setting the Degree of Parallelization for Tests</summary>
<p>If your machine is capable, you can increase the amount of tests that are run simultaneously by prepending the <code>make clean all</code> command with <code>BATS_PARALLEL_JOBS=X</code> (i.e. <code>BATS_PARALLEL_JOBS=X make clean all</code>). This wil speed up the test procedure. You can also run all tests in serial by setting <code>BATS_PARALLEL_JOBS=1</code> this way.</p>
<p>The default value of <code>BATS_PARALLEL_JOBS</code> is 2. Increasing it to <code>3</code> requires 6 threads and 6GB of main memory; increasing it to <code>4</code> requires 8 threads and at least 8GB of main memory.</p>
</details>
<div class="admonition warning">
<p class="admonition-title">Test Output when Running in Parallel</p>
<p><a href="https://bats-core.readthedocs.io/en/v1.8.2/usage.html#parallel-execution">When running tests in parallel</a> (<em>with <code>make clean generate-accounts tests/parallel/setX</code></em>), BATS will delay outputting the results until completing all test cases within a file.</p>
<p>This also delays test failures as a result. When troubleshooting parallel set tests, you may prefer to run them serially as advised below.</p>
<p>When writing tests, ensure that parallel set tests still pass when run in parallel. You need to account for other tests running in parallel that may interfere with your own tests logic.</p>
</div>
<details class="tip">
<summary>Run a Specific Test</summary>
<p>Run <code>make build generate-accounts test/&lt;TEST NAME&gt;</code>, where <code>&lt;TEST NAME&gt;</code> is the file name of the test <strong>excluding</strong> the <code>.bats</code> suffix (<em>use a relative path if needing to be more specific: <code>test/&lt;RELATIVE PATH&gt;/&lt;TEST NAME&gt;</code></em>).</p>
<p>Multiple test files can be run sequentially with a <code>,</code> delimiter between file names:
<code>make test/tls_letsencrypt,tls_manual</code></p>
<p><strong>Example:</strong> To run only the tests in <code>template.bats</code>, use <code>make test/template</code> (<em>or with relative path: <code>make test/parallel/set2/template</code></em>).</p>
</details>
<h2 id="documentation"><a class="toclink" href="#documentation">Documentation</a></h2>
<p>You will need to have Docker installed. Navigate into the <code>docs/</code> directory. Then run:</p>

2
edge/search/search_index.json
View file

File diff suppressed because one or more lines are too long

80
edge/sitemap.xml
View file

@ -2,202 +2,202 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/faq/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/introduction/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/environment/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/pop3/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/setup.sh/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/auth-ldap/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/dovecot-master-accounts/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/full-text-search/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/ipv6/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/kubernetes/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/mail-fetchmail/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/mail-sieve/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/optional-config/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/podman/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/mail-forwarding/aws-ses/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/mail-forwarding/relay-hosts/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/maintenance/update-and-cleanup/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/override-defaults/dovecot/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/override-defaults/postfix/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/override-defaults/user-patches/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/best-practices/autodiscover/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/best-practices/dkim/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/best-practices/dmarc/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/best-practices/spf/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/security/fail2ban/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/security/mail_crypt/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/security/ssl/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/security/understanding-the-ports/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/troubleshooting/debugging/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/user-management/accounts/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/config/user-management/aliases/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/contributing/general/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/contributing/issues-and-pull-requests/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/examples/tutorials/basic-installation/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/examples/tutorials/blog-posts/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/examples/tutorials/docker-build/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/examples/tutorials/mailserver-behind-proxy/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/examples/use-cases/forward-only-mailserver-with-ldap-authentication/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docker-mailserver.github.io/docker-mailserver/edge/examples/use-cases/imap-folders/</loc>
<lastmod>2023-01-05</lastmod>
<lastmod>2023-01-06</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>