dataset/seed/dovecot/README.md

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

# dovecot

## Synopsis

Postfix and Dovecot as mail servers (Submission and IMAP).

[For more informations](https://www.dovecot.org/)

## Basic variables

### Général (*general*)

#### Mail configuration (*general.mail*)

##### Mail domain (*general.mail.domain*)


This a family is a leadership.

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

- [+]: variable is multiple
- **bold**: variable is mandatory

## Variables

### Général (*general*)

#### Annuaire OpenLDAP (*general.ldap*)

##### Client (*general.ldap.client*)


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

#### Reverse proxy (*general.revprox*)

##### Point d'entrée des clients (*general.revprox.revprox_client*)


This a family is a leadership.

| Description                                                                                                                                       | Type                                                                                                                       | Values       | Example             | Supplier                   |
|---------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|--------------|---------------------|----------------------------|
| **Nom de domaine exterieur du serveur** (*[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/31_dovecot.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | <calculated> | service.example.net | ReverseProxy:external      |
| **Nom de l'arborescence racine du site** (*[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)*)         | [filename](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable)   | <calculated> |                     | ReverseProxy:location      |
| Taille maximum du corps (*[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)*)                     | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable)     |              |                     | ReverseProxy:max_body_size |

#### Mail configuration (*general.mail*)


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

- [+]: variable is multiple
- **bold**: variable is mandatory

## Variables for expert

### Général (*general*)

#### NGINX (*general.nginx*)


Paramétrage global de NGINX
##### Client (*general.ldap.client*)


| Description                                                                                                                           | Type                                                                                                                   |   Values | Choices             |
|---------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|----------|---------------------|
| **Longueur maximum pour un nom de domaine** (*[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)*)                     | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |      128 | 128<br />64<br />32 |
| **Taille maximale des données reçues par la méthode POST (en Mo)** (*[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |       32 |                     |

- [+]: variable is multiple
- **bold**: variable is mandatory

## Examples

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

With minimum providers:

```
dovecot:
  applicationservice: dovecot
  provider_zone: imap
  zones_name:
    - ldap
    - localdns
    - reverseproxy
    - smtp
    - lmtp
    - oauth2
  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
```

With all providers:

```
dovecot:
  applicationservice: dovecot
  provider_zone: imap
  zones_name:
    - journald
    - ldap
    - localdns
    - reverseproxy
    - smtp
    - lmtp
    - oauth2
  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)

## Supplier

[imap-client](../imap-client/README.md)

[All applications services for this dataset.](../README.md)