blob: 7a943a0a6e8ad0c135d611bc6986a8ab2a06e05b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
Dovecot
=======
Description
-----------
The `dovecot` role installs and configures the [Dovecot](https://www.dovecot.org/)
IMAP server.
IMAPS will be configured for Kerberos/GSSAPI authentication, as well as
plain-text username/password. A LMTP port is opened for Postfix to deliver
mail.
Global sieve scripts are provided which automatically train emails as SPAM or
or HAM whenever a user moves messages in or out of his Junk folder, using
[rspamd](../rspamd/).
This role also configures [Apache Solr](../solr/) for full-text search and
[Apache Tika](../tika/) for attachment indexing.
Variables
---------
This role **accepts** the following variables:
Variable | Default | Description
--------------------------------|-------------------------|------------
`dovecot_recipient_delimiter` | `+` | Character delimiter for email address extensions
`dovecot_default_user_quota` | `5G` | Default mailbox quota
`dovecot_quota_grace_percent` | 5 | Allow users to go a percentage over their quota
`dovecot_default_domain` | `{{ email_domain }}` | Domain used for outgoing mails (quota warnings, etc)
`dovecot_rspamd_host` ' | `{{ rspamd_host }}` | Hostname of rspamd instance
`dovecot_rspamd_password` | `{{ rspamd_password }}` | Password for rspamd instance
`dovecot_rspamd_pubkey` | `{{ rspamd_pubkey }}` | Pubkey for rspamc encryption
`dovecot_access_group` | `role-imap-access` | FreeIPA group for users allowed IMAP access (will be created)
`dovecot_lmtp_port` | 24 | LMTP port (used by Postfix)
`dovecot_quota_status_port` | 10993 | Quota status port (used by Postfix)
`dovecot_tika_port` | 9998 | Local Tika port (attachment indexing)
`dovecot_solr_port` | 8983 | Local Solr port (full-text search database)
`dovecot_max_mail_size` | `64M` | Maximum email size
`dovecot_quota_warning_percent` | `[95,90,80]` | Warn users via email when mailbox reaches quota percentage
This role **exports** the following variables:
Variable | Description
---------------------|------------
`dovecot_vmail_user` | Unix user used to store mailbox data
`dovecot_vmail_dir` | Path to mailboxes
Usage
-----
Example playbook:
````yaml
- hosts: imap_servers
roles:
- role: dovecot
vars:
dovecot_default_user_quota: 20G
dovecot_rspamd_host: rspamd.example.com
dovecot_rspamd_password: s3cret
dovecot_rspamd_pubkey: AAAAAasdf
dovecot_access_group: imap-users
````
|