Skip to content

Commit ddcc1dc

Browse files
docs: renamings (docker-mailserver#3242)
1 parent 34a1fd6 commit ddcc1dc

24 files changed

Lines changed: 119 additions & 119 deletions

docs/content/config/advanced/auth-ldap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: 'Advanced | LDAP Authentication'
44

55
## Introduction
66

7-
Getting started with ldap and `docker-mailserver` we need to take 3 parts in account:
7+
Getting started with ldap and DMS we need to take 3 parts in account:
88

99
- `postfix` for incoming & outgoing email
1010
- `dovecot` for accessing mailboxes

docs/content/config/advanced/full-text-search.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: 'Advanced | Full-Text Search'
66

77
Full-text search allows all messages to be indexed, so that mail clients can quickly and efficiently search messages by their full text content. Dovecot supports a variety of community supported [FTS indexing backends](https://doc.dovecot.org/configuration_manual/fts/).
88

9-
`docker-mailserver` comes pre-installed with two plugins that can be enabled with a dovecot config file.
9+
DMS comes pre-installed with two plugins that can be enabled with a dovecot config file.
1010

1111
Please be aware that indexing consumes memory and takes up additional disk space.
1212

@@ -101,7 +101,7 @@ While indexing is memory intensive, you can configure the plugin to limit the am
101101
```
102102
docker-compose exec mailserver doveadm fts optimize -A
103103
```
104-
Or like the [Spamassassin example][docs-faq-sa-learn-cron] shows, you can instead use `cron` from within `docker-mailserver` to avoid potential errors if the mail-server is not running:
104+
Or like the [Spamassassin example][docs-faq-sa-learn-cron] shows, you can instead use `cron` from within DMS to avoid potential errors if the mail server is not running:
105105
106106
??? example
107107

docs/content/config/advanced/ipv6.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ title: 'Advanced | IPv6'
44

55
## Background
66

7-
If your container host supports IPv6, then `docker-mailserver` will automatically accept IPv6 connections by way of the docker host's IPv6. However, incoming mail will fail SPF checks because they will appear to come from the IPv4 gateway that docker is using to proxy the IPv6 connection (`172.20.0.1` is the gateway).
7+
If your container host supports IPv6, then DMS will automatically accept IPv6 connections by way of the docker host's IPv6. However, incoming mail will fail SPF checks because they will appear to come from the IPv4 gateway that docker is using to proxy the IPv6 connection (`172.20.0.1` is the gateway).
88

9-
This can be solved by supporting IPv6 connections all the way to the `docker-mailserver` container.
9+
This can be solved by supporting IPv6 connections all the way to the DMS container.
1010

1111
## Setup steps
1212

docs/content/config/advanced/kubernetes.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ title: 'Advanced | Kubernetes'
44

55
## Introduction
66

7-
This article describes how to deploy `docker-mailserver` to Kubernetes. Please note that there is also a [Helm chart] available.
7+
This article describes how to deploy DMS to Kubernetes. Please note that there is also a [Helm chart] available.
88

99
!!! attention "Requirements"
1010

11-
We assume basic knowledge about Kubernetes from the reader. Moreover, we assume the reader to have a basic understanding of mail servers. Ideally, the reader has deployed `docker-mailserver` before in an easier setup with Docker (Compose).
11+
We assume basic knowledge about Kubernetes from the reader. Moreover, we assume the reader to have a basic understanding of mail servers. Ideally, the reader has deployed DMS before in an easier setup with Docker (Compose).
1212

1313
!!! warning "About Support for Kubernetes"
1414

@@ -58,7 +58,7 @@ data:
5858
SSL_KEY_PATH: /secrets/ssl/rsa/tls.key
5959
```
6060
61-
We can also make use of user-provided configuration files, e.g. `user-patches.sh`, `postfix-accounts.cf` and more, to adjust `docker-mailserver` to our likings. We encourage you to have a look at [Kustomize][kustomize] for creating `ConfigMap`s from multiple files, but for now, we will provide a simple, hand-written example. This example is absolutely minimal and only goes to show what can be done.
61+
We can also make use of user-provided configuration files, e.g. `user-patches.sh`, `postfix-accounts.cf` and more, to adjust DMS to our likings. We encourage you to have a look at [Kustomize][kustomize] for creating `ConfigMap`s from multiple files, but for now, we will provide a simple, hand-written example. This example is absolutely minimal and only goes to show what can be done.
6262

6363
```yaml
6464
---
@@ -149,7 +149,7 @@ spec:
149149

150150
### Deployments
151151

152-
Last but not least, the `Deployment` becomes the most complex component. It instructs Kubernetes how to run the `docker-mailserver` container and how to apply your `ConfigMaps`, persisted storage, etc. Additionally, we can set options to enforce runtime security here.
152+
Last but not least, the `Deployment` becomes the most complex component. It instructs Kubernetes how to run the DMS container and how to apply your `ConfigMaps`, persisted storage, etc. Additionally, we can set options to enforce runtime security here.
153153

154154
```yaml
155155
---
@@ -305,7 +305,7 @@ spec:
305305

306306
### Certificates - An Example
307307

308-
In this example, we use [`cert-manager`][cert-manager] to supply RSA certificates. You can also supply RSA certificates as fallback certificates, which `docker-mailserver` supports out of the box with `SSL_ALT_CERT_PATH` and `SSL_ALT_KEY_PATH`, and provide ECDSA as the proper certificates.
308+
In this example, we use [`cert-manager`][cert-manager] to supply RSA certificates. You can also supply RSA certificates as fallback certificates, which DMS supports out of the box with `SSL_ALT_CERT_PATH` and `SSL_ALT_KEY_PATH`, and provide ECDSA as the proper certificates.
309309

310310
```yaml
311311
---
@@ -340,15 +340,15 @@ spec:
340340

341341
The [TLS docs page][docs-tls] provides guidance when it comes to certificates and transport layer security. Always provide sensitive information vai `Secrets`.
342342

343-
## Exposing your Mail-Server to the Outside World
343+
## Exposing your Mail Server to the Outside World
344344

345-
The more difficult part with Kubernetes is to expose a deployed `docker-mailserver` to the outside world. Kubernetes provides multiple ways for doing that; each has downsides and complexity. The major problem with exposing `docker-mailserver` to outside world in Kubernetes is to [preserve the real client IP][Kubernetes-service-source-ip]. The real client IP is required by `docker-mailserver` for performing IP-based SPF checks and spam checks. If you do not require SPF checks for incoming mails, you may disable them in your [Postfix configuration][docs-postfix] by dropping the line that states: `check_policy_service unix:private/policyd-spf`.
345+
The more difficult part with Kubernetes is to expose a deployed DMS to the outside world. Kubernetes provides multiple ways for doing that; each has downsides and complexity. The major problem with exposing DMS to outside world in Kubernetes is to [preserve the real client IP][Kubernetes-service-source-ip]. The real client IP is required by DMS for performing IP-based SPF checks and spam checks. If you do not require SPF checks for incoming mails, you may disable them in your [Postfix configuration][docs-postfix] by dropping the line that states: `check_policy_service unix:private/policyd-spf`.
346346

347-
The easiest approach was covered above, using `#!yaml externalTrafficPolicy: Local`, which disables the service proxy, but makes the service local as well (which does not scale). This approach only works when you are given the correct (that is, a public and routable) IP address by a load balancer (like MetalLB). In this sense, the approach above is similar to the next example below. We want to provide you with a few alternatives too. **But** we also want to communicate the idea of another simple method: you could use a load-balancer without an external IP and DNAT the network traffic to the mail-server. After all, this does not interfere with SPF checks because it keeps the origin IP address. If no dedicated external IP address is available, you could try the latter approach, if one is available, use the former.
347+
The easiest approach was covered above, using `#!yaml externalTrafficPolicy: Local`, which disables the service proxy, but makes the service local as well (which does not scale). This approach only works when you are given the correct (that is, a public and routable) IP address by a load balancer (like MetalLB). In this sense, the approach above is similar to the next example below. We want to provide you with a few alternatives too. **But** we also want to communicate the idea of another simple method: you could use a load-balancer without an external IP and DNAT the network traffic to the mail server. After all, this does not interfere with SPF checks because it keeps the origin IP address. If no dedicated external IP address is available, you could try the latter approach, if one is available, use the former.
348348

349349
### External IPs Service
350350

351-
The simplest way is to expose `docker-mailserver` as a [Service][Kubernetes-network-service] with [external IPs][Kubernetes-network-external-ip]. This is very similar to the approach taken above. Here, an external IP is given to the service directly by you. With the approach above, you tell your load-balancer to do this.
351+
The simplest way is to expose DMS as a [Service][Kubernetes-network-service] with [external IPs][Kubernetes-network-external-ip]. This is very similar to the approach taken above. Here, an external IP is given to the service directly by you. With the approach above, you tell your load-balancer to do this.
352352

353353
```yaml
354354
---
@@ -380,15 +380,15 @@ This approach
380380

381381
### Proxy port to Service
382382

383-
The [proxy pod][Kubernetes-proxy-service] helps to avoid the necessity of specifying external IPs explicitly. This comes at the cost of complexity; you must deploy a proxy pod on each [Node][Kubernetes-nodes] you want to expose `docker-mailserver` on.
383+
The [proxy pod][Kubernetes-proxy-service] helps to avoid the necessity of specifying external IPs explicitly. This comes at the cost of complexity; you must deploy a proxy pod on each [Node][Kubernetes-nodes] you want to expose DMS on.
384384

385385
This approach
386386

387387
- does not preserve the real client IP, so SPF check of incoming mail will fail.
388388

389389
### Bind to concrete Node and use host network
390390

391-
One way to preserve the real client IP is to use `hostPort` and `hostNetwork: true`. This comes at the cost of availability; you can reach `docker-mailserver` from the outside world only via IPs of [Node][Kubernetes-nodes] where `docker-mailserver` is deployed.
391+
One way to preserve the real client IP is to use `hostPort` and `hostNetwork: true`. This comes at the cost of availability; you can reach DMS from the outside world only via IPs of [Node][Kubernetes-nodes] where DMS is deployed.
392392

393393
```yaml
394394
---
@@ -420,12 +420,12 @@ metadata:
420420

421421
With this approach,
422422

423-
- it is not possible to access `docker-mailserver` via other cluster Nodes, only via the Node `docker-mailserver` was deployed at.
423+
- it is not possible to access DMS via other cluster Nodes, only via the Node DMS was deployed at.
424424
- every Port within the Container is exposed on the Host side.
425425

426426
### Proxy Port to Service via PROXY Protocol
427427

428-
This way is ideologically the same as [using a proxy pod](#proxy-port-to-service), but instead of a separate proxy pod, you configure your ingress to proxy TCP traffic to the `docker-mailserver` pod using the PROXY protocol, which preserves the real client IP.
428+
This way is ideologically the same as [using a proxy pod](#proxy-port-to-service), but instead of a separate proxy pod, you configure your ingress to proxy TCP traffic to the DMS pod using the PROXY protocol, which preserves the real client IP.
429429

430430
#### Configure your Ingress
431431

@@ -501,7 +501,7 @@ Then, configure both [Postfix][docs-postfix] and [Dovecot][docs-dovecot] to expe
501501

502502
With this approach,
503503

504-
- it is not possible to access `docker-mailserver` via cluster-DNS, as the PROXY protocol is required for incoming connections.
504+
- it is not possible to access DMS via cluster-DNS, as the PROXY protocol is required for incoming connections.
505505

506506
[Helm chart]: https://github.com/docker-mailserver/docker-mailserver-helm
507507
[kustomize]: https://kustomize.io/

docs/content/config/advanced/mail-fetchmail.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ environment:
1010
- FETCHMAIL_POLL=300
1111
```
1212
13-
Generate a file called `fetchmail.cf` and place it in the `docker-data/dms/config/` folder. Your `docker-mailserver` folder should look like this example:
13+
Generate a file called `fetchmail.cf` and place it in the `docker-data/dms/config/` folder. Your DMS folder should look like this example:
1414

1515
```txt
1616
├── docker-data/dms/config

docs/content/config/advanced/override-defaults/dovecot.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: 'Override the Default Configs | Dovecot'
77
The Dovecot default configuration can easily be extended providing a `docker-data/dms/config/dovecot.cf` file.
88
[Dovecot documentation](https://doc.dovecot.org/configuration_manual/) remains the best place to find configuration options.
99

10-
Your `docker-mailserver` folder should look like this example:
10+
Your DMS folder structure should look like this example:
1111

1212
```txt
1313
├── docker-data/dms/config
@@ -26,7 +26,7 @@ mail_max_userip_connections = 100
2626

2727
Another important option is the `default_process_limit` (defaults to `100`). If high-security mode is enabled you'll need to make sure this count is higher than the maximum number of users that can be logged in simultaneously.
2828

29-
This limit is quickly reached if users connect to the `docker-mailserver` with multiple end devices.
29+
This limit is quickly reached if users connect to DMS with multiple end devices.
3030

3131
## Override Configuration
3232

@@ -55,7 +55,7 @@ To debug your dovecot configuration you can use:
5555
- Or: `docker exec -it mailserver doveconf | grep <some-keyword>`
5656

5757
!!! note
58-
[`setup.sh`][github-file-setupsh] is included in the `docker-mailserver` repository. Make sure to use the one matching your image version release.
58+
[`setup.sh`][github-file-setupsh] is included in the DMS repository. Make sure to use the one matching your image version release.
5959

6060
The file `docker-data/dms/config/dovecot.cf` is copied internally to `/etc/dovecot/local.conf`. To verify the file content, run:
6161

docs/content/config/advanced/override-defaults/user-patches.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 'Custom User Changes & Patches | Scripting'
33
---
44

5-
If you'd like to change, patch or alter files or behavior of `docker-mailserver`, you can use a script.
5+
If you'd like to change, patch or alter files or behavior of DMS, you can use a script.
66

77
In case you cloned this repository, you can copy the file [`user-patches.sh.dist` (_under `config/`_)][github-file-userpatches] with `#!sh cp config/user-patches.sh.dist docker-data/dms/config/user-patches.sh` in order to create the `user-patches.sh` script.
88

docs/content/config/advanced/podman.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Podman is a daemonless container engine for developing, managing, and running OC
88

99
!!! warning "About Support for Podman"
1010

11-
Please note that Podman **is not** officially supported as `docker-mailserver` is built and verified on top of the _Docker Engine_. This content is entirely community supported. If you find errors, please open an issue and provide a PR.
11+
Please note that Podman **is not** officially supported as DMS is built and verified on top of the _Docker Engine_. This content is entirely community supported. If you find errors, please open an issue and provide a PR.
1212

1313
!!! warning "About this Guide"
1414

@@ -67,7 +67,7 @@ Also notice that Podman's rootless mode is not about running as a non-root user
6767

6868
!!! warning
6969

70-
In order to make rootless `docker-mailserver` work we must modify some settings in the Linux system, it requires some basic linux server knowledge so don't follow this guide if you not sure what this guide is talking about. Podman rootfull mode and Docker are still good and security enough for normal daily usage.
70+
In order to make rootless DMS work we must modify some settings in the Linux system, it requires some basic linux server knowledge so don't follow this guide if you not sure what this guide is talking about. Podman rootfull mode and Docker are still good and security enough for normal daily usage.
7171

7272
First, enable `podman.socket` in systemd's userspace with a non-root user.
7373

docs/content/config/best-practices/autodiscover.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ hide:
66

77
# Auto-Discovery of Services
88

9-
Email auto-discovery means a client email is able to automagically find out about what ports and security options to use, based on the mail-server URI. It can help simplify the tedious / confusing task of adding own's email account for non-tech savvy users.
9+
Email auto-discovery means a client email is able to automagically find out about what ports and security options to use, based on the mail server URI. It can help simplify the tedious / confusing task of adding own's email account for non-tech savvy users.
1010

1111
Email clients will search for auto-discoverable settings and prefill almost everything when a user enters its email address :heart:
1212

docs/content/config/best-practices/dkim_dmarc_spf.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Cloudflare has written an [article about DKIM, DMARC and SPF][cloudflare-dkim-dm
1111
- SPF: `policyd-spf` is used in Postfix's `smtpd_recipient_restrictions`
1212

1313
In a future release Rspamd will become the default for these validations, with a deprecation notice issued prior to the removal of the above alternatives.
14-
14+
1515
We encourage everyone to prefer Rspamd via `ENABLE_RSPAMD=1`.
1616

1717
!!! warning "DNS Caches & Propagation"
@@ -184,7 +184,7 @@ DKIM is currently supported by either OpenDKIM or Rspamd:
184184

185185
!!! info "Restart required"
186186

187-
After restarting `docker-mailserver`, outgoing mail will now be signed with your new DKIM key(s) :tada:
187+
After restarting DMS, outgoing mail will now be signed with your new DKIM key(s) :tada:
188188

189189
You'll need to repeat this process if you add any new domains.
190190

@@ -220,7 +220,7 @@ When mail signed with your DKIM key is sent from your mail server, the receiver
220220
??? info "`<selector>.txt` - Formatting the `TXT` record value correctly"
221221

222222
This file was generated for use within a [DNS zone file][dns::wikipedia-zonefile]. DNS `TXT` records values that are longer than 255 characters need to be split into multiple parts. This is why the public key has multiple parts wrapped within double-quotes between `(` and `)`.
223-
223+
224224
A DNS web-interface may handle this internally instead, while [others may not, but expect the input as a single line][dns::webui-dkim]_). You'll need to manually format the value as described below.
225225

226226
Your DNS record file (eg: `mail.txt`) should look similar to this:

0 commit comments

Comments
 (0)