diff options
-rw-r--r-- | README.md | 33 |
1 files changed, 18 insertions, 15 deletions
@@ -5,20 +5,22 @@ ansible-mailserver is an Ansible playbook to deploy a simple postfix/dovecot mai | |||
5 | Simple one-command installation and configuration of your very own mail server. | 5 | Simple one-command installation and configuration of your very own mail server. |
6 | 6 | ||
7 | Includes a host of defenses needed when dealing with the world of internet mail: | 7 | Includes a host of defenses needed when dealing with the world of internet mail: |
8 | - postscreen - inbound SMTP connection filtering | 8 | |
9 | - postgrey - greylisting utility | 9 | - postscreen - inbound SMTP connection filtering |
10 | - policyd-spf - SPF validation | 10 | - postgrey - greylisting utility |
11 | - spamassassin - spam filter | 11 | - policyd-spf - SPF validation |
12 | - opendkim - DKIM signing and verification | 12 | - spamassassin - spam filter |
13 | - opendmarc - DMARC verification | 13 | - opendkim - DKIM signing and verification |
14 | - opendmarc - DMARC verification | ||
14 | 15 | ||
15 | ## Usage | 16 | ## Usage |
16 | 17 | ||
17 | ### Prerequisites | 18 | ### Prerequisites |
18 | Before running the playbook you will need to have the following: | 19 | Before running the playbook you will need to have the following: |
19 | - An A record for your base domain | 20 | |
20 | - An A record for the `mail` subdomain | 21 | - An A record for your base domain |
21 | - A PTR record for your mail server | 22 | - An A record for the `mail` subdomain |
23 | - A PTR record for your mail server | ||
22 | 24 | ||
23 | ### Clone the repository | 25 | ### Clone the repository |
24 | ``` | 26 | ``` |
@@ -34,12 +36,13 @@ mail server. | |||
34 | ### Modify vars.yml | 36 | ### Modify vars.yml |
35 | Modify group\_vars/all/vars.yml for your deployment. | 37 | Modify group\_vars/all/vars.yml for your deployment. |
36 | Below is a list of the variables and there function: | 38 | Below is a list of the variables and there function: |
37 | - `domain` - base domain | 39 | |
38 | - `mail_domain` - hostname of your mail server and common name on the TLS certificate | 40 | - `domain` - base domain |
39 | - `dkim_selector` - selector for your DKIM keys | 41 | - `mail_domain` - hostname of your mail server and common name on the TLS certificate |
40 | - `spam_score` - SpamAssassin score required for mail to be considered spam | 42 | - `dkim_selector` - selector for your DKIM keys |
41 | - `sa_locales` - locales which SpamAssassin expects to receive mail in - any locale not listed is considered spam | 43 | - `spam_score` - SpamAssassin score required for mail to be considered spam |
42 | - `cert_email` - the email used to get a LetsEncrypt certificate | 44 | - `sa_locales` - locales which SpamAssassin expects to receive mail in - any locale not listed is considered spam |
45 | - `cert_email` - the email used to get a LetsEncrypt certificate | ||
43 | 46 | ||
44 | You must modify `domain` with your domain name. All other changes are optional. | 47 | You must modify `domain` with your domain name. All other changes are optional. |
45 | 48 | ||