1
0
mirror of https://github.com/tomav/docker-mailserver.git synced 2024-06-27 19:55:40 +02:00
docker-mailserver/target/bin
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
..
addalias start-mailserver.sh split (#1820) 2021-02-23 20:03:01 +01:00
addmailuser Lock file create and remove improvements (#2183) 2021-09-13 20:09:01 +12:00
addrelayhost start-mailserver.sh split (#1820) 2021-02-23 20:03:01 +01:00
addsaslpassword start-mailserver.sh split (#1820) 2021-02-23 20:03:01 +01:00
debug-fetchmail Complete Refactor for target/bin (#1654) 2020-10-21 18:16:32 +02:00
delalias start-mailserver.sh split (#1820) 2021-02-23 20:03:01 +01:00
delmailuser Fix delmailuser error handling (#2181) 2021-09-14 14:07:29 +02:00
delquota start-mailserver.sh split (#1820) 2021-02-23 20:03:01 +01:00
excluderelaydomain Final Migration Step (#6) 2021-01-16 10:16:05 +01:00
fail2ban Update F2B wrapper to show possible errors with IPTables (#2170) 2021-09-06 11:39:50 +02:00
fetchmailrc_split Solve Fetchmail imap idle issue (#10) 2021-01-17 10:39:09 +01:00
listalias start-mailserver.sh split (#1820) 2021-02-23 20:03:01 +01:00
listmailuser Enhance setup.sh email list (#1898) 2021-04-12 15:18:15 +02:00
open-dkim corrected dkim keysize argument in help pages, closing #1845 2021-03-10 11:21:24 +01:00
postfix-summary Final Migration Step (#6) 2021-01-16 10:16:05 +01:00
print-environment Introduce issue forms and update debug output for forms (#2160) 2021-09-11 10:49:39 +12:00
report-pflogsumm-yesterday Final Migration Step (#6) 2021-01-16 10:16:05 +01:00
restrict-access Final Migration Step (#6) 2021-01-16 10:16:05 +01:00
sedfile sed wrapper (#2158) 2021-09-06 10:07:02 +12:00
setquota Lock file create and remove improvements (#2183) 2021-09-13 20:09:01 +12:00
setup docs(chore): Normalize for consistency (#2206) 2021-09-23 11:29:37 +12:00
setup-fetchmail Complete Refactor for target/bin (#1654) 2020-10-21 18:16:32 +02:00
updatemailuser Lock file create and remove improvements (#2183) 2021-09-13 20:09:01 +12:00
virus-wiper Complete Refactor for target/bin (#1654) 2020-10-21 18:16:32 +02:00