dataset/seed/mailman/README.md

Table of Contents

• mailman
• Synopsis
• Example
• Basic variables
• General
• Reverse proxy
• Clients configuration
• Gestionnaire de liste
• Mailman
• Listes du domaine suffix value
• Variables
• General
• Reverse proxy
• Clients configuration
• OAuth2 client
• external
• Variables for expert
• General
• NGINX
• Requirements services
• Mandatories
• Optionals
• Dependances

Return to the list of application services.

mailman

Synopsis

GNU Mailman, managing electronic mail discussion and e-newsletter lists.

Example

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

mailman:
  applicationservice: mailman
  zones_name:
    - localdns
    - oauth2
    - postgresql
    - reverseproxy
    - smtp
  values:
    general.revprox.revprox_client.revprox_client_external_domainnames:
      - service.example.net
    general.mailman.mailman_mail_owner: admin@example.net
    general.mailman.mailman_domains:
      - list.example.net

Basic variables

General

Reverse proxy

Clients configuration

This family is a leadership.

Parameter	Comment
general.revprox.revprox_client.revprox_client_external_domainnames mandatory, multiple Type: domainname	Service external domain name. Example: service.example.net
general.revprox.revprox_client.revprox_client_location mandatory Type: filename	URI to route request to the correct service. Default: /

Gestionnaire de liste

Parameter	Comment
general.mailman.mailman_mail_owner mandatory Type: mail	Courriel du gestionnaire de liste du site. Example: admin@example.net
general.mailman.mailman_domains mandatory, multiple Type: domainname	Nom de domaine des listes. Example: list.example.net

Mailman

Listes du domaine suffix value

This a dynamic family generated from the variable "general.mailman.mailman_domains".

Parameter	Comments
mailman.list_suffix value.name_suffix value mandatory, multiple Type: unix_user	Nom des listes suffix value.

Variables

General

Reverse proxy

Clients configuration

This family is a leadership.

Parameter	Comment
general.revprox.revprox_client.revprox_client_max_body_size Type: string	The maximum allowed size of the client request body.

OAuth2 client

Parameter	Comment
general.oauth2_client.oauth2_client_name mandatory Type: string	OAuth2 client name. Default: Liste de distribution Example: example
general.oauth2_client.oauth2_client_description mandatory Type: string	OAuth2 client description. Default: Liste de distribution Mailman Example: Example description
general.oauth2_client.oauth2_client_login Type: web_address	OAuth2 URL to valid login.

external

Parameter	Comments
general.oauth2_client.external.oauth2_client_external mandatory, multiple Type: web_address	OAuth2 client external. Default: calculated
general.oauth2_client.external.oauth2_client_family mandatory Type: string	OAuth2 family. Default: users

Parameter	Comment
general.oauth2_client.oauth2_client_category mandatory Type: string	OAuth2 category. Default: Développement
general.oauth2_client.oauth2_client_logo mandatory Type: string	OAuth2 logo. Default: silique_email.png

Variables for expert

General

NGINX

Parameter	Comment
general.nginx.nginx_hash_bucket_size mandatory Type: choice	The bucket size for the server names hash tables. Choices: - 128 ← default - 64 - 32
general.nginx.nginx_post_max_size mandatory Type: number	The maximum allowed size of the client request body. This value is in Mb. Default: 32

Requirements services

Mandatories

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

Optionals

• Journald: Concentrate journal messages on one host.

Dependances

• base-debian-bullseye: Base information of a Debian Bulleye server.
  • base-debian: Base information of a Debian server.
    • 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.
• postgresql-client: Application service needs interact with a Postgresql server.
• relay-lmtp-client: Application service needs interact with a Postfix server with LMTP protocol.
  • relay-mail-client: Client SMTP.
• reverse-proxy-client: Application service needs interact with a a reverse proxy 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.
• oauth2-client: Application service needs interact with a Oauth2 server.