dataset/seed/dovecot/README.md

Table of Contents

• dovecot
• Synopsis
• Example
• Basic variables
• General
• Mail configuration
• Mail domain
• Variables
• General
• OpenLDAP directory
• Client
• Requirements services
• Mandatories
• Optionals
• Dependances
• Useful for service

Return to the list of application services.

dovecot

Synopsis

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

This application service provides email server. Two servers are used: Dovecot as IMAP server and Postfix as submission server. In addition, an auto-detection file of the email configuration is set up.

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

Basic variables

General

Mail configuration

Configure IMAP servers and submission to access email accounts and send emails.

Mail domain

This family is a leadership.

Parameter	Comments
general.mail.domain.mail_domains mandatory, multiple Type: domainname	Final destination email address. These domain names are the domain names for emails (user@example.net) and for auto configuration of email clients (https://example.net/.well-known/autoconfig/mail/config-v1.1.xml). Example: example.net
general.mail.domain.imap_domainname mandatory Type: domainname	External IMAP server address. Matches TLS connection’s SNI name, if it’s sent by the client. For some email clients, use in DNS configuration a line like "_submissions._tcp IN SRV 1 587 imap.example.net.". Example: imap.example.net
general.mail.domain.submission_domainname mandatory Type: domainname	External submission server address. Matches TLS connection’s SNI name, if it’s sent by the client. For some email clients, add in DNS configuration a line like "_imaps._tcp IN SRV 0 1 993 submission.example.net.". Example: submission.example.net

Parameter	Comments
general.mail.mail_crt_provider mandatory Type: choice	Type of certificate autority signing external IMAP and submission domain certificates. The certificate can be self-signed (therefore invalid by default for the client) or obtained via the Let's Encrypt service (generally valid for the client). Choices: - self-signed ← default - letsencrypt

Variables

General

OpenLDAP directory

Client

Parameter	Comment
general.ldap.client.ldapclient_family mandatory Type: unix_user	Restrict service configuration for a LDAP family. "all" for all families. Default: all

Requirements services

Mandatories

• LocalDNS: DNS forwarder for local domain name.
• SMTP: Create a SMTP relay account and authorize sending email.
• LDAP: Create account and connexion to a LDAP server.
• ReverseProxy: Register to service to a reverse proxy server.
• OAuth2: Remote clients needing to verify OAuth2 account.

Optionals

• Journald: Concentrate journal messages on one host.

Dependances

• base-fedora-36: Base information of a Fedora 36.
  • base-fedora: Base information of a Fedora.
    • systemd: Systemd, a system and service manager.
      • base-machine: Base information for a machine.
        • base: Base of all application services.
        • dns-local: DNS client with access to local zones.
        • pki-tls: Autosign PKI or Let's encrypt support for TLS certificates.
      • journald: Journald.
      • resolved: Resolved.
• relay-lmtp-client: Application service needs interact with a Postfix server with LMTP protocol.
  • relay-mail-client: Client SMTP.
• ldap-client: Application service needs interact with a LDAP server.
• oauth2-client: Application service needs interact with a Oauth2 server.
• nginx-https: Nginx as HTTPS web site.
  • nginx-common: Nginx common configuration.
  • reverse-proxy-client: Application service needs interact with a a reverse proxy server.

Useful for service

roundcube: Roundcube, a webmail.