1
0
mirror of https://github.com/tomav/docker-mailserver.git synced 2024-07-02 14:11:12 +02:00
Commit Graph

51 Commits

Author SHA1 Message Date
Brennan Kinney
0b8b77ad88
docs: Fix dmarc link (#2728)
There was a typo in the reference preventing the link from being properly rendered.
2022-08-20 17:00:30 +12:00
Brennan Kinney
a0ee472501
docs(chore): Normalize for consistency (#2206)
"Brief" summary/overview of changes. See the PR discussion or individual commits from the PR for more details.

---

Only applies to the `docs/content/**` content (_and `setup` command_). `target/` and `test/` can be normalized at a later date.

* Normalize to `example.com`

- Domains normalized to `example.com`: `mywebserver.com`, `myserver.tld`, `domain.com`, `domain.tld`, `mydomain.net`, `my-domain.tld`, `my-domain.com`, `example.org`, `whoami.com`.
- Alternative domains normalized to `not-example.com`: `otherdomain.com`, `otherdomain.tld`, `domain2.tld`, `mybackupmx.com`, `whoareyou.org`.
- Email addresses normalized to `admin@example.com` (in `ssl.md`): `foo@bar.com`, `yourcurrentemail@gmail.com`, `email@email.com`, `admin@domain.tld`.
- Email addresses normalized to `external-account@gmail.com`: `bill@gates321boom.com`, `external@gmail.com`, `myemail@gmail.com`, `real-email-address@external-domain.com`.
- **`faq.md`:** A FAQ entry title with `sample.domain.com` changed to `subdomain.example.com`.
- **`mail-fetchmail.md`:** Config examples with FQDNs for `imap`/`pop3` used `example.com` domain for a third-party, changed to `gmail.com` as more familiar third-party/external MTA.

* Normalize config volume path

- Normalizing local config path references to `./docker-data/dms/config/`: `./config/`, `config/`, \``config`\`, `/etc/` (_volume mount src path prefix_).
- Normalize DMS volume paths to `docker-data/dms/mail-{data,state,log}`: `./mail`, `./mail-state` `./data/mail`, `./data/state`, `./data/logs`, `./data/maildata`, `./data/mailstate`, `./data/maillogs`, (_dropped/converted data volumes: `maildata`, `mailstate`_).
- Other docker images also adopt the `docker-data/{service name}/` prefix.

* `ssl.md` - Use `dms/custom-certs` where appropriate.

* Apply normalizations to README and example `docker-compose.yml`

---

Common terms, sometimes interchangeably used or now invalid depending on context: `mail`, `mail container`, `mail server`, `mail-server`, `mailserver`,`docker-mailserver`, `Docker Mailserver`.

Rough transformations applied to most matches (_conditionally, depending on context_):

- 'Docker Mailserver' => '`docker-mailserver`'
- 'mail container' => '`docker-mailserver`' (_optionally retaining ' container'_)
- 'mail server' => 'mail-server' / '`docker-mailserver`'
- 'mail-server' => '`docker-mailserver`'
- 'mailserver' => 'mail-server' / '`docker-mailserver`'

Additionally I checked `docker run` (_plus `exec`, `logs`, etc, sub-commands_) and `docker-compose` commands. Often finding usage of `mail` instead of the expected `mailserver`

Additionally changes `mailserver` hostname in k8s to `mail` to align with other non-k8s examples.

---

* drive-by revisions

Mostly minor revisions or improvements to docs that aren't related to normalization effort.
2021-09-23 11:29:37 +12:00
Frederic Werner
e20a66864a
docs(deps): bump mkdocs-material to 7.1.6 (#2015)
* docs(deps): bump mkdocs-material to 7.1.6

* chore: trigger preview on changes to preview workflows too

* fix: replace deprecated admonition

Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
2021-05-31 19:02:56 +12:00
polarathene
1b971a89cb docs(sync): Add Github Wiki contributions
During the long-lived PR, multiple contributions to the existing Github Wiki were made, this commit applies those here and mentions the files and authors attributed to the changes:

JaapD: dkim.md + forward-only-mailserver-with-ldap-authentication.md

Added corrections to `setup.sh config dkim` command.
Added compatibility warning about 4096-bit key sizes or greater.
Added ldap tip. 

---

fred727-temp: optional-config.md

Added a mention for `user-patches.sh`.

---

Semir Patel: setup.sh.md + debugging.md

Minor corrections. Additionally corrected `tvial` references that had already been updated in this PR series.

---

Stefan Neben: kubernetes.md

> Port 25 proxy protocol configuration in master.cf was missing
docs(sync): Add Github Wiki contributions
> IMAP with STARTTLS is also active, so we need that option here as well
docs(sync): Add Github Wiki contribution
2021-03-25 11:49:24 +13:00
wernerfred
711b4c9d83 docs(refactor): Convert more content to use admonitions + improvements 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
Georg Lauterbach
7b3e416184 Updated Configure DKIM (markdown) 2021-02-08 12:21:12 +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
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
Patrizio Bekerle
8b9a102e3e Mention maintained autodiscover-email-settings 2020-12-13 21:42:51 +01:00
idaadi
68e9e5dd36 mailto was missing from the forensics receiver (ruf) 2020-07-07 00:58:25 +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
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
Oleg Kainov
3ce6ecd9d1 Updated Configure DMARC (markdown) 2020-05-17 18:57:36 +02:00
Oleg Kainov
c95e877a23 Updated Configure DMARC (markdown) 2020-05-15 22:49:53 +02:00
Oleg Kainov
a5af73e8a3 Updated Configure DMARC (markdown) 2020-05-15 22:49:31 +02:00
Oleg Kainov
bce6912988 Add DMARC guide 2020-05-15 22:49:00 +02:00
youtous
a6b0a490c5 Updated Configure DKIM (markdown) 2020-05-15 18:45:33 +02:00
mchamplain
c755c763f5 adding note about keys on multiple line 2019-10-27 01:37:42 -04:00
lukas
aaaa0398b6 Updated Configure SPF (markdown) 2019-08-23 12:31:33 -06:00
helmutundarnold
72f6dafc0d Updated Configure DKIM (markdown) 2018-04-12 23:25:12 +02:00
Marek Walczak
d74fa95afa DKIM Key Size introduced in #868 2018-03-03 07:39:24 +01:00
17Halbe
260486b305 Updated Configure SPF (markdown) 2018-02-09 22:16:48 +01:00
Johan Smits
a643caf793 Add restart message 2018-02-06 19:57:16 +01:00
Johan Smits
af90682d64 Initial wiki page 2017-09-07 19:39:48 +02:00
hogsim
95b2411b59 Updated Configure DKIM (markdown) 2016-09-26 19:25:40 +02:00
Josef Friedrich
a1b486a7b9 Add missing dot 2016-09-07 19:38:50 +02:00
Josef Friedrich
c5228ff3f8 Shorten key 2016-09-07 19:38:02 +02:00
Josef Friedrich
749b2f5244 Better wording 2016-09-07 19:36:40 +02:00
Josef Friedrich
e2fcdb3c1a Add section 'Configuration using a web interface' 2016-09-07 19:35:21 +02:00
Josef Friedrich
b5ea16d761 Extend debugging section 2016-09-07 19:24:38 +02:00
Josef Friedrich
c49f14a8bb Add dig command 2016-09-07 18:37:43 +02:00
Zehir
01afb57ffa More details on the generation of DKIM key 2016-08-17 13:50:18 +02:00
Thomas VIAL
29b2233ba8 Updated Configure DKIM (markdown) 2016-06-01 16:00:02 +02:00
Thomas VIAL
121a01fa4b Updated Configure DKIM (markdown) 2016-06-01 15:59:50 +02:00
Thorsten von Eicken
db698ba9db add info for verify-only DKIM 2016-05-31 19:16:51 -07:00
Josef Friedrich
6278567fb3 v2 is now latest 2016-05-10 07:37:47 +02:00
Thomas VIAL
fc83970af4 Updated Configure SPF (markdown) 2016-04-24 17:55:39 +02:00
Thomas VIAL
6b18dc33a5 Updated Configure DKIM (markdown) 2016-04-24 17:49:31 +02:00
Thomas VIAL
dadd535954 Updated Configure DKIM (markdown) 2016-04-24 17:49:08 +02:00
Thomas VIAL
0c556012e0 Updated Configure SPF (markdown) 2016-04-24 17:46:45 +02:00
Thomas VIAL
375acd2263 Created Configure SPF (markdown) 2016-04-24 17:46:33 +02:00