Commit graph

101 commits

Author SHA1 Message Date
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
Dashamir Hoxha 8a7dcc67b0 Add a ToDo note 2020-12-30 20:40:36 +01: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
Georg Lauterbach 6aad01abbd added warning message for PERMIT_DOCKER=network when using IPv6 (#1405) 2020-09-27 22:14:27 +02:00
pyy cde15e365f how to set timezone for container 2020-09-10 20:59:33 +02:00
Trangar c6f1af4fff Added information about stealth blocks on port 25 2020-07-15 08:32:38 +02:00
Sascha Scandella 1dc4328ed5 Updated FAQ and Tips (markdown) 2020-06-04 23:49:10 +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 729196d97e Updated FAQ and Tips (markdown) 2020-05-29 05:41:07 +02:00
Jean-Denis Vauguet 1f220f5418 Updated FAQ and Tips (markdown) 2020-05-29 05:40:17 +02:00
msheakoski fa387eff1f Update config file mentioned in cron instructions to env-mailserver 2020-05-08 18:15:06 -04:00
msheakoski 8b9b4d3b69 Update config file mentioned in cron instructions to env-mailserver 2020-05-08 18:12:24 -04:00
youtous 5bb68e9905 Update SA-learn 2020-05-02 19:41:36 +02:00
youtous f5f7fc8879 Add MOVE_SPAM_TO_JUNK 2020-05-02 19:40:16 +02:00
lukas 57837ccd92 Updated FAQ and Tips (markdown) 2020-05-02 11:55:27 +02:00
Hans-Cees Speel 1b86123954 added user-patches.sh explanation and example 2020-02-24 22:14:09 +01:00
Hans-Cees Speel 5ace30e413 Updated FAQ and Tips (markdown) 2020-02-24 22:13:16 +01:00
Hans-Cees Speel 957e3056e6 Updated FAQ and Tips (markdown) 2020-02-24 22:11:50 +01:00
odinis 85aed0d1d1 Proxy setup is nowhere mentioned. 2020-02-14 01:14:31 +02:00
Erik Wramner 30bbc15a8b Improved description for bare domains 2020-01-18 12:27:45 +01:00
Erik Wramner 53f092e8c6 Added FAQ about naked/bare domains 2020-01-18 11:39:04 +01:00
Germain Masse 5d0715c2e1 Add sections for catch-all and delete 2019-12-20 18:14:02 +01:00
Kaan88 90a9cba1c0 Spamassing cron directories are wrong for Archive and Inbox. On my fresh install it's not .Archives but .Archive and I don't have a separate INBOX folder, just cur, new etc under main mail dir. 2019-11-20 15:10:46 +03:00
Erik Wramner bb7bfdbf1e Added note about clamav memory usage and swap. 2019-10-28 09:15:34 +01:00
Thomas VIAL 3fc2da3be2 Updated FAQ and Tips (markdown) 2019-09-11 16:50:15 +02:00
Thomas VIAL 038ec5942e Updated FAQ and Tips (markdown) 2019-09-11 16:49:25 +02:00
Thomas VIAL 4556c808d7 Edit backup script 2019-09-11 16:48:58 +02:00
Erik Wramner 2c3dd2adb8 Added reference to https://github.com/tomav/docker-mailserver/issues/1247. 2019-09-03 15:59:31 +02:00
cternes e03af03ef9 Fix wrong directory for spamassassin learning 2019-08-02 22:10:14 +02:00
Thomas VIAL 0a0e758d92 Add info about mail-state 2019-07-24 14:31:42 +02:00
Sebastian Wiesendahl 3ceeef5a00 SA_SPAM_SUBJECT values 2019-03-24 18:17:35 +01:00
Sebastian Wiesendahl da78a4969d add consitent comments 2019-03-12 14:47:08 +01:00
Sebastian Wiesendahl 8f6249cc3f change ham folder to Archives 2019-03-12 14:44:44 +01:00
Sebastian Wiesendahl d5ba2f8e42 emphasize difference between user and system crontab 2019-03-11 15:49:47 +01:00
Sebastian Wiesendahl 4541b0dea9 change user to root. amavis is not sufficient 2019-03-11 15:48:17 +01:00
Jeremy Shipman 7567d2e7a8 Typo in link 2019-03-09 09:55:05 +13:00
Jeremy Shipman 3d7b47c99a Added info about DMS_DEBUG variable 2019-03-09 09:54:33 +13:00
Sebastian Wiesendahl 7bb9596f72 add hint for system cron file 2019-03-08 16:14:51 +01:00
Sebastian Wiesendahl 4559699f9a add a blank line in the docker-compose.yml example 2019-03-08 16:11:45 +01:00
Sebastian Wiesendahl a0fa63750b unify documentation 2019-03-08 16:06:13 +01:00
Sebastian Wiesendahl 90fa8b0544 remove docker-compose swarm only statement 2019-03-08 16:01:17 +01:00
Sebastian Wiesendahl b5a827ff31 change min docker-compose version 2019-03-08 15:59:27 +01:00
Sebastian Wiesendahl aa7774801f add a plain docker-compose example without docker swarm 2019-03-08 15:57:33 +01:00
Christian Glahn 7a9737dd90 add a better example for sa-learn cron-jobs 2019-01-30 08:44:39 +01:00
Christian Glahn 70887618e2 Updated FAQ and Tips (markdown) 2019-01-30 08:32:42 +01:00
Christian Glahn cbbd1fbf0e language fix 2019-01-19 12:23:27 +01:00