dataset/seed/dovecot/README.md

---
gitea: none
include_toc: true
---


[Return to the list of application services.](../README.md)
# dovecot

## Synopsis


[Postfix and Dovecot as mail servers (Submission and IMAP).](https://www.dovecot.org/)

## Basic variables

### Général

#### Mail configuration

##### Mail domain

This family is a leadership.

| Parameter                                                                                                                                                                                                                              | Comments                                                                                 |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
| **[general.mail.domain.mail_domains](dictionaries/31_dovecot.xml)**<br/>mandatory, multiple<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Domaine de courriel géré localement.<br/>**Example:** example.net                        |
| **[general.mail.domain.imap_domainname](dictionaries/31_dovecot.xml)**<br/>mandatory<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable)        | Domaine exterieur d'accès au serveur IMAP.<br/>**Example:** imap.example.net             |
| **[general.mail.domain.submission_domainname](dictionaries/31_dovecot.xml)**<br/>mandatory<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable)  | Domaine exterieur d'accès au serveur submission.<br/>**Example:** submission.example.net |

## Variables

### Général

#### Mail configuration

##### Mail domain

This family is a leadership.

| Parameter                                                                                                                                                                                                              | Comments                                                                                                                                      |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.mail.mail_crt_provider](dictionaries/31_dovecot.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Autorité de certification signant les certificats des domaines extérieurs.<br/>**Choices:**<br/>- `self-signed` ← default<br/>- `letsencrypt` |

## Variables for expert

### Général

#### Annuaire OpenLDAP

##### Client

| Parameter                                                                                                                                                                                                                            | Comments                                                                                          |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
| **[general.ldap.client.ldapclient_family](dictionaries/31_dovecot.xml)**<br/>mandatory<br/>**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable)     | Nom de la famille LDAP.<br/>**Default:** all                                                      |
| **[general.ldap.client.ldapclient_base_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable)   | Base DN de l'annuaire.<br/>**Default:** *calculated*                                              |
| **[general.ldap.client.ldapclient_search_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Base DN de l'annuaire des utilisateurs.<br/>**Default:** *calculated*                             |
| **[general.ldap.client.ldapclient_group_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable)  | Base DN de l'annuaire des groupes.<br/>**Default:** *calculated*                                  |
| **[general.ldap.client.ldapclient_user_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable)   | Base DN de l'annuaire des utilisateurs n'appartenant à une famille.<br/>**Default:** *calculated* |



## Requirements services

### Mandatories

- LocalDNS: [nsd-local](../nsd-local/README.md)
- SMTP: [postfix-relay](../postfix-relay/README.md)
- LDAP: [openldap](../openldap/README.md)
- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md)
- OAuth2: [lemonldap](../lemonldap/README.md)

### Optionals

- Journald: [vector](../vector/README.md)

**bold**: provider is mandatory

## Example

Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.

```
dovecot:
  applicationservice: dovecot
  provider_zone: imap
  zones_name:
    - ldap
    - localdns
    - oauth2
    - reverseproxy
    - smtp
  values:
    general.mail.domain.mail_domains:
      - example.net
    general.mail.domain.imap_domainname:
      '0': imap.example.net
    general.mail.domain.submission_domainname:
      '0': submission.example.net
```

## Dependances

- [base-fedora-36](../base-fedora-36/README.md)
  - [base-fedora](../base-fedora/README.md)
    - [systemd](../systemd/README.md)
      - [base-machine](../base-machine/README.md)
        - [base](../base/README.md)
        - [dns-local](../dns-local/README.md)
        - [pki-tls](../pki-tls/README.md)
      - [journald](../journald/README.md)
      - [resolved](../resolved/README.md)
- [relay-lmtp-client](../relay-lmtp-client/README.md)
  - [relay-mail-client](../relay-mail-client/README.md)
- [ldap-client](../ldap-client/README.md)
- [oauth2-client](../oauth2-client/README.md)
- [nginx-https](../nginx-https/README.md)
  - [nginx-common](../nginx-common/README.md)
  - [reverse-proxy-client](../reverse-proxy-client/README.md)

## Useful for service

[roundcube](../roundcube/README.md)