From 05eb8cb10e4bcb32bdb81eb924d33429f1ee1107 Mon Sep 17 00:00:00 2001 From: William Desportes Date: Fri, 13 Aug 2021 10:33:10 +0200 Subject: [PATCH] More typo fixes and improve ports example at POP3 docs (#2128) Co-authored-by: Casper Co-authored-by: Georg Lauterbach <44545919+georglauterbach@users.noreply.github.com> --- .../advanced/mail-forwarding/relay-hosts.md | 2 +- docs/content/config/pop3.md | 17 +++++++++-------- docs/content/config/setup.sh.md | 2 +- .../examples/tutorials/basic-installation.md | 2 +- .../tutorials/mailserver-behind-proxy.md | 6 +++--- ...-only-mailserver-with-ldap-authentication.md | 4 ++-- 6 files changed, 17 insertions(+), 16 deletions(-) diff --git a/docs/content/config/advanced/mail-forwarding/relay-hosts.md b/docs/content/config/advanced/mail-forwarding/relay-hosts.md index 5bb672e5..fb3426bb 100644 --- a/docs/content/config/advanced/mail-forwarding/relay-hosts.md +++ b/docs/content/config/advanced/mail-forwarding/relay-hosts.md @@ -39,7 +39,7 @@ An example configuration file looks like this: @domain2.com relay_user_2:password_2 ``` -If there is no other configuration, this will cause Postfix to deliver email throught the relay specified in `RELAY_HOST` env variable, authenticating as `relay_user_1` when sent from `domain1.com` and authenticating as `relay_user_2` when sending from domain2.com. +If there is no other configuration, this will cause Postfix to deliver email through the relay specified in `RELAY_HOST` env variable, authenticating as `relay_user_1` when sent from `domain1.com` and authenticating as `relay_user_2` when sending from domain2.com. !!! note To activate the configuration you must either restart the container, or you can also trigger an update by modifying a mail account. diff --git a/docs/content/config/pop3.md b/docs/content/config/pop3.md index 71cf0b13..1acc8e85 100644 --- a/docs/content/config/pop3.md +++ b/docs/content/config/pop3.md @@ -4,17 +4,18 @@ hide: - toc # Hide Table of Contents for this page --- -If you want to use POP3(S), you have to add the ports 110 and/or 995 (TLS secured) and the environment variable `ENABLE_POP3` to your `docker-compose.yml`: +If you want to use POP3(S), you have to add the ports 110 and/or 995 (TLS secured) and the environment variable `ENABLE_POP3` to your `docker-compose.yml`: ```yaml -mail: +mailserver: ports: - - "25:25" - - "143:143" - - "587:587" - - "993:993" - - "110:110" - - "995:995" + - "25:25" # SMTP (explicit TLS => STARTTLS) + - "143:143" # IMAP4 (explicit TLS => STARTTLS) + - "465:465" # ESMTP (implicit TLS) + - "587:587" # ESMTP (explicit TLS => STARTTLS) + - "993:993" # IMAP4 (implicit TLS) + - "110:110" # POP3 + - "995:995" # POP3 (with TLS) environment: - ENABLE_POP3=1 ``` diff --git a/docs/content/config/setup.sh.md b/docs/content/config/setup.sh.md index 7427fffa..b2731720 100644 --- a/docs/content/config/setup.sh.md +++ b/docs/content/config/setup.sh.md @@ -4,7 +4,7 @@ hide: - toc # Hide Table of Contents for this page --- -[`setup.sh`][github-file-setupsh] is an administration script that helps with the most common tasks, including initial configuration. It is intented to be used from the host machine, _not_ from within your running container. +[`setup.sh`][github-file-setupsh] is an administration script that helps with the most common tasks, including initial configuration. It is intended to be used from the host machine, _not_ from within your running container. The latest version of the script is included in the `docker-mailserver` repository. You may retrieve it at any time by running this command in your console: diff --git a/docs/content/examples/tutorials/basic-installation.md b/docs/content/examples/tutorials/basic-installation.md index 1a47d770..8362a513 100644 --- a/docs/content/examples/tutorials/basic-installation.md +++ b/docs/content/examples/tutorials/basic-installation.md @@ -146,7 +146,7 @@ We are going to use this docker based mailserver: ./setup.sh alias list ``` - This extra step is required to avoid the `553 5.7.1 Sender address rejected: not owned by user` error (the account used for setting up gmail is `admin.gmail@example.org` and `info.gmail@example.org` ) + This extra step is required to avoid the `553 5.7.1 Sender address rejected: not owned by user` error (the account used for setting up Gmail is `admin.gmail@example.org` and `info.gmail@example.org` ) - Send some test emails to these addresses and make other tests. Then stop the container with `ctrl+c` and start it again as a daemon: `docker-compose up -d mail`. diff --git a/docs/content/examples/tutorials/mailserver-behind-proxy.md b/docs/content/examples/tutorials/mailserver-behind-proxy.md index cc4c5620..d0ef93b3 100644 --- a/docs/content/examples/tutorials/mailserver-behind-proxy.md +++ b/docs/content/examples/tutorials/mailserver-behind-proxy.md @@ -23,7 +23,7 @@ Luckily `dovecot` and `postfix` are both Proxy-Protocol ready softwares so it de The configuration depends on the used proxy system. I will provide the configuration examples of [traefik v2](https://traefik.io/) using IMAP and SMTP with implicit TLS. -Feel free to add your configuration if you achived the same goal using different proxy software below: +Feel free to add your configuration if you archived the same goal using different proxy software below: ??? "Traefik v2" @@ -88,11 +88,11 @@ Feel free to add your configuration if you achived the same goal using different [...] ``` - Keep in mind that it is neccessary to use port `10993` here. More information below at `dovecot` configuration. + Keep in mind that it is necessary to use port `10993` here. More information below at `dovecot` configuration. ### Configuration of the Backend (`dovecot` and `postfix`) -The following changes can be achived completely by adding the content to the appropriate files by using the projects [function to overwrite config files][docs-optionalconfig]. +The following changes can be achieved completely by adding the content to the appropriate files by using the projects [function to overwrite config files][docs-optionalconfig]. Changes for `postfix` can be applied by adding the following content to `config/postfix-main.cf`: diff --git a/docs/content/examples/uses-cases/forward-only-mailserver-with-ldap-authentication.md b/docs/content/examples/uses-cases/forward-only-mailserver-with-ldap-authentication.md index 5a8215fb..6360c6a6 100644 --- a/docs/content/examples/uses-cases/forward-only-mailserver-with-ldap-authentication.md +++ b/docs/content/examples/uses-cases/forward-only-mailserver-with-ldap-authentication.md @@ -4,7 +4,7 @@ title: 'Use Cases | Forward-Only Mailserver with LDAP' ## Building a Forward-Only Mailserver -A **forward-only** mailserver does not have any local mailboxes. Instead, it has only aliases that forward emails to external email accounts (for example to a gmail account). You can also send email from the localhost (the computer where the mailserver is installed), using as sender any of the alias addresses. +A **forward-only** mailserver does not have any local mailboxes. Instead, it has only aliases that forward emails to external email accounts (for example to a Gmail account). You can also send email from the localhost (the computer where the mailserver is installed), using as sender any of the alias addresses. The important settings for this setup (on `mailserver.env`) are these: @@ -96,7 +96,7 @@ postfix reload You see that besides `query_filter`, I had to customize as well `result_attribute` and `result_format`. -!!! sealso +!!! seealso "See also" For more details about using LDAP see: [LDAP managed mail server with Postfix and Dovecot for multiple domains](https://www.vennedey.net/resources/2-LDAP-managed-mail-server-with-Postfix-and-Dovecot-for-multiple-domains)