Commit graph

572 commits

Author SHA1 Message Date
wernerfred 711b4c9d83 docs(refactor): Convert more content to use admonitions + improvements 2021-03-25 11:49:24 +13:00
wernerfred 463bc967d2 docs(fix): Update wiki references to the new docs url
Additionally replaces old references to `tvial` images with the new `mailserver` docker image name.
2021-03-25 11:49:24 +13:00
wernerfred 724fe72d20 docs: Update metadata and links to new locations
Also removed the FAQ inline heading link for Rancher. It's not a relevant link (as the question already expects knowledge of Rancher), and breaks out of the bg colour heading style due to the HTML generation logic from mkdocs.
2021-03-25 11:49:24 +13:00
wernerfred 237a932f8e docs(config): Add the nav section
Various PR commits related to the nav section have been merged together:

docs: Fix indentation for linter check
docs: update edit uri to content subdirectory
docs: add ghcr link
docs: shorten nav entry name
docs: quote ghcr nav entry
docs(config): update nav section for relocated documents

Additional nav section fixes:

- consistent usage of quotes
- eclint padding error
- wrong indentation of pop3
- remove a leading slash from a filepath
2021-03-25 11:49:24 +13:00
wernerfred cc0706a6fa docs: Add a contributing section 2021-03-25 11:49:24 +13:00
wernerfred 1a8552b96c docs(refactor): Restructure document hierarchy
Additionally rename `installation-examples.md` and split
2021-03-25 11:49:24 +13:00
polarathene 021e942c4c docs(refactor): Large refactor + additions + fixes
Consistency pass, formatting cleanup and fixes, introduce admonitions, add front-matter.

---

docs: Add front-matter

---

docs: Fix and format links

- Some links were invalid (eg files moved or renamed)
- Some were valid but had invalid section headers (content removed or migrated)
- Some use `http://` instead of `https://` when the website supports a secure connection.
- Some already used the `[name][reference]` convention but often with a number that wasn't as useful for maintenance.
- All referenced docs needed URLs replaced. Opted for the `[name][reference]` approach to group them all clearly at the bottom of the doc, especially with the relative URLs and in some cases many duplicate entries.
- All `tomav` references from the original repo prior to switch to an organization have been corrected.
- Minor cosmetic changes to the `name` part of the URL, such as for referencing issues to be consistent.
- Some small changes to text body, usually due to duplicate URL reference that was unnecessary (open relay, youtous)
- Switched other links to use the `[name][reference]` format when there was a large group of URLs such as wikipedia or kubernetes. Github repos that reference projects related to `docker-mailserver` also got placed here so they're noticed better by maintainers. This also helped quite a bit with `mermaid` external links that are very long.
- There was a Github Wiki supported syntax in use `[[name | link]]` for `fetchmail` page that isn't compatible by default with MkDocs (needs a plugin), converted to `[name][reference]` instead since it's a relative link.

---

docs: Update commit link for LDAP override script

Logic moved to another file, keeping the permalink commit reference so it's unaffected by any changes in the file referenced in future.

---

docs: Heading corrections

Consistency pass. Helps with the Table of Contents (top-right UI) aka Document Outline.
docs: codefence cleanup

---

docs: misc cleanup

---

docs: Add Admonitions

Switches `<details>` usage for collapsible admonitions (`???`) while other text content is switched to the visually more distinct admoniton (`!!!` or `???+`) style.

This does affect editor syntax highlighting a bit and markdown linting as it's custom non-standard markdown syntax.
2021-03-25 11:49:24 +13:00
polarathene f13df19b87 docs(styles): Add external link icon workaround
Adds some third-party CSS as`mkdocs-material` doesn't seem interested in a PR to upstream this feature to the community.

---

Uses a font icon approach for the external link as alternatives like SVG was reported in PR as breaking on Chrome.

The logo has been made larger than theme default, it needs a little push from the left to align well with the tabs below it.

---

Unrelated: Additionally experiment with the Instant Navigation feature.

---

docs(styles): Various improvements

Multiple related commits from original PR have been squashed into this. Some messages may be redundant due to loss of history.

---

docs(styles): Minor improvements

- Use relative path for external-link
- UI enhancement for version selector
- Improve inline documentation for `customizations.css`

Make separate styling sections more evident (since we're not using multiple files or build tools).

---

docs(styles): Replace permalink to fix UX bug

---

docs(styles): Replace permalink feature for alternative approach

Previous commit already switched `permalink` for `anchorlink` option, but the `#` symbol had UI concerns regarding font-size/scale and fitting into the gutter.

Gutter change reverted, switch to REM units and symbol replaced by thin vertical rectangle scaled by font height, far better consistency for placement.

---

docs(styles): Refactor the heading link style

Effectively ended up making a border-left line style, just not as consistent and more complicated. Fixed that by adjusting styles.

Adds optional background fill and restores inline code style for headings.
2021-03-25 11:49:24 +13:00
polarathene 251a87e622 docs(ci): Add versioning support without using 'mike'
It seems it may have be simpler to just use 'mike'..

Additionally squashes related commits providing minor fixes + improvements:

- Use a job dependency (`needs`) to avoid `push` event race conditions due to parallel jobs.
- Improve workflow file documentation via inline comments.
- Make ShellCheck linting happy.
- `chown` doesn't seem to work unless on the default branch for CI. Opted to use the docker `--user` approach instead.
2021-03-25 11:49:24 +13:00
polarathene 48cf6ffeb0 docs(assets): Add SVG logo and ICO favicon.
Adds the SVG logo I created (composited rather) in mid-feb in one of my PRs that went slightly off-topic about migrating docs from Github Wiki.

Enables the logo and favicon in `mkdocs.yml`. SVG sources for both full colour and simplified monochromatic are included along with PNG images for use anywhere else, such as the organization logo.

The two SVG of the same names from `src` dir, are used by the docs and have been processed through SVGOMG, an SVG file size optimizer. Any future modifications should use the source files.
2021-03-25 11:49:24 +13:00
polarathene b6d8ce371c docs(config): Add initial mkdocs.yml config 2021-03-25 11:49:24 +13:00
Georg Lauterbach 6fee0cbd5b Updated Home (markdown) 2021-02-08 16:44:11 +01:00
Georg Lauterbach 1db28eb6fc Updated Home (markdown) 2021-02-08 16:43:54 +01:00
Georg Lauterbach 7b3e416184 Updated Configure DKIM (markdown) 2021-02-08 12:21:12 +01:00
Georg Lauterbach a5a6096032 Updated Configure Aliases (markdown) 2021-02-08 12:11:47 +01:00
Georg Lauterbach b5c46127ae Updated Configure Accounts (markdown) 2021-02-08 12:09:38 +01:00
Georg Lauterbach 2c496e3d5e Updated A mail server's 101 (markdown) 2021-02-08 11:54:41 +01:00
Georg Lauterbach 4ea6598d27 Updated Setup docker mailserver using the setup.sh script (markdown) 2021-01-27 22:18:24 +01:00
Georg Lauterbach f448f59434 Destroyed Configure ELK (markdown) 2021-01-27 22:17:52 +01:00
Georg Lauterbach 1fbabeefc0 Updated Configure DKIM (markdown) 2021-01-27 22:17:07 +01:00
Georg Lauterbach 9ec789d7c5 Updated Configure DKIM (markdown) 2021-01-27 22:10:26 +01:00
Georg Lauterbach 7e04232f76 Updated Configure Aliases (markdown) 2021-01-27 22:07:59 +01:00
Georg Lauterbach 4609759703 Updated Configure Accounts (markdown) 2021-01-27 22:07:42 +01:00
Georg Lauterbach 1c27d5f8d9 Updated Setup docker mailserver using the script setup.sh (markdown) 2021-01-27 22:06:36 +01:00
Georg Lauterbach e5aae324cb Updated Home (markdown) 2021-01-27 22:04:49 +01:00
Georg Lauterbach d365f58e19 adjusting to the migrated repo and improvements 2021-01-27 22:02:56 +01:00
Frederic Werner 937a54c659 Updated Setup docker mailserver using the script setup.sh (markdown) 2021-01-27 13:41:53 +01:00
Frederic Werner d41922a430 Updated Configure DKIM (markdown) 2021-01-27 13:41:37 +01:00
Frederic Werner 6e04c1ce76 Updated Configure DKIM (markdown) 2021-01-26 17:28:40 +01:00
Frederic Werner 3c74995158 Updated Setup docker mailserver using the script setup.sh (markdown) 2021-01-26 17:23:24 +01:00
Tin 342d38f86f Otherwise it will completly set the variable and disable any plugins loaded beforehand e.x. quota 2021-01-26 04:24:24 +01:00
Frederic Werner 1e1059349d Updated Installation Examples (markdown) 2021-01-24 18:20:34 +01:00
Frederic Werner b5dc7ed8c1 Add section to use mailserver with proxy protocol 2021-01-24 17:09:12 +01:00
Georg Lauterbach 29f4367d8d Updated Setup docker mailserver using the script setup.sh (markdown) 2021-01-19 09:45:29 +01:00
Georg Lauterbach a669ef9c62 Updated Setup docker mailserver using the script setup.sh (markdown) 2021-01-19 09:45:01 +01:00
FL42 41508c01f9 style 2021-01-02 22:59:37 +01:00
FL42 641746a0f5 Mention that RELAY_HOST needs to be set even in advanced mode 2021-01-02 22:58:06 +01:00
Dashamir Hoxha cfd7878261 Describe how to authenticate with LDAP 2020-12-30 22:57:24 +01:00
Dashamir Hoxha c916e21308 Created Forward-Only mailserver with LDAP authentication (markdown) 2020-12-30 21:15:38 +01:00
Dashamir Hoxha 8a7dcc67b0 Add a ToDo note 2020-12-30 20:40:36 +01:00
Patrizio Bekerle 8b9a102e3e Mention maintained autodiscover-email-settings 2020-12-13 21:42:51 +01:00
Patrizio Bekerle ccd99636e8 Update "Manage Sieve" link 2020-12-11 10:18:01 +01:00
William Desportes cee1b06d0e Better highlighting on config blocks 2020-12-05 21:01:26 +01:00
Germain Masse ee557c9e3f Command-line to verify certificate dates 2020-11-29 20:23:43 +01:00
Germain Masse 77308d269d Moving Caddy pitfall to a dedicated section 2020-11-29 19:44:50 +01:00
omarc1492 63fc2511aa Add new options to reflect support for SELinux 2020-10-30 12:36:38 -05:00
Dorian Ayllón 28a5fb6436 Fix example YAML markdown code block 2020-10-21 17:08:34 +02:00
Luke Cyca 854c1b5223 Created IPv6 (markdown) 2020-10-08 15:45:58 -07:00
Luke Cyca ad240b00e9 Updated Full text search (markdown) 2020-10-08 15:38:12 -07:00
Luke Cyca 3db4b75d6e Updated Full text search (markdown) 2020-10-08 15:37:26 -07:00
Luke Cyca b986c4375b Created Full-text search (markdown) 2020-10-08 15:36:39 -07:00
pyy 673d7307b6 add account without restart container 2020-10-06 19:30:33 +02:00
engelant e633eca38e Updated FAQ and Tips (markdown) 2020-10-04 13:45:29 +02:00
engelant 16df7b8b8b Updated FAQ and Tips (markdown) 2020-10-04 13:44:21 +02:00
squash 4fc4fe97f7 Update for key_type global option with Caddy v2 for people sharing their LE certs between Caddy and docker-mailserver 2020-10-01 14:06:51 -04:00
Georg Lauterbach 68e27162f3 added warning message for PERMIT_DOCKER=network when using IPv6 (#1405) 2020-09-27 22:15:21 +02:00
Georg Lauterbach 6aad01abbd added warning message for PERMIT_DOCKER=network when using IPv6 (#1405) 2020-09-27 22:14:27 +02:00
Georg Lauterbach 4424495f63 Traefik2's wildcard certificates now work with :stable 2020-09-26 14:52:36 +02:00
pyy cde15e365f how to set timezone for container 2020-09-10 20:59:33 +02:00
Erik Wramner 6dce6c6cf7 Changed stable to latest for Traefik as the code has not been merged into stable yet 2020-08-07 09:54:31 +02:00
Michael 6f04051ffd traefik v2 section added 2020-07-16 21:12:50 +02:00
Trangar c6f1af4fff Added information about stealth blocks on port 25 2020-07-15 08:32:38 +02:00
idaadi 68e9e5dd36 mailto was missing from the forensics receiver (ruf) 2020-07-07 00:58:25 +02:00
Amin Vakil 78af9f97a2 Change postfix-aliases.cf to postfix-virtual.cf & add setup.sh alias link 2020-06-21 10:01:01 +04:30
Brennan Kinney d67c7f1677 Slight changes to Alice and Bob example 2020-06-14 16:05:12 +12:00
Brennan Kinney 4a53a2566a Add flowchart for SMTP, expand on inbound/outband SMTP traffic and ports 2020-06-13 20:44:34 +12:00
Jean-Denis Vauguet a584386824 clarification about third-party sending email to dms' MTA 2020-06-13 06:52:13 +02:00
Jean-Denis Vauguet 51e497b848 Updated A mail server's 101 (markdown) 2020-06-13 06:28:06 +02:00
Jean-Denis Vauguet c57122514e Updated A mail server's 101 (markdown) 2020-06-13 06:03:30 +02:00
Jean-Denis Vauguet 3821800194 Updated A mail server's 101 (markdown) 2020-06-13 05:59:32 +02:00
Jean-Denis Vauguet a454f6bcc1 Updated A mail server's 101 (markdown) 2020-06-13 05:49:10 +02:00
Jean-Denis Vauguet ee3b4ed9b9 More details on Submission (Outward vs Inward) 2020-06-13 05:36:11 +02:00
Jean-Denis Vauguet 2c0100280c Revert e46c43f71ebd89b6ba95bfa1fcc1dfd7bfd07a3f...f86e6e43189222e1ec55d5aef2f83f176e0f54f1 on A mail server's 101 2020-06-13 04:35:12 +02:00
Brennan Kinney acf3d88d43 Initial more details page to redirect from README on the ports section 2020-06-12 20:19:52 +12:00
Brennan Kinney f86e6e4318 Fix rendering of ASCII flows (assuming this isn't an inconsistency between mono fonts chosen by browsers) 2020-06-12 19:49:28 +12:00
Brennan Kinney e46c43f71e Minor changes: plain text to cleartext, inline codeblock docker-mailserver, some rephrasing and grammar fixes 2020-06-12 19:35:14 +12:00
Jean-Denis Vauguet 6ce7e1be85 Updated A mail server's 101 (markdown) 2020-06-12 08:31:42 +02:00
Jean-Denis Vauguet 5a31fc72fc Updated A mail server's 101 (markdown) 2020-06-12 08:08:16 +02:00
Jean-Denis Vauguet a88658fccb Updated A mail server's 101 (markdown) 2020-06-12 08:02:31 +02:00
Jean-Denis Vauguet e73041687b Updated A mail server's 101 (markdown) 2020-06-12 08:01:49 +02:00
Jean-Denis Vauguet 217ebc7a6f Updated A mail server's 101 (markdown) 2020-06-12 07:37:20 +02:00
Jean-Denis Vauguet f456b75691 Updated A mail server's 101 (markdown) 2020-06-12 07:32:01 +02:00
Jean-Denis Vauguet f453a0fd41 Updated A mail server's 101 (markdown) 2020-06-12 07:19:32 +02:00
Jean-Denis Vauguet 555ace5a11 Updated A mail server's 101 (markdown) 2020-06-12 07:15:22 +02:00
Jean-Denis Vauguet 631cdc0b5a Updated A mail server's 101 (markdown) 2020-06-12 06:54:44 +02:00
Jean-Denis Vauguet 20d1eb4b50 Updated A mail server's 101 (markdown) 2020-06-12 06:36:30 +02:00
Jean-Denis Vauguet 6cb1a0b768 Updated A mail server's 101 (markdown) 2020-06-12 06:28:27 +02:00
Jean-Denis Vauguet addd22db99 Updated A mail server's 101 (markdown) 2020-06-12 06:26:59 +02:00
Jean-Denis Vauguet 0c6e157844 Updated A mail server's 101 (markdown) 2020-06-12 06:24:21 +02:00
Jean-Denis Vauguet 2b30e8df80 Updated A mail server's 101 (markdown) 2020-06-12 06:24:01 +02:00
Jean-Denis Vauguet 6de0102c96 Updated A mail server's 101 (markdown) 2020-06-12 06:23:07 +02:00
Jean-Denis Vauguet ce4381a456 Updated A mail server's 101 (markdown) 2020-06-12 06:22:06 +02:00
Jean-Denis Vauguet a6ed4a2031 Updated A mail server's 101 (markdown) 2020-06-12 06:21:02 +02:00
Jean-Denis Vauguet 7b842cf954 Updated A mail server's 101 (markdown) 2020-06-12 06:15:36 +02:00
Jean-Denis Vauguet 6262f13e65 Updated A mail server's 101 (markdown) 2020-06-12 06:14:24 +02:00
Jean-Denis Vauguet e1a3f868fa Updated A mail server's 101 (markdown) 2020-06-12 06:11:20 +02:00
Jean-Denis Vauguet c67f8fe4a8 Updated A mail server's 101 (markdown) 2020-06-12 06:09:50 +02:00
Jean-Denis Vauguet 1b826f47bc Updated A mail server's 101 (markdown) 2020-06-12 06:09:12 +02:00
Jean-Denis Vauguet 7d4f0b1064 Updated A mail server's 101 (markdown) 2020-06-12 06:07:28 +02:00
Jean-Denis Vauguet ce0e4bf63a Updated A mail server's 101 (markdown) 2020-06-12 06:04:25 +02:00
Jean-Denis Vauguet 4f947c2862 Updated A mail server's 101 (markdown) 2020-06-12 06:00:55 +02:00
Jean-Denis Vauguet a7f3c8b882 Updated A mail server's 101 (markdown) 2020-06-12 05:59:16 +02:00
Jean-Denis Vauguet 10dc34fee8 Updated A mail server's 101 (markdown) 2020-06-12 05:58:30 +02:00
Jean-Denis Vauguet d4fc208776 Updated A mail server's 101 (markdown) 2020-06-12 05:57:55 +02:00
Jean-Denis Vauguet cbfe8425bc Updated A mail server's 101 (markdown) 2020-06-12 05:48:11 +02:00
Jean-Denis Vauguet f5de8197f8 Updated A mail server's 101 (markdown) 2020-06-10 03:18:48 +02:00
Jean-Denis Vauguet 34ddfbaff2 Updated A mail server's 101 (markdown) 2020-06-10 03:16:42 +02:00
Jean-Denis Vauguet ee16eceb48 Updated A mail server's 101 (markdown) 2020-06-10 03:15:06 +02:00
Jean-Denis Vauguet 66203427db Updated A mail server's 101 (markdown) 2020-06-10 03:14:21 +02:00
Jean-Denis Vauguet 3987a8638f Updated A mail server's 101 (markdown) 2020-06-10 02:57:53 +02:00
Jean-Denis Vauguet 1027ec309e Updated A mail server's 101 (markdown) 2020-06-10 02:54:51 +02:00
Jean-Denis Vauguet 328f2e2ecf Updated A mail server's 101 (markdown) 2020-06-10 01:55:07 +02:00
Jean-Denis Vauguet 48cf8a5eee Updated A mail server's 101 (markdown) 2020-06-10 01:40:19 +02:00
Jean-Denis Vauguet 52067e7ff0 Updated A mail server's 101 (markdown) 2020-06-10 01:19:51 +02:00
Jean-Denis Vauguet 8bdaef6890 Updated A mail server's 101 (markdown) 2020-06-10 01:07:10 +02:00
Jean-Denis Vauguet 6bfeca219f Updated A mail server's 101 (markdown) 2020-06-10 00:35:14 +02:00
Jean-Denis Vauguet e1d01de2bc Updated A mail server's 101 (markdown) 2020-06-10 00:33:27 +02:00
Jean-Denis Vauguet ace11eb966 Updated A mail server's 101 (markdown) 2020-06-10 00:23:41 +02:00
Jean-Denis Vauguet 66f2f6fb4e Updated A mail server's 101 (markdown) 2020-06-10 00:15:52 +02:00
Jean-Denis Vauguet 87be1104cb Updated A mail server's 101 (markdown) 2020-06-10 00:13:41 +02:00
Jean-Denis Vauguet 645a9c63f2 Updated A mail server's 101 (markdown) 2020-06-10 00:04:34 +02:00
Jean-Denis Vauguet b2d8f1b338 Updated A mail server's 101 (markdown) 2020-06-10 00:02:38 +02:00
Jean-Denis Vauguet 5a7a4c6f53 Updated A mail server's 101 (markdown) 2020-06-09 23:58:37 +02:00
Jean-Denis Vauguet 9202770e2d Updated A mail server's 101 (markdown) 2020-06-09 23:55:45 +02:00
Jean-Denis Vauguet c571eb7cfc Updated A mail server's 101 (markdown) 2020-06-09 23:54:51 +02:00
Jean-Denis Vauguet bd61c9e52f Updated A mail server's 101 (markdown) 2020-06-09 23:54:21 +02:00
Jean-Denis Vauguet 7c27debb06 Created A mail server's 101 (markdown) 2020-06-09 23:51:01 +02:00
Jean-Denis Vauguet 02ce180bc3 Updated Setup docker mailserver using the script setup.sh (markdown) 2020-06-09 22:42:44 +02:00
Jean-Denis Vauguet bce48753d3 Updated Setup docker mailserver using the script setup.sh (markdown) 2020-06-09 22:40:40 +02:00
Jean-Denis Vauguet fd0a302149 Updated Setup docker mailserver using the script setup.sh (markdown) 2020-06-09 22:39:39 +02:00
Jean-Denis Vauguet cf7c86c557 Updated Setup docker mailserver using the script setup.sh (markdown) 2020-06-09 22:37:53 +02:00
Jean-Denis Vauguet 56c0eac64c Updated Home (markdown) 2020-06-09 22:15:25 +02:00
Sascha Scandella 1dc4328ed5 Updated FAQ and Tips (markdown) 2020-06-04 23:49:10 +02:00
Jean-Denis Vauguet 2b745c9f81 Updated Configure SPF (markdown) 2020-06-01 02:54:02 +02:00
Jean-Denis Vauguet 9ff7e1eaa3 Updated Configure SPF (markdown) 2020-06-01 02:53:42 +02:00
Jean-Denis Vauguet 8f4e56c98b Updated Configure SPF (markdown) 2020-06-01 02:42:55 +02:00
Jean-Denis Vauguet 78b09c20ab Updated Configure SPF (markdown) 2020-06-01 02:31:12 +02:00
Sascha Scandella 61096f58fe Updated Override Default Dovecot Configuration (markdown) 2020-05-31 22:31:50 +02:00
Sascha Scandella f91e577d53 Updated Override Default Dovecot Configuration (markdown) 2020-05-31 22:30:20 +02:00
Sascha Scandella dcb0bf1577 Updated Override Default Dovecot Configuration (markdown) 2020-05-31 22:30:00 +02:00
Sascha Scandella 698cd39894 Updated Override Default Dovecot Configuration (markdown) 2020-05-31 22:29:42 +02:00
Sascha Scandella 3cb6c532ec Updated Configure Sieve filters (markdown) 2020-05-31 20:58:58 +02:00
Jean-Denis Vauguet 54e5ed90d5 Updated FAQ and Tips (markdown) 2020-05-31 05:42:37 +02:00
Jean-Denis Vauguet eeeda460a8 Updated FAQ and Tips (markdown) 2020-05-31 05:39:28 +02:00
Jean-Denis Vauguet dd30d3ce55 Updated Configure ELK (markdown) 2020-05-31 05:17:04 +02:00
Jean-Denis Vauguet d4bfb7f2b4 Updated Configure DMARC (markdown) 2020-05-31 05:13:46 +02:00
Jean-Denis Vauguet acc2e31ba8 Updated Configure DKIM (markdown) 2020-05-31 05:11:06 +02:00
Jean-Denis Vauguet e61114b4d8 Updated Configure DKIM (markdown) 2020-05-31 05:10:32 +02:00
Jean-Denis Vauguet 533a224963 Updated Configure autodiscover (markdown) 2020-05-31 05:02:09 +02:00
Jean-Denis Vauguet 47f1ffe65c Updated Configure Aliases (markdown) 2020-05-31 04:52:34 +02:00