diff options
| author | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-12 08:48:44 -0500 |
|---|---|---|
| committer | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-12 08:48:44 -0500 |
| commit | cffd694f5d8e30134e1c7f2081b933bb02ed545f (patch) | |
| tree | 6d33ba8208d76996312ce4f53cf9f0d18289966a | |
| parent | aa46979213e0a8b75525327086acbce275f1b871 (diff) | |
| download | selfhosted-cffd694f5d8e30134e1c7f2081b933bb02ed545f.tar.gz selfhosted-cffd694f5d8e30134e1c7f2081b933bb02ed545f.zip | |
evolution: add docs
| -rw-r--r-- | roles/evolution/README.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/roles/evolution/README.md b/roles/evolution/README.md new file mode 100644 index 0000000..938d30b --- /dev/null +++ b/roles/evolution/README.md @@ -0,0 +1,45 @@ +Evolution +========= + +Description +----------- + +The `evolution` role configures [autoconfig](https://wiki.gnome.org/Apps/Evolution/Autoconfig) +files for the [Evolution](https://wiki.gnome.org/Apps/Evolution) mail/calendar +application. + +When a user starts Evolution for the first time, accounts will automatically be +added for the local IMAP, SMTP, CalDAV, and CardDAV servers, +using GSSAPI for authentication. + + +Variables +--------- + +This role **accepts** the following variables: + +Variable | Default | Description +------------------------------|----------------------|------------ +`evolution_mail_account_name` | `{{ organization }}` | Name of the mail account +`evolution_dav_account_name` | `{{ organization }}` | Name of the CalDAV/CardDAV account +`evolution_email_domain` | `{{ email_domain }}` | Domain used to construct the email address from `$USER` +`evolution_imap_host` | `{{ imap_host }}` | IMAP hostname +`evolution_smtp_host` | `{{ mail_host }}` | SMTP hostname +`evolution_dav_host` | `dav.{{ domain }}` | CalDAV/CardDAV hostname + + +Usage +----- + +Example playbook: + +````yaml +- hosts: linux_desktops + roles: + - role: evolution + vars: + evolution_imap_host: imap.example.com + evolution_smtp_host: smtp.example.com + evolution_dav_host: dav.example.com + evolution_email_domain: example.com +```` |