From 2eba96e93ab87db492d701a5735b5dbe1bd2c3f8 Mon Sep 17 00:00:00 2001 From: Sam Chudnick Date: Sun, 2 Jul 2023 19:11:21 -0400 Subject: Fix README --- README.md | 33 ++++++++++++++++++--------------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index eb23991..a87fce2 100644 --- a/README.md +++ b/README.md @@ -5,20 +5,22 @@ ansible-mailserver is an Ansible playbook to deploy a simple postfix/dovecot mai Simple one-command installation and configuration of your very own mail server. Includes a host of defenses needed when dealing with the world of internet mail: -- postscreen - inbound SMTP connection filtering -- postgrey - greylisting utility -- policyd-spf - SPF validation -- spamassassin - spam filter -- opendkim - DKIM signing and verification -- opendmarc - DMARC verification + + - postscreen - inbound SMTP connection filtering + - postgrey - greylisting utility + - policyd-spf - SPF validation + - spamassassin - spam filter + - opendkim - DKIM signing and verification + - opendmarc - DMARC verification ## Usage ### Prerequisites Before running the playbook you will need to have the following: -- An A record for your base domain -- An A record for the `mail` subdomain -- A PTR record for your mail server + + - An A record for your base domain + - An A record for the `mail` subdomain + - A PTR record for your mail server ### Clone the repository ``` @@ -34,12 +36,13 @@ mail server. ### Modify vars.yml Modify group\_vars/all/vars.yml for your deployment. Below is a list of the variables and there function: -- `domain` - base domain -- `mail_domain` - hostname of your mail server and common name on the TLS certificate -- `dkim_selector` - selector for your DKIM keys -- `spam_score` - SpamAssassin score required for mail to be considered spam -- `sa_locales` - locales which SpamAssassin expects to receive mail in - any locale not listed is considered spam -- `cert_email` - the email used to get a LetsEncrypt certificate + + - `domain` - base domain + - `mail_domain` - hostname of your mail server and common name on the TLS certificate + - `dkim_selector` - selector for your DKIM keys + - `spam_score` - SpamAssassin score required for mail to be considered spam + - `sa_locales` - locales which SpamAssassin expects to receive mail in - any locale not listed is considered spam + - `cert_email` - the email used to get a LetsEncrypt certificate You must modify `domain` with your domain name. All other changes are optional. -- cgit v1.2.3