From 59f483f1575c4062098af3d2ecd0686f1dc205cb Mon Sep 17 00:00:00 2001 From: rriski Date: Thu, 27 Jul 2023 03:24:36 +0300 Subject: [PATCH] docs: Fix typos (#3443) Various typos fixed in docs, in addition to a config and ENV template. --- config-examples/dovecot.cf | 2 +- docs/content/config/advanced/kubernetes.md | 2 +- docs/content/config/advanced/mail-fetchmail.md | 2 +- docs/content/config/advanced/mail-forwarding/aws-ses.md | 2 +- docs/content/config/advanced/mail-sieve.md | 2 +- docs/content/config/debugging.md | 2 +- docs/content/config/environment.md | 2 +- docs/content/config/security/ssl.md | 4 ++-- docs/content/faq.md | 2 +- docs/content/introduction.md | 2 +- mailserver.env | 6 +++--- 11 files changed, 14 insertions(+), 14 deletions(-) diff --git a/config-examples/dovecot.cf b/config-examples/dovecot.cf index 0222fc90..d9010b7a 100644 --- a/config-examples/dovecot.cf +++ b/config-examples/dovecot.cf @@ -1,4 +1,4 @@ # File for additional dovecot configurations. -# For more informations read https://doc.dovecot.org/configuration_manual/quick_configuration/ +# For more information read https://doc.dovecot.org/configuration_manual/quick_configuration/ #mail_max_userip_connections = 50 diff --git a/docs/content/config/advanced/kubernetes.md b/docs/content/config/advanced/kubernetes.md index 8846c955..93cc0884 100644 --- a/docs/content/config/advanced/kubernetes.md +++ b/docs/content/config/advanced/kubernetes.md @@ -163,7 +163,7 @@ metadata: ignore-check.kube-linter.io/run-as-non-root: >- 'mailserver' needs to run as root ignore-check.kube-linter.io/privileged-ports: >- - 'mailserver' needs privilegdes ports + 'mailserver' needs privileged ports ignore-check.kube-linter.io/no-read-only-root-fs: >- There are too many files written to make The root FS read-only diff --git a/docs/content/config/advanced/mail-fetchmail.md b/docs/content/config/advanced/mail-fetchmail.md index 59e07a84..254196a1 100644 --- a/docs/content/config/advanced/mail-fetchmail.md +++ b/docs/content/config/advanced/mail-fetchmail.md @@ -75,7 +75,7 @@ To debug your `fetchmail.cf` configuration run this command: ./setup.sh debug fetchmail ``` -For more informations about the configuration script `setup.sh` [read the corresponding docs][docs-setup]. +For more information about the configuration script `setup.sh` [read the corresponding docs][docs-setup]. Here a sample output of `./setup.sh debug fetchmail`: diff --git a/docs/content/config/advanced/mail-forwarding/aws-ses.md b/docs/content/config/advanced/mail-forwarding/aws-ses.md index 891295b4..2a4dab17 100644 --- a/docs/content/config/advanced/mail-forwarding/aws-ses.md +++ b/docs/content/config/advanced/mail-forwarding/aws-ses.md @@ -2,7 +2,7 @@ title: 'Mail Forwarding | AWS SES' --- -[Amazon SES (Simple Email Service)](https://aws.amazon.com/ses/) is intended to provide a simple way for cloud based applications to send email and receive email. For the purposes of this project only sending email via SES is supported. Older versions of docker-mailserver used `AWS_SES_HOST` and `AWS_SES_USERPASS` to configure sending, this has changed and the setup is mananged through [Configure Relay Hosts][docs-relay]. +[Amazon SES (Simple Email Service)](https://aws.amazon.com/ses/) is intended to provide a simple way for cloud based applications to send email and receive email. For the purposes of this project only sending email via SES is supported. Older versions of docker-mailserver used `AWS_SES_HOST` and `AWS_SES_USERPASS` to configure sending, this has changed and the setup is managed through [Configure Relay Hosts][docs-relay]. You will need to create some [Amazon SES SMTP credentials](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/smtp-credentials.html). The SMTP credentials you create will be used to populate the `RELAY_USER` and `RELAY_PASSWORD` environment variables. diff --git a/docs/content/config/advanced/mail-sieve.md b/docs/content/config/advanced/mail-sieve.md index 627e12ed..d050bf9f 100644 --- a/docs/content/config/advanced/mail-sieve.md +++ b/docs/content/config/advanced/mail-sieve.md @@ -96,7 +96,7 @@ All user defined sieve scripts that are managed by ManageSieve are stored in the !!! note - ManageSieve makes sure to not overwrite an existing `.dovecot.sieve` file. If a user activates a new sieve script the old one is backuped and moved to the `sieve` folder. + ManageSieve makes sure to not overwrite an existing `.dovecot.sieve` file. If a user activates a new sieve script the old one is backed up and moved to the `sieve` folder. The extension is known to work with the following ManageSieve clients: diff --git a/docs/content/config/debugging.md b/docs/content/config/debugging.md index 725fb4d5..a17fd5ff 100644 --- a/docs/content/config/debugging.md +++ b/docs/content/config/debugging.md @@ -63,7 +63,7 @@ This could be from outdated software, or running a system that isn't able to pro - **IPv6:** - Requires [additional configuration][docs-ipv6] to prevent or properly support IPv6 connections (eg: Preserving the Client IP). - Support in 2023 is still considered experimental. You are advised to use at least Docker Engine `v23` (2023Q1). - - Various networking bug fixes have been addressed since the intitial IPv6 support arrived in Docker Engine `v20.10.0` (2020Q4). + - Various networking bug fixes have been addressed since the initial IPv6 support arrived in Docker Engine `v20.10.0` (2020Q4). ### System diff --git a/docs/content/config/environment.md b/docs/content/config/environment.md index 64c0b0d0..ab9171ac 100644 --- a/docs/content/config/environment.md +++ b/docs/content/config/environment.md @@ -645,7 +645,7 @@ The following variables overwrite the default values for ```/etc/dovecot/dovecot ##### DOVECOT_DNPASS - **empty** => same as `LDAP_BIND_PW` -- => Password for LDAP dn sepecifified in `DOVECOT_DN`. +- => Password for LDAP dn specified in `DOVECOT_DN`. ##### DOVECOT_URIS diff --git a/docs/content/config/security/ssl.md b/docs/content/config/security/ssl.md index f81470ac..4618fda1 100644 --- a/docs/content/config/security/ssl.md +++ b/docs/content/config/security/ssl.md @@ -220,7 +220,7 @@ Obtain a Cloudflare API token: This certificate expires on YYYY-MM-DD. These files will be updated when the certificate renews. NEXT STEPS: - - The certificate will need to be renewed before it expires. Certbot can automatically renew the certificate in background, but you may need to take steps to enable that functionality. See https://certbot.org/renewal structions. + - The certificate will need to be renewed before it expires. Certbot can automatically renew the certificate in background, but you may need to take steps to enable that functionality. See https://certbot.org/renewal instructions. ``` After completing the steps above, your certificate should be ready to use. @@ -835,7 +835,7 @@ You can of course run the script by cron once a week or something. In that way y ```sh # This script is run inside docker-mailserver via 'docker exec ...', using the 'mail' command to send alerts. ## code below will alert if certificate expires in less than two weeks -## please adjust varables! +## please adjust variables! ## make sure the 'mail -s' command works! Test! export SITE_URL="mail.example.com" diff --git a/docs/content/faq.md b/docs/content/faq.md index 64728d09..58a327b9 100644 --- a/docs/content/faq.md +++ b/docs/content/faq.md @@ -493,7 +493,7 @@ SA_TAG2=3.75 SA_KILL=100000.0 ``` -- The very negative vaue in `SA_TAG` makes sure, that all emails have the SpamAssassin headers included. +- The very negative value in `SA_TAG` makes sure, that all emails have the SpamAssassin headers included. - `SA_TAG2` is the actual threshold to set the YES/NO flag for spam detection. - `SA_KILL` needs to be very high, to make sure nothing is bounced at all (`SA_KILL` superseeds `SPAMASSASSIN_SPAM_TO_INBOX`) diff --git a/docs/content/introduction.md b/docs/content/introduction.md index 73c7e58c..bbfd6ef4 100644 --- a/docs/content/introduction.md +++ b/docs/content/introduction.md @@ -39,7 +39,7 @@ In a nutshell, DMS provides you with the following components: - A MDA: [Dovecot](https://dovecot.org/) - A bunch of additional programs to improve security and emails processing -Here's where DMS's toochain fits within the delivery chain: +Here's where DMS's toolchain fits within the delivery chain: ```txt docker-mailserver is here: diff --git a/mailserver.env b/mailserver.env index c857aff9..038e23b1 100644 --- a/mailserver.env +++ b/mailserver.env @@ -398,8 +398,8 @@ GETMAIL_POLL=5 # A second container for the ldap service is necessary (i.e. https://github.com/osixia/docker-openldap) # with the :edge tag, use ACCOUNT_PROVISIONER=LDAP -# empty => LDAP authentification is disabled -# 1 => LDAP authentification is enabled +# empty => LDAP authentication is disabled +# 1 => LDAP authentication is enabled ENABLE_LDAP= # empty => no @@ -499,7 +499,7 @@ SASLAUTHD_MECH_OPTIONS= SASLAUTHD_LDAP_SERVER= # empty => Use value of LDAP_BIND_DN -# specify an object with priviliges to search the directory tree +# specify an object with privileges to search the directory tree # e.g. active directory: SASLAUTHD_LDAP_BIND_DN=cn=Administrator,cn=Users,dc=mydomain,dc=net # e.g. openldap: SASLAUTHD_LDAP_BIND_DN=cn=admin,dc=mydomain,dc=net SASLAUTHD_LDAP_BIND_DN=