stove/dataset
3
0
Fork 1
Code Issues 2 Pull requests Projects Releases Wiki Activity
dataset/seed/mailman/README.md

207 lines
17 KiB
Markdown
Raw Normal View History

docs for application services
2022-12-24 13:01:51 +01:00
---
gitea: none
include_toc: true
---
# mailman
update doc
2023-08-02 09:26:54 +02:00
## Synopsis
docs for application services
2022-12-24 13:01:51 +01:00
GNU Mailman, managing electronic mail discussion and e-newsletter lists.
[For more informations](https://www.list.org)
update doc
2023-08-02 09:26:54 +02:00
## Basic variables
#### Client SMTP (*general.smtp*)
| Description | Type | Supplier |
|----------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------|
| **Nom de domaine du serveur SMTP** (*[smtp_relay_address](dictionaries/20_smtp_client.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | SMTP |
#### PostgreSQL (*general.postgresql*)
| Description | Type | Supplier |
|------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------|
| **Nom de domaine du serveur PostgreSQL** (*[pg_client_server_domainname](dictionaries/23_postgresql.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Postgresql |
#### OAuth2 client (*general.oauth2_client*)
| Description | Type | Supplier | Provider |
|----------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------|------------------------|
| **OAuth2 server domain name** (*[oauth2_client_server_domainname](dictionaries/30_oauth2_client.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 | |
| **OAuth2 server external domain name** (*[oauth2_server_domainname](dictionaries/30_oauth2_client.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | OAuth2:external_domain |
#### Gestionnaire de liste (*general.mailman*)
| Description | Type | Example |
|--------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------------|
| **Nom de domaine des listes** (*[mailman_domains](dictionaries/31_mailman.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | list.example.net |
#### Listes du domaine (*mailman.list_*)
This a dynamic family generated from the variable "general.mailman.mailman_domains".
| Description | Type |
|--------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
| **Nom des listes ** (*[name_](extras/mailman/20_mailman.xml)*) [+] | [unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Variables
### Général (*general*)
| Description | Type | Values | Supplier |
|---------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|--------------|------------|
| **Nom de domaine du serveur LMTP** (*[lmtp_relay_address](dictionaries/30_lmtp.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | <calculated> | LMTP |
#### systemd-journald (*general.journald*)
| Description | Type | Supplier | Values |
|--------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|---------------|--------------|
| *[journal_client_server_domainname](dictionaries/20_journald.xml)* | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Journald | |
| *[journal_host_name](dictionaries/20_journald.xml)* | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Journald:host | <calculated> |
#### NGINX (*general.nginx*)
Paramétrage global de NGINX
| Description | Help | Type |
|--------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
| Nom de domaine du serveur mandataire inverse par défaut (*[nginx_default](dictionaries/21_nginx.xml)*) | Si un client accède au serveur avec un nom de domaine non déclaré, le flux est redirigé vers ce domaine | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
##### Point d'entrée des clients (*general.revprox.revprox_client*)
This a family is a leadership.
| Description | Type | Supplier |
|------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|----------------------------|
| **Nom de l'arborescence racine du site** (*[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) | ReverseProxy:location |
| Taille maximum du corps (*[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 |
#### PostgreSQL (*general.postgresql*)
| Description | Values | Supplier | Type |
|------------------------------------------------------------------------------|--------------|---------------------|--------------------------------------------------------------------------------------------------------------------------|
| **Client username** (*[pg_client_username](dictionaries/23_postgresql.xml)*) | <calculated> | Postgresql:username | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **Client password** (*[pg_client_password](dictionaries/23_postgresql.xml)*) | <calculated> | Postgresql:password | [password](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **Client database** (*[pg_client_database](dictionaries/23_postgresql.xml)*) | <calculated> | Postgresql:database | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
#### OAuth2 client (*general.oauth2_client*)
| Description | Values | Example | Supplier | Type |
|--------------------------------------------------------------------------------------------|-------------------------------|---------------------|--------------------|-----------------------------------------------------------------------------------------------------------------------------|
| **OAuth2 client name** (*[oauth2_client_name](dictionaries/31_mailman.xml)*) | Liste de distribution | example | OAuth2:name | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **OAuth2 client description** (*[oauth2_client_description](dictionaries/31_mailman.xml)*) | Liste de distribution Mailman | Example description | OAuth2:description | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| OAuth2 URL to valid login (*[oauth2_client_login](dictionaries/30_oauth2_client.xml)*) | | | OAuth2:login | [web_address](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **OAuth2 category** (*[oauth2_client_category](dictionaries/31_mailman.xml)*) | Développement | | OAuth2:category | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **OAuth2 logo** (*[oauth2_client_logo](dictionaries/31_mailman.xml)*) | silique_email.png | | OAuth2:logo | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
##### external (*general.oauth2_client.external*)
| Description | Type | Values | Supplier |
|------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|--------------|-----------------|
| **OAuth2 client external** (*[oauth2_client_external](dictionaries/31_mailman.xml)*) [+] | [web_address](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | <calculated> | OAuth2:external |
| **OAuth2 family** (*[oauth2_client_family](dictionaries/30_oauth2_client.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | users | OAuth2:family |
#### Gestionnaire de liste (*general.mailman*)
| Description | Type |
|-------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|
| Courriel du gestionnaire de liste du site (*[mailman_mail_owner](dictionaries/31_mailman.xml)*) | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Variables for expert
#### NGINX (*general.nginx*)
Paramétrage global de NGINX
| Description | Type | Values | Choices |
|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|----------|---------------------|
| **Longueur maximum pour un nom de domaine** (*[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)** (*[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 | |
##### Point d'entrée des clients (*general.revprox.revprox_client*)
This a family is a leadership.
| Description | Type | Example | Supplier |
|---------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|---------------------|-----------------------|
| **Nom de domaine exterieur du serveur** (*[revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | service.example.net | ReverseProxy:external |
- [+]: variable is multiple
- **bold**: variable is mandatory
update doc
2023-08-01 15:13:17 +02:00
## Examples
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
```
mailman:
applicationservice: mailman
zones_name:
- localdns
- reverseproxy
- smtp
- lmtp
- oauth2
- postgresql
update doc
2023-08-02 09:26:54 +02:00
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
general.mailman.mailman_domains:
- list.example.net
update doc
2023-08-01 15:13:17 +02:00
```
With all providers:
```
mailman:
applicationservice: mailman
zones_name:
- journald
- localdns
- reverseproxy
- smtp
- lmtp
- oauth2
- postgresql
update doc
2023-08-02 09:26:54 +02:00
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
general.mailman.mailman_domains:
- list.example.net
update doc
2023-08-01 15:13:17 +02:00
```
docs for application services
2022-12-24 13:01:51 +01:00
## Dependances
- [base-debian-bullseye](../base-debian-bullseye/README.md)
- [base-debian](../base-debian/README.md)
- [systemd](../systemd/README.md)
- [base-machine](../base-machine/README.md)
- [base](../base/README.md)
- [dns-local](../dns-local/README.md)
TLS
2023-02-14 14:24:16 +01:00
- [pki-tls](../pki-tls/README.md)
doc: update README files
2023-06-29 18:56:46 +02:00
- [journald](../journald/README.md)
update doc
2023-07-31 18:41:59 +02:00
- [resolved](../resolved/README.md)
docs for application services
2022-12-24 13:01:51 +01:00
- [postgresql-client](../postgresql-client/README.md)
- [relay-lmtp-client](../relay-lmtp-client/README.md)
- [relay-mail-client](../relay-mail-client/README.md)
- [reverse-proxy-client](../reverse-proxy-client/README.md)
- [nginx-https](../nginx-https/README.md)
- [nginx-common](../nginx-common/README.md)
- [reverse-proxy-client](../reverse-proxy-client/README.md)
- [oauth2-client](../oauth2-client/README.md)
used by external dataset
2023-02-14 14:43:41 +01:00
[All applications services for this dataset.](../README.md)
Reference in a new issue Copy permalink