diff --git a/seed/apache/README.md b/seed/apache/README.md index 9d734927..61ef55f7 100644 --- a/seed/apache/README.md +++ b/seed/apache/README.md @@ -5,34 +5,12 @@ include_toc: true # apache -## Description +## Synopsis Apache as web server. [For more informations](https://httpd.apache.org/) -## Examples - -Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. - -``` -apache: - applicationservice: apache - zones_name: - - reverseproxy -``` - -``` -apache: - applicationservice: apache - zones_name: - - reverseproxy -``` - -## Dependances - -- [reverse-proxy-client](../reverse-proxy-client/README.md) - ## Variables ### Général (*general*) @@ -50,6 +28,10 @@ Paramètrage avancé du serveur web Apache - [+]: variable is multiple - **bold**: variable is mandatory +## Dependances + +- [reverse-proxy-client](../reverse-proxy-client/README.md) + ## Used by [nextcloud](../nextcloud/README.md) diff --git a/seed/apache/applicationservice.yml b/seed/apache/applicationservice.yml index 11682e47..6ba1732c 100644 --- a/seed/apache/applicationservice.yml +++ b/seed/apache/applicationservice.yml @@ -3,4 +3,3 @@ description: Apache as web server website: https://httpd.apache.org/ depends: - reverse-proxy-client -service: true diff --git a/seed/base-debian-bullseye/README.md b/seed/base-debian-bullseye/README.md index 88b74434..790189df 100644 --- a/seed/base-debian-bullseye/README.md +++ b/seed/base-debian-bullseye/README.md @@ -5,7 +5,7 @@ include_toc: true # base-debian-bullseye -## Description +## Synopsis Base information of a Debian Bulleye server. diff --git a/seed/base-debian/README.md b/seed/base-debian/README.md index dbc7fe76..ad5cd36f 100644 --- a/seed/base-debian/README.md +++ b/seed/base-debian/README.md @@ -5,7 +5,7 @@ include_toc: true # base-debian -## Description +## Synopsis Base information of a Debian server. diff --git a/seed/base-fedora-35/README.md b/seed/base-fedora-35/README.md index ae84cc8a..3946f2b8 100644 --- a/seed/base-fedora-35/README.md +++ b/seed/base-fedora-35/README.md @@ -5,7 +5,7 @@ include_toc: true # base-fedora-35 -## Description +## Synopsis Base information of a Fedora 35. diff --git a/seed/base-fedora-36/README.md b/seed/base-fedora-36/README.md index 52691035..bb3b08e8 100644 --- a/seed/base-fedora-36/README.md +++ b/seed/base-fedora-36/README.md @@ -5,7 +5,7 @@ include_toc: true # base-fedora-36 -## Description +## Synopsis Base information of a Fedora 36. diff --git a/seed/base-fedora-37/README.md b/seed/base-fedora-37/README.md index c6e0d141..0e336e66 100644 --- a/seed/base-fedora-37/README.md +++ b/seed/base-fedora-37/README.md @@ -5,7 +5,7 @@ include_toc: true # base-fedora-37 -## Description +## Synopsis Base information of a Fedora 37. diff --git a/seed/base-fedora-38/README.md b/seed/base-fedora-38/README.md index eb1a2e42..5db3cbfe 100644 --- a/seed/base-fedora-38/README.md +++ b/seed/base-fedora-38/README.md @@ -5,7 +5,7 @@ include_toc: true # base-fedora-38 -## Description +## Synopsis Base information of a Fedora 38. diff --git a/seed/base-fedora/README.md b/seed/base-fedora/README.md index be44494c..932ea54b 100644 --- a/seed/base-fedora/README.md +++ b/seed/base-fedora/README.md @@ -5,7 +5,7 @@ include_toc: true # base-fedora -## Description +## Synopsis Base information of a Fedora. diff --git a/seed/base-machine/README.md b/seed/base-machine/README.md index d32ffb39..00a4bbbb 100644 --- a/seed/base-machine/README.md +++ b/seed/base-machine/README.md @@ -5,16 +5,10 @@ include_toc: true # base-machine -## Description +## Synopsis Base information for a machine. -## Dependances - -- [base](../base/README.md) -- [dns-local](../dns-local/README.md) -- [pki-tls](../pki-tls/README.md) - ## Variables ### Machine (*machine*) @@ -27,6 +21,12 @@ Base information for a machine. - [+]: variable is multiple - **bold**: variable is mandatory +## Dependances + +- [base](../base/README.md) +- [dns-local](../dns-local/README.md) +- [pki-tls](../pki-tls/README.md) + ## Used by [systemd](../systemd/README.md) diff --git a/seed/base/README.md b/seed/base/README.md index cf694db8..b8308440 100644 --- a/seed/base/README.md +++ b/seed/base/README.md @@ -5,7 +5,7 @@ include_toc: true # base -## Description +## Synopsis Base of all application services. diff --git a/seed/base/funcs/base.py b/seed/base/funcs/base.py index acbeed06..95f02e44 100644 --- a/seed/base/funcs/base.py +++ b/seed/base/funcs/base.py @@ -60,3 +60,12 @@ def get_zones_info(zones: dict, continue ret.append(val) return ret + + +def get_first_value(lst: list): + if lst: + if isinstance(lst[0], list): + if lst[0] and lst[0][0]: + return lst[0][0] + else: + return lst[0] diff --git a/seed/dns-external/README.md b/seed/dns-external/README.md index 2707d752..016bb9fb 100644 --- a/seed/dns-external/README.md +++ b/seed/dns-external/README.md @@ -5,7 +5,7 @@ include_toc: true # dns-external -## Description +## Synopsis DNS client with resolution on all zones (especially outside). diff --git a/seed/dns-local/README.md b/seed/dns-local/README.md index c039e27f..78203c7b 100644 --- a/seed/dns-local/README.md +++ b/seed/dns-local/README.md @@ -5,7 +5,7 @@ include_toc: true # dns-local -## Description +## Synopsis DNS client with access to local zones. diff --git a/seed/dovecot/README.md b/seed/dovecot/README.md index 2a464a07..c46de9ab 100644 --- a/seed/dovecot/README.md +++ b/seed/dovecot/README.md @@ -5,66 +5,12 @@ include_toc: true # dovecot -## Description +## Synopsis Postfix and Dovecot as mail servers (Submission and IMAP). [For more informations](https://www.dovecot.org/) -## 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 -``` - -With all providers: - -``` -dovecot: - applicationservice: dovecot - provider_zone: imap - zones_name: - - journald - - ldap - - localdns - - reverseproxy - - smtp - - lmtp - - oauth2 -``` - -## 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) - ## Variables ### Général (*general*) @@ -94,11 +40,11 @@ dovecot: This a family is a leadership. -| Description | Type | Supplier | -|---------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|---------------| -| **Domaine de courriel géré localement** (*[mail_domains](dictionaries/26_dovecot.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | LMTP:criteria | -| *[**imap_domainname**](dictionaries/26_dovecot.xml)* | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | -| *[**submission_domainname**](dictionaries/26_dovecot.xml)* | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | +| Description | Example | Type | Supplier | +|--------------------------------------------------------------------------------------------------------------|------------------------|----------------------------------------------------------------------------------------------------------------------------|---------------| +| **Domaine de courriel géré localement** (*[mail_domains](dictionaries/26_dovecot.xml)*) [+] | example.net | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | LMTP:criteria | +| **Domaine exterieur d'accès au serveur IMAP** (*[imap_domainname](dictionaries/26_dovecot.xml)*) | imap.example.net | [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** (*[submission_domainname](dictionaries/26_dovecot.xml)*) | submission.example.net | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | #### IMAP mail server (*general.dovecot*) @@ -125,6 +71,78 @@ This a family is a leadership. - [+]: 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 + general.oauth2_client.oauth2_client_name: example + general.oauth2_client.oauth2_client_description: Example description +``` + +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 + general.oauth2_client.oauth2_client_name: example + general.oauth2_client.oauth2_client_description: Example description +``` + +## 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) diff --git a/seed/dovecot/dictionaries/26_dovecot.xml b/seed/dovecot/dictionaries/26_dovecot.xml index 28971b21..07eb1c00 100644 --- a/seed/dovecot/dictionaries/26_dovecot.xml +++ b/seed/dovecot/dictionaries/26_dovecot.xml @@ -65,10 +65,10 @@ - + autosigne diff --git a/seed/forgejo/README.md b/seed/forgejo/README.md index ac712c21..8443ce05 100644 --- a/seed/forgejo/README.md +++ b/seed/forgejo/README.md @@ -5,63 +5,12 @@ include_toc: true # forgejo -## Description +## Synopsis Forgejo, a community managed lightweight code hosting solution. [For more informations](https://forgejo.org/) -## Examples - -Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. - -With minimum providers: - -``` -forgejo: - applicationservice: forgejo - zones_name: - - localdns - - reverseproxy - - smtp - - redis - - oauth2 - - postgresql -``` - -With all providers: - -``` -forgejo: - applicationservice: forgejo - zones_name: - - journald - - localdns - - reverseproxy - - smtp - - redis - - oauth2 - - postgresql -``` - -## Dependances - -- [base-fedora-38](../base-fedora-38/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) -- [postgresql-client](../postgresql-client/README.md) -- [reverse-proxy-client](../reverse-proxy-client/README.md) -- [relay-mail-client](../relay-mail-client/README.md) -- [redis-client](../redis-client/README.md) - - [redis-common](../redis-common/README.md) -- [oauth2-client](../oauth2-client/README.md) - ## Variables ### Général (*general*) @@ -82,10 +31,10 @@ forgejo: Git forge Forgejo -| Description | Values | Type | -|---------------------------------------------------------------------------------------------------------------|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| -| **Titre de la forge** (*[forgejo_title](dictionaries/31_forgejo.xml)*) | Forgejo : Au-delà du développement. Nous forgeons. | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | -| **Les courriels sont envoyés à partir de cet adresse** (*[forgejo_mail_sender](dictionaries/31_forgejo.xml)*) | | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | +| Description | Values | Example | Type | +|---------------------------------------------------------------------------------------------------------------|----------------------------------------------------|-------------------|------------------------------------------------------------------------------------------------------------------------| +| **Titre de la forge** (*[forgejo_title](dictionaries/31_forgejo.xml)*) | Forgejo : Au-delà du développement. Nous forgeons. | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | +| **Les courriels sont envoyés à partir de cet adresse** (*[forgejo_mail_sender](dictionaries/31_forgejo.xml)*) | | admin@example.net | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | #### revprox (*general.revprox*) @@ -127,6 +76,65 @@ Git forge Forgejo - [+]: 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: + +``` +forgejo: + applicationservice: forgejo + zones_name: + - localdns + - reverseproxy + - smtp + - redis + - oauth2 + - postgresql + values: + general.revprox.revprox_client.revprox_client_external_domainnames: + - service.example.net + general.forgejo.forgejo_mail_sender: admin@example.net +``` + +With all providers: + +``` +forgejo: + applicationservice: forgejo + zones_name: + - journald + - localdns + - reverseproxy + - smtp + - redis + - oauth2 + - postgresql + values: + general.revprox.revprox_client.revprox_client_external_domainnames: + - service.example.net + general.forgejo.forgejo_mail_sender: admin@example.net +``` + +## Dependances + +- [base-fedora-38](../base-fedora-38/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) +- [postgresql-client](../postgresql-client/README.md) +- [reverse-proxy-client](../reverse-proxy-client/README.md) +- [relay-mail-client](../relay-mail-client/README.md) +- [redis-client](../redis-client/README.md) + - [redis-common](../redis-common/README.md) +- [oauth2-client](../oauth2-client/README.md) + ## Used by [gitea](../gitea/README.md) diff --git a/seed/forgejo/dictionaries/31_forgejo.xml b/seed/forgejo/dictionaries/31_forgejo.xml index 3e8799fa..4391957c 100644 --- a/seed/forgejo/dictionaries/31_forgejo.xml +++ b/seed/forgejo/dictionaries/31_forgejo.xml @@ -23,7 +23,7 @@ Forgejo : Au-delà du développement. Nous forgeons. - + diff --git a/seed/host-systemd-machined/README.md b/seed/host-systemd-machined/README.md index ec961830..76b7de10 100644 --- a/seed/host-systemd-machined/README.md +++ b/seed/host-systemd-machined/README.md @@ -5,16 +5,12 @@ include_toc: true # host-systemd-machined -## Description +## Synopsis Host with machine started in Systemd Machined environment. [For more informations](https://www.freedesktop.org/wiki/Software/systemd/machined/) -## Dependances - -- [base](../base/README.md) - ## Variables ### Général (*general*) @@ -53,6 +49,10 @@ This a family is a leadership. - [+]: variable is multiple - **bold**: variable is mandatory +## Dependances + +- [base](../base/README.md) + ## Supplier [provider-systemd-machined](../provider-systemd-machined/README.md) diff --git a/seed/imap-client/README.md b/seed/imap-client/README.md index c198f3fc..83ad5091 100644 --- a/seed/imap-client/README.md +++ b/seed/imap-client/README.md @@ -5,7 +5,7 @@ include_toc: true # imap-client -## Description +## Synopsis Application service needs interact with an IMAP server. diff --git a/seed/journald/README.md b/seed/journald/README.md index 8ce007b5..23f28883 100644 --- a/seed/journald/README.md +++ b/seed/journald/README.md @@ -5,7 +5,7 @@ include_toc: true # journald -## Description +## Synopsis Journald. diff --git a/seed/journald_remote/README.md b/seed/journald_remote/README.md index c750b358..609b1d99 100644 --- a/seed/journald_remote/README.md +++ b/seed/journald_remote/README.md @@ -5,7 +5,7 @@ include_toc: true # journald_remote -## Description +## Synopsis Journald remote. diff --git a/seed/ldap-client/README.md b/seed/ldap-client/README.md index 604ed535..77e032e4 100644 --- a/seed/ldap-client/README.md +++ b/seed/ldap-client/README.md @@ -5,7 +5,7 @@ include_toc: true # ldap-client -## Description +## Synopsis Application service needs interact with a LDAP server. diff --git a/seed/lemonldap/README.md b/seed/lemonldap/README.md index 441b6750..294148d7 100644 --- a/seed/lemonldap/README.md +++ b/seed/lemonldap/README.md @@ -5,60 +5,12 @@ include_toc: true # lemonldap -## Description +## Synopsis LemonLDAP, a Web Single Sign On and Access Management. [For more informations](https://lemonldap-ng.org/) -## Examples - -Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. - -With minimum providers: - -``` -lemonldap: - applicationservice: lemonldap - provider_zone: oauth2 - zones_name: - - ldap - - localdns - - reverseproxy - - smtp -``` - -With all providers: - -``` -lemonldap: - applicationservice: lemonldap - provider_zone: oauth2 - zones_name: - - journald - - ldap - - localdns - - reverseproxy - - smtp -``` - -## Dependances - -- [ldap-client](../ldap-client/README.md) -- [relay-mail-client](../relay-mail-client/README.md) -- [nginx-https](../nginx-https/README.md) - - [nginx-common](../nginx-common/README.md) - - [reverse-proxy-client](../reverse-proxy-client/README.md) -- [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) - - [pki-tls](../pki-tls/README.md) - - [journald](../journald/README.md) - - [resolved](../resolved/README.md) - ## Variables ### Général (*general*) @@ -73,10 +25,10 @@ lemonldap: Configuration de la solution d'authentification unique LemonLDAP::NG -| Description | Type | Values | -|------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|----------| -| **Nombre de processus dédié à LemonLdap (équivalent au nombre de processeurs)** (*[lemon_proc](dictionaries/70_lemonldap_ng.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 1 | -| **Courriel de l'administrateur** (*[lemon_mail_admin](dictionaries/70_lemonldap_ng.xml)*) | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | +| Description | Type | Values | Example | +|------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|----------|-------------------| +| **Nombre de processus dédié à LemonLdap (équivalent au nombre de processeurs)** (*[lemon_proc](dictionaries/70_lemonldap_ng.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 1 | | +| **Courriel de l'administrateur** (*[lemon_mail_admin](dictionaries/70_lemonldap_ng.xml)*) | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | admin@example.net | #### ldap (*general.ldap*) @@ -108,6 +60,62 @@ This a family is a leadership. - [+]: 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: + +``` +lemonldap: + applicationservice: lemonldap + provider_zone: oauth2 + zones_name: + - ldap + - localdns + - reverseproxy + - smtp + values: + general.revprox.revprox_client.revprox_client_external_domainnames: + - service.example.net + general.lemonldap.lemon_mail_admin: admin@example.net +``` + +With all providers: + +``` +lemonldap: + applicationservice: lemonldap + provider_zone: oauth2 + zones_name: + - journald + - ldap + - localdns + - reverseproxy + - smtp + values: + general.revprox.revprox_client.revprox_client_external_domainnames: + - service.example.net + general.lemonldap.lemon_mail_admin: admin@example.net +``` + +## Dependances + +- [ldap-client](../ldap-client/README.md) +- [relay-mail-client](../relay-mail-client/README.md) +- [nginx-https](../nginx-https/README.md) + - [nginx-common](../nginx-common/README.md) + - [reverse-proxy-client](../reverse-proxy-client/README.md) +- [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) + - [pki-tls](../pki-tls/README.md) + - [journald](../journald/README.md) + - [resolved](../resolved/README.md) + ## Supplier [oauth2-client](../oauth2-client/README.md) diff --git a/seed/lemonldap/dictionaries/70_lemonldap_ng.xml b/seed/lemonldap/dictionaries/70_lemonldap_ng.xml index 0023ae24..fbea94a1 100644 --- a/seed/lemonldap/dictionaries/70_lemonldap_ng.xml +++ b/seed/lemonldap/dictionaries/70_lemonldap_ng.xml @@ -32,7 +32,7 @@ 1 - + diff --git a/seed/loki/README.md b/seed/loki/README.md index 4d8fb2f5..5599f696 100644 --- a/seed/loki/README.md +++ b/seed/loki/README.md @@ -5,12 +5,26 @@ include_toc: true # loki -## Description +## Synopsis Loki, a log aggregation platform. [For more informations](https://grafana.com/) +## Variables + +### Général (*general*) + +#### loki (*general.loki*) + +| Description | Type | Provider | +|--------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------| +| **Remote loki client** (*[remotes](dictionaries/20_loki.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Loki | + + +- [+]: 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. @@ -48,20 +62,6 @@ loki: - [journald](../journald/README.md) - [resolved](../resolved/README.md) -## Variables - -### Général (*general*) - -#### loki (*general.loki*) - -| Description | Type | Provider | -|--------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------| -| **Remote loki client** (*[remotes](dictionaries/20_loki.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Loki | - - -- [+]: variable is multiple -- **bold**: variable is mandatory - ## Supplier [vector](../vector/README.md) diff --git a/seed/mailman/README.md b/seed/mailman/README.md index aa9d7c8f..7b097feb 100644 --- a/seed/mailman/README.md +++ b/seed/mailman/README.md @@ -5,75 +5,22 @@ include_toc: true # mailman -## Description +## Synopsis GNU Mailman, managing electronic mail discussion and e-newsletter lists. [For more informations](https://www.list.org) -## 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 -``` - -With all providers: - -``` -mailman: - applicationservice: mailman - zones_name: - - journald - - localdns - - reverseproxy - - smtp - - lmtp - - oauth2 - - postgresql -``` - -## 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) - - [pki-tls](../pki-tls/README.md) - - [journald](../journald/README.md) - - [resolved](../resolved/README.md) -- [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) - ## Variables ### Général (*general*) #### 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) | -| **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) | +| Description | Type | Example | +|-------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------------| +| 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) | | +| **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 | #### oauth2_client (*general.oauth2_client*) @@ -127,4 +74,67 @@ This a dynamic family generated from the variable "general.mailman.mailman_domai - [+]: 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: + +``` +mailman: + applicationservice: mailman + zones_name: + - localdns + - reverseproxy + - smtp + - lmtp + - oauth2 + - postgresql + values: + general.revprox.revprox_client.revprox_client_external_domainnames: + - service.example.net + general.mailman.mailman_domains: + - list.example.net +``` + +With all providers: + +``` +mailman: + applicationservice: mailman + zones_name: + - journald + - localdns + - reverseproxy + - smtp + - lmtp + - oauth2 + - postgresql + values: + general.revprox.revprox_client.revprox_client_external_domainnames: + - service.example.net + general.mailman.mailman_domains: + - list.example.net +``` + +## 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) + - [pki-tls](../pki-tls/README.md) + - [journald](../journald/README.md) + - [resolved](../resolved/README.md) +- [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) + [All applications services for this dataset.](../README.md) diff --git a/seed/mailman/dictionaries/31_mailman.xml b/seed/mailman/dictionaries/31_mailman.xml index 8920b5f9..4c61b25f 100644 --- a/seed/mailman/dictionaries/31_mailman.xml +++ b/seed/mailman/dictionaries/31_mailman.xml @@ -21,7 +21,7 @@ - + diff --git a/seed/mariadb-client/README.md b/seed/mariadb-client/README.md index 6683caa6..4b160b64 100644 --- a/seed/mariadb-client/README.md +++ b/seed/mariadb-client/README.md @@ -5,7 +5,7 @@ include_toc: true # mariadb-client -## Description +## Synopsis Application service needs interact with a MariaDB server. diff --git a/seed/mariadb/README.md b/seed/mariadb/README.md index b2bc4d21..dcf8c3cd 100644 --- a/seed/mariadb/README.md +++ b/seed/mariadb/README.md @@ -5,12 +5,24 @@ include_toc: true # mariadb -## Description +## Synopsis MariaDB, a relational database. [For more informations](https://mariadb.org/) +## Variables + +### Accounts (*accounts*) + +| Description | Type | Provider | +|--------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------| +| Remote clients needing an account (*[remotes](extras/accounts/00_accounts.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | MariaDB | + + +- [+]: 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. @@ -48,18 +60,6 @@ mariadb: - [journald](../journald/README.md) - [resolved](../resolved/README.md) -## Variables - -### Accounts (*accounts*) - -| Description | Type | Provider | -|--------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------| -| Remote clients needing an account (*[remotes](extras/accounts/00_accounts.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | MariaDB | - - -- [+]: variable is multiple -- **bold**: variable is mandatory - ## Supplier [mariadb-client](../mariadb-client/README.md) diff --git a/seed/nextcloud/README.md b/seed/nextcloud/README.md index dbb3fac9..7aa700ed 100644 --- a/seed/nextcloud/README.md +++ b/seed/nextcloud/README.md @@ -5,12 +5,44 @@ include_toc: true # nextcloud -## Description +## Synopsis Nextcloud, Online collaboration platform. [For more informations](https://nextcloud.com/) +## Variables + +### Général (*general*) + +#### Nextcloud (*general.nextcloud*) + +| Description | Example | Type | +|---------------------------------------------------------------------------------------------------------------------------------|-------------------|----------------------------------------------------------------------------------------------------------------------------| +| *[**nextcloud_mail_admin**](dictionaries/31_nextcloud.xml)* | admin@example.net | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | +| Nom de domaine du serveur hebergeant le répertoire .well-known (*[nextcloud_well_known_server](dictionaries/31_nextcloud.xml)*) | | [domainname](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 | +|---------------------------------------------------------------------|---------------------------------------| +| *[**oauth2_is_client_application**](dictionaries/31_nextcloud.xml)* | True | +| *[**oauth2_client_name**](dictionaries/31_nextcloud.xml)* | Collaboration | +| *[**oauth2_client_description**](dictionaries/31_nextcloud.xml)* | Plateforme de collaboration Nextcloud | +| *[**oauth2_client_category**](dictionaries/31_nextcloud.xml)* | Diffusion | +| *[**oauth2_client_logo**](dictionaries/31_nextcloud.xml)* | silique_folder.png | + +#### php (*general.php*) + +| Description | Values | +|--------------------------------------------------------------------|----------| +| *[**php_enable_output_buffering**](dictionaries/31_nextcloud.xml)* | False | +| *[**php_disable_pcntl**](dictionaries/31_nextcloud.xml)* | False | + + +- [+]: 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. @@ -28,6 +60,10 @@ nextcloud: - redis - oauth2 - postgresql + values: + general.revprox.revprox_client.revprox_client_external_domainnames: + - service.example.net + general.nextcloud.nextcloud_mail_admin: admin@example.net ``` With all providers: @@ -44,6 +80,10 @@ nextcloud: - redis - oauth2 - postgresql + values: + general.revprox.revprox_client.revprox_client_external_domainnames: + - service.example.net + general.nextcloud.nextcloud_mail_admin: admin@example.net ``` ## Dependances @@ -68,36 +108,4 @@ nextcloud: - [php-fpm](../php-fpm/README.md) - [php](../php/README.md) -## Variables - -### Général (*general*) - -#### Nextcloud (*general.nextcloud*) - -| Description | Type | -|---------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------| -| *[**nextcloud_mail_admin**](dictionaries/31_nextcloud.xml)* | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | -| Nom de domaine du serveur hebergeant le répertoire .well-known (*[nextcloud_well_known_server](dictionaries/31_nextcloud.xml)*) | [domainname](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 | -|---------------------------------------------------------------------|---------------------------------------| -| *[**oauth2_is_client_application**](dictionaries/31_nextcloud.xml)* | True | -| *[**oauth2_client_name**](dictionaries/31_nextcloud.xml)* | Collaboration | -| *[**oauth2_client_description**](dictionaries/31_nextcloud.xml)* | Plateforme de collaboration Nextcloud | -| *[**oauth2_client_category**](dictionaries/31_nextcloud.xml)* | Diffusion | -| *[**oauth2_client_logo**](dictionaries/31_nextcloud.xml)* | silique_folder.png | - -#### php (*general.php*) - -| Description | Values | -|--------------------------------------------------------------------|----------| -| *[**php_enable_output_buffering**](dictionaries/31_nextcloud.xml)* | False | -| *[**php_disable_pcntl**](dictionaries/31_nextcloud.xml)* | False | - - -- [+]: variable is multiple -- **bold**: variable is mandatory - [All applications services for this dataset.](../README.md) diff --git a/seed/nextcloud/dictionaries/31_nextcloud.xml b/seed/nextcloud/dictionaries/31_nextcloud.xml index ed3f6db6..4592ccab 100644 --- a/seed/nextcloud/dictionaries/31_nextcloud.xml +++ b/seed/nextcloud/dictionaries/31_nextcloud.xml @@ -15,7 +15,7 @@ - + diff --git a/seed/oauth2-client/README.md b/seed/oauth2-client/README.md index 763a9bca..49ee3f8f 100644 --- a/seed/oauth2-client/README.md +++ b/seed/oauth2-client/README.md @@ -5,7 +5,7 @@ include_toc: true # oauth2-client -## Description +## Synopsis Application service needs interact with a Oauth2 server. @@ -15,16 +15,16 @@ Application service needs interact with a Oauth2 server. #### OAuth2 client (*general.oauth2_client*) -| Description | Type | Supplier | Values | 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 client is an application** (*[oauth2_is_client_application](dictionaries/30_oauth2_client.xml)*) | [boolean](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | False | | -| **OAuth2 client name** (*[oauth2_client_name](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) | OAuth2:name | | | -| **OAuth2 client description** (*[oauth2_client_description](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) | OAuth2:description | | | -| OAuth2 URL to valid login (*[oauth2_client_login](dictionaries/30_oauth2_client.xml)*) | [web_address](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2:login | | | -| **OAuth2 category** (*[oauth2_client_category](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) | OAuth2:category | Défaut | | -| **OAuth2 logo** (*[oauth2_client_logo](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) | OAuth2:logo | demo.png | | -| **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 | +| Description | Type | Supplier | Values | Example | 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 client is an application** (*[oauth2_is_client_application](dictionaries/30_oauth2_client.xml)*) | [boolean](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | False | | | +| **OAuth2 client name** (*[oauth2_client_name](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) | OAuth2:name | | example | | +| **OAuth2 client description** (*[oauth2_client_description](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) | OAuth2:description | | Example description | | +| OAuth2 URL to valid login (*[oauth2_client_login](dictionaries/30_oauth2_client.xml)*) | [web_address](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2:login | | | | +| **OAuth2 category** (*[oauth2_client_category](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) | OAuth2:category | Défaut | | | +| **OAuth2 logo** (*[oauth2_client_logo](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) | OAuth2:logo | demo.png | | | +| **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 | ##### external (*general.oauth2_client.external*) diff --git a/seed/oauth2-client/dictionaries/30_oauth2_client.xml b/seed/oauth2-client/dictionaries/30_oauth2_client.xml index 8c678b8d..94093e94 100644 --- a/seed/oauth2-client/dictionaries/30_oauth2_client.xml +++ b/seed/oauth2-client/dictionaries/30_oauth2_client.xml @@ -9,8 +9,8 @@ False - - + + diff --git a/seed/odoo/README.md b/seed/odoo/README.md index 73ebbbed..a28d8830 100644 --- a/seed/odoo/README.md +++ b/seed/odoo/README.md @@ -5,88 +5,35 @@ include_toc: true # odoo -## Description +## Synopsis Odoo, an ERP and CRM. [For more informations](https://www.odoo.com/fr) -## Examples - -Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. - -With minimum providers: - -``` -odoo: - applicationservice: odoo - zones_name: - - ldap - - localdns - - reverseproxy - - smtp - - oauth2 - - postgresql -``` - -With all providers: - -``` -odoo: - applicationservice: odoo - zones_name: - - journald - - ldap - - localdns - - reverseproxy - - smtp - - oauth2 - - postgresql -``` - -## 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) - - [pki-tls](../pki-tls/README.md) - - [journald](../journald/README.md) - - [resolved](../resolved/README.md) -- [postgresql-client](../postgresql-client/README.md) -- [reverse-proxy-client](../reverse-proxy-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) - ## Variables ### Général (*general*) #### Odoo (*general.odoo*) -| Description | Type | Values | Choices | -|-------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|--------------------------------------------| -| **Adresse courriel de l'administrateur** (*[odoo_admin_email](dictionaries/40_odoo.xml)*) | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | -| **Nom** (*[odoo_company_name](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | -| **Adresse** (*[odoo_company_street](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | -| **Ville** (*[odoo_company_city](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | -| **Code postal** (*[odoo_company_zip](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | -| **Numéro TVA** (*[odoo_company_vat](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | -| **Registre de la société** (*[odoo_company_registry](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | -| Numéro de téléphone (*[odoo_company_phone](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | -| Numéro de téléphone mobile (*[odoo_company_mobile](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | -| **Adresse courriel** (*[odoo_company_email](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | -| **Site internet** (*[odoo_company_website](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | -| **Chemin du logo** (*[odoo_company_logo](dictionaries/40_odoo.xml)*) | [filename](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | -| **Pied de page des documents** (*[odoo_company_footer](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | -| **Agencement des documents** (*[odoo_company_layout](dictionaries/40_odoo.xml)*) | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | standard | standard
bold
boxed
striped | -| **Liste des applications à activer** (*[odoo_addons](dictionaries/40_odoo.xml)*) [+] | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | base
l10n_fr
l10n_fr_fec
account
hr
hr_contract
sale_management | | +| Description | Example | Type | Values | Choices | +|-------------------------------------------------------------------------------------------|---------------------|--------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|--------------------------------------------| +| **Adresse courriel de l'administrateur** (*[odoo_admin_email](dictionaries/40_odoo.xml)*) | johndoe@example.net | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | +| **Nom** (*[odoo_company_name](dictionaries/40_odoo.xml)*) | ACME | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | +| **Adresse** (*[odoo_company_street](dictionaries/40_odoo.xml)*) | John Doe Street | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | +| **Ville** (*[odoo_company_city](dictionaries/40_odoo.xml)*) | Dijon | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | +| **Code postal** (*[odoo_company_zip](dictionaries/40_odoo.xml)*) | 21000 | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | +| **Numéro TVA** (*[odoo_company_vat](dictionaries/40_odoo.xml)*) | FR 99999999999 | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | +| **Registre de la société** (*[odoo_company_registry](dictionaries/40_odoo.xml)*) | 999 999 999 00099 | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | +| Numéro de téléphone (*[odoo_company_phone](dictionaries/40_odoo.xml)*) | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | +| Numéro de téléphone mobile (*[odoo_company_mobile](dictionaries/40_odoo.xml)*) | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | +| **Adresse courriel** (*[odoo_company_email](dictionaries/40_odoo.xml)*) | johndoe@example.net | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | +| **Site internet** (*[odoo_company_website](dictionaries/40_odoo.xml)*) | https://example.net | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | +| **Chemin du logo** (*[odoo_company_logo](dictionaries/40_odoo.xml)*) | /home/jdoe/logo.png | [filename](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | +| **Pied de page des documents** (*[odoo_company_footer](dictionaries/40_odoo.xml)*) | foot | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | +| **Agencement des documents** (*[odoo_company_layout](dictionaries/40_odoo.xml)*) | | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | standard | standard
bold
boxed
striped | +| **Liste des applications à activer** (*[odoo_addons](dictionaries/40_odoo.xml)*) [+] | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | base
l10n_fr
l10n_fr_fec
account
hr
hr_contract
sale_management | | #### postgresql (*general.postgresql*) @@ -129,4 +76,85 @@ odoo: - [+]: 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: + +``` +odoo: + applicationservice: odoo + zones_name: + - ldap + - localdns + - reverseproxy + - smtp + - oauth2 + - postgresql + values: + general.revprox.revprox_client.revprox_client_external_domainnames: + - service.example.net + general.odoo.odoo_admin_email: johndoe@example.net + general.odoo.odoo_company_name: ACME + general.odoo.odoo_company_street: John Doe Street + general.odoo.odoo_company_city: Dijon + general.odoo.odoo_company_zip: 21000 + general.odoo.odoo_company_vat: FR 99999999999 + general.odoo.odoo_company_registry: 999 999 999 00099 + general.odoo.odoo_company_email: johndoe@example.net + general.odoo.odoo_company_website: https://example.net + general.odoo.odoo_company_logo: /home/jdoe/logo.png + general.odoo.odoo_company_footer: foot +``` + +With all providers: + +``` +odoo: + applicationservice: odoo + zones_name: + - journald + - ldap + - localdns + - reverseproxy + - smtp + - oauth2 + - postgresql + values: + general.revprox.revprox_client.revprox_client_external_domainnames: + - service.example.net + general.odoo.odoo_admin_email: johndoe@example.net + general.odoo.odoo_company_name: ACME + general.odoo.odoo_company_street: John Doe Street + general.odoo.odoo_company_city: Dijon + general.odoo.odoo_company_zip: 21000 + general.odoo.odoo_company_vat: FR 99999999999 + general.odoo.odoo_company_registry: 999 999 999 00099 + general.odoo.odoo_company_email: johndoe@example.net + general.odoo.odoo_company_website: https://example.net + general.odoo.odoo_company_logo: /home/jdoe/logo.png + general.odoo.odoo_company_footer: foot +``` + +## 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) + - [pki-tls](../pki-tls/README.md) + - [journald](../journald/README.md) + - [resolved](../resolved/README.md) +- [postgresql-client](../postgresql-client/README.md) +- [reverse-proxy-client](../reverse-proxy-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) + [All applications services for this dataset.](../README.md) diff --git a/seed/odoo/dictionaries/40_odoo.xml b/seed/odoo/dictionaries/40_odoo.xml index a2aa1a1a..264c3973 100644 --- a/seed/odoo/dictionaries/40_odoo.xml +++ b/seed/odoo/dictionaries/40_odoo.xml @@ -15,19 +15,19 @@ - + - - - + + + diff --git a/seed/peertube/README.md b/seed/peertube/README.md index c6da0cdf..301c7f31 100644 --- a/seed/peertube/README.md +++ b/seed/peertube/README.md @@ -5,68 +5,12 @@ include_toc: true # peertube -## Description +## Synopsis Peertube, a federated (ActivityPub) video streaming platform. [For more informations](https://www.openldap.org/) -## Examples - -Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. - -With minimum providers: - -``` -peertube: - applicationservice: peertube - zones_name: - - localdns - - reverseproxy - - smtp - - redis - - oauth2 - - postgresql -``` - -With all providers: - -``` -peertube: - applicationservice: peertube - zones_name: - - journald - - externaldns - - localdns - - reverseproxy - - smtp - - redis - - oauth2 - - postgresql -``` - -## Dependances - -- [base-fedora-38](../base-fedora-38/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) -- [dns-external](../dns-external/README.md) -- [postgresql-client](../postgresql-client/README.md) -- [relay-mail-client](../relay-mail-client/README.md) -- [reverse-proxy-client](../reverse-proxy-client/README.md) -- [redis-client](../redis-client/README.md) - - [redis-common](../redis-common/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) - ## Variables ### Général (*general*) @@ -79,11 +23,11 @@ peertube: #### peertube (*general.peertube*) -| Description | Type | Values | -|------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| -| **Adresse courriel de l'administrateur Peertube** (*[peertube_admin_email](dictionaries/30_peertube.xml)*) | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | -| **Description courte de l'instance** (*[peertube_short_description](dictionaries/30_peertube.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser. | -| **Description de l'instance** (*[peertube_description](dictionaries/30_peertube.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Welcome to this PeerTube instance! | +| Description | Example | Type | Values | +|------------------------------------------------------------------------------------------------------------|----------------------|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| +| **Adresse courriel de l'administrateur Peertube** (*[peertube_admin_email](dictionaries/30_peertube.xml)*) | john.doe@example.net | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | +| **Description courte de l'instance** (*[peertube_short_description](dictionaries/30_peertube.xml)*) | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser. | +| **Description de l'instance** (*[peertube_description](dictionaries/30_peertube.xml)*) | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Welcome to this PeerTube instance! | #### oauth2_client (*general.oauth2_client*) @@ -120,4 +64,68 @@ peertube: - [+]: 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: + +``` +peertube: + applicationservice: peertube + zones_name: + - localdns + - reverseproxy + - smtp + - redis + - oauth2 + - postgresql + values: + general.revprox.revprox_client.revprox_client_external_domainnames: + - service.example.net + general.peertube.peertube_admin_email: john.doe@example.net +``` + +With all providers: + +``` +peertube: + applicationservice: peertube + zones_name: + - journald + - externaldns + - localdns + - reverseproxy + - smtp + - redis + - oauth2 + - postgresql + values: + general.revprox.revprox_client.revprox_client_external_domainnames: + - service.example.net + general.peertube.peertube_admin_email: john.doe@example.net +``` + +## Dependances + +- [base-fedora-38](../base-fedora-38/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) +- [dns-external](../dns-external/README.md) +- [postgresql-client](../postgresql-client/README.md) +- [relay-mail-client](../relay-mail-client/README.md) +- [reverse-proxy-client](../reverse-proxy-client/README.md) +- [redis-client](../redis-client/README.md) + - [redis-common](../redis-common/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) + [All applications services for this dataset.](../README.md) diff --git a/seed/peertube/dictionaries/30_peertube.xml b/seed/peertube/dictionaries/30_peertube.xml index 13e70001..716950ab 100644 --- a/seed/peertube/dictionaries/30_peertube.xml +++ b/seed/peertube/dictionaries/30_peertube.xml @@ -17,7 +17,7 @@ - + PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser. diff --git a/seed/php-fpm/README.md b/seed/php-fpm/README.md index 0eec8d75..b483615a 100644 --- a/seed/php-fpm/README.md +++ b/seed/php-fpm/README.md @@ -5,14 +5,10 @@ include_toc: true # php-fpm -## Description +## Synopsis PHP FPM. -## Dependances - -- [php](../php/README.md) - ## Variables ### Général (*general*) @@ -28,6 +24,10 @@ PHP FPM. - [+]: variable is multiple - **bold**: variable is mandatory +## Dependances + +- [php](../php/README.md) + ## Used by - [piwigo](../piwigo/README.md) diff --git a/seed/php/README.md b/seed/php/README.md index 8dbe3e05..14b892a4 100644 --- a/seed/php/README.md +++ b/seed/php/README.md @@ -5,7 +5,7 @@ include_toc: true # php -## Description +## Synopsis PHP, a popular general-purpose scripting language. diff --git a/seed/piwigo/README.md b/seed/piwigo/README.md index 999abdda..4d73b17c 100644 --- a/seed/piwigo/README.md +++ b/seed/piwigo/README.md @@ -5,12 +5,46 @@ include_toc: true # piwigo -## Description +## Synopsis Piwigo, a photo management software. [For more informations](http://piwigo.org/) +## Variables + +### Général (*general*) + +#### Piwigo (*general.piwigo*) + +| Description | Example | Type | Values | +|------------------------------------------------------------------------------------------------------|-------------------|------------------------------------------------------------------------------------------------------------------------|----------------------| +| **Adresse courriel de l'administrateur Piwigo** (*[piwigo_admin_email](dictionaries/31_piwigo.xml)*) | admin@example.net | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | +| **Titre de l'album** (*[piwigo_title](dictionaries/31_piwigo.xml)*) | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Album photographique | + +##### Piwigo users (*general.piwigo.users*) + +This a family is a leadership. + +| Description | Example | Type | +|-----------------------------------------------------------------------------------|---------------------|---------------------------------------------------------------------------------------------------------------------------| +| **Utilisateur ayant un album** (*[piwigo_users](dictionaries/31_piwigo.xml)*) [+] | jdoe | [unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | +| **Adresse courriel** (*[piwigo_email](dictionaries/31_piwigo.xml)*) | johndoe@example.net | [mail](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 | +|------------------------------------------------------------------|-----------------------------| +| *[**oauth2_is_client_application**](dictionaries/31_piwigo.xml)* | True | +| *[**oauth2_client_name**](dictionaries/31_piwigo.xml)* | Album | +| *[**oauth2_client_description**](dictionaries/31_piwigo.xml)* | Album photographique Piwigo | +| *[**oauth2_client_category**](dictionaries/31_piwigo.xml)* | Diffusion | +| *[**oauth2_client_logo**](dictionaries/31_piwigo.xml)* | silique_image.png | + + +- [+]: 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. @@ -28,6 +62,14 @@ piwigo: - smtp - redis - oauth2 + values: + general.revprox.revprox_client.revprox_client_external_domainnames: + - service.example.net + general.piwigo.piwigo_admin_email: admin@example.net + general.piwigo.users.piwigo_users: + - jdoe + general.piwigo.users.piwigo_email: + '0': johndoe@example.net ``` With all providers: @@ -44,6 +86,14 @@ piwigo: - smtp - redis - oauth2 + values: + general.revprox.revprox_client.revprox_client_external_domainnames: + - service.example.net + general.piwigo.piwigo_admin_email: admin@example.net + general.piwigo.users.piwigo_users: + - jdoe + general.piwigo.users.piwigo_email: + '0': johndoe@example.net ``` ## Dependances @@ -69,38 +119,4 @@ piwigo: - [php-fpm](../php-fpm/README.md) - [php](../php/README.md) -## Variables - -### Général (*general*) - -#### Piwigo (*general.piwigo*) - -| Description | Type | Values | -|------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|----------------------| -| **Adresse courriel de l'administrateur Piwigo** (*[piwigo_admin_email](dictionaries/31_piwigo.xml)*) | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | -| **Titre de l'album** (*[piwigo_title](dictionaries/31_piwigo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Album photographique | - -##### Piwigo users (*general.piwigo.users*) - -This a family is a leadership. - -| Description | Type | -|-----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------| -| **Utilisateur ayant un album** (*[piwigo_users](dictionaries/31_piwigo.xml)*) [+] | [unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | -| **Adresse courriel** (*[piwigo_email](dictionaries/31_piwigo.xml)*) | [mail](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 | -|------------------------------------------------------------------|-----------------------------| -| *[**oauth2_is_client_application**](dictionaries/31_piwigo.xml)* | True | -| *[**oauth2_client_name**](dictionaries/31_piwigo.xml)* | Album | -| *[**oauth2_client_description**](dictionaries/31_piwigo.xml)* | Album photographique Piwigo | -| *[**oauth2_client_category**](dictionaries/31_piwigo.xml)* | Diffusion | -| *[**oauth2_client_logo**](dictionaries/31_piwigo.xml)* | silique_image.png | - - -- [+]: variable is multiple -- **bold**: variable is mandatory - [All applications services for this dataset.](../README.md) diff --git a/seed/piwigo/dictionaries/31_piwigo.xml b/seed/piwigo/dictionaries/31_piwigo.xml index af8a7ae9..a8758b56 100644 --- a/seed/piwigo/dictionaries/31_piwigo.xml +++ b/seed/piwigo/dictionaries/31_piwigo.xml @@ -12,15 +12,15 @@ - + diff --git a/seed/pki-tls/README.md b/seed/pki-tls/README.md index 0f28df42..291e3777 100644 --- a/seed/pki-tls/README.md +++ b/seed/pki-tls/README.md @@ -5,7 +5,7 @@ include_toc: true # pki-tls -## Description +## Synopsis Autosign PKI or Let's encrypt support for TLS certificates. diff --git a/seed/postfix-lmtp-relay/README.md b/seed/postfix-lmtp-relay/README.md index f1d23bfe..fec897ef 100644 --- a/seed/postfix-lmtp-relay/README.md +++ b/seed/postfix-lmtp-relay/README.md @@ -5,7 +5,7 @@ include_toc: true # postfix-lmtp-relay -## Description +## Synopsis Postfix, the mail server, as LMTP relay. diff --git a/seed/postfix-relay/README.md b/seed/postfix-relay/README.md index 91ac4a58..633dc026 100644 --- a/seed/postfix-relay/README.md +++ b/seed/postfix-relay/README.md @@ -5,12 +5,43 @@ include_toc: true # postfix-relay -## Description +## Synopsis Postfix, the mail server, as relay. [For more informations](http://www.postfix.org/) +## Variables + +### Général (*general*) + +#### network (*general.network*) + +| Description | Values | +|-----------------------------------------------------|--------------| +| *[**outgoing_ports**](dictionaries/30_postfix.xml)* | 25 | +| *[incoming_ports](dictionaries/30_postfix.xml)* | | + +#### Postfix mail server (*general.postfix*) + +| Description | Help | Type | Values | Choices | Provider | +|----------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|-----------|----------------------------|------------| +| Nom de domaine extérieur du serveur de courriel (*[postfix_mail_hostname](dictionaries/30_postfix.xml)*) | Cette variable est obligatoire pour recevoir des courriels depuis l'extérieur | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | | +| **Autorité de certification signant le certificat du domaine extérieur** (*[postfix_crt_provider](dictionaries/30_postfix.xml)*) | | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | autosigne | autosigne
letsencrypt | | +| Authentification sur le relai SMTP (*[postfix_relay_authentifications](dictionaries/30_postfix.xml)*) [+] | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | SMTP | + +##### Local server authentification (*general.postfix.local_authentification_*) + +This a dynamic family generated from the variable "general.postfix.postfix_relay_authentifications". + +| Description | Type | Provider | +|-------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|---------------| +| *[local_authentification_password_](dictionaries/30_postfix.xml)* | [secret](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | SMTP:password | + + +- [+]: 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. @@ -51,37 +82,6 @@ postfix-relay: - [dns-external](../dns-external/README.md) - [postfix-lmtp-relay](../postfix-lmtp-relay/README.md) -## Variables - -### Général (*general*) - -#### network (*general.network*) - -| Description | Values | -|-----------------------------------------------------|--------------| -| *[**outgoing_ports**](dictionaries/30_postfix.xml)* | 25 | -| *[incoming_ports](dictionaries/30_postfix.xml)* | | - -#### Postfix mail server (*general.postfix*) - -| Description | Help | Type | Values | Choices | Provider | -|----------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|-----------|----------------------------|------------| -| Nom de domaine extérieur du serveur de courriel (*[postfix_mail_hostname](dictionaries/30_postfix.xml)*) | Cette variable est obligatoire pour recevoir des courriels depuis l'extérieur | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | | -| **Autorité de certification signant le certificat du domaine extérieur** (*[postfix_crt_provider](dictionaries/30_postfix.xml)*) | | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | autosigne | autosigne
letsencrypt | | -| Authentification sur le relai SMTP (*[postfix_relay_authentifications](dictionaries/30_postfix.xml)*) [+] | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | SMTP | - -##### Local server authentification (*general.postfix.local_authentification_*) - -This a dynamic family generated from the variable "general.postfix.postfix_relay_authentifications". - -| Description | Type | Provider | -|-------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|---------------| -| *[local_authentification_password_](dictionaries/30_postfix.xml)* | [secret](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | SMTP:password | - - -- [+]: variable is multiple -- **bold**: variable is mandatory - ## Supplier [relay-mail-client](../relay-mail-client/README.md) diff --git a/seed/postgresql-client/README.md b/seed/postgresql-client/README.md index 9259107d..6f2332c5 100644 --- a/seed/postgresql-client/README.md +++ b/seed/postgresql-client/README.md @@ -5,7 +5,7 @@ include_toc: true # postgresql-client -## Description +## Synopsis Application service needs interact with a Postgresql server. diff --git a/seed/postgresql/README.md b/seed/postgresql/README.md index 2bed86df..b1441f96 100644 --- a/seed/postgresql/README.md +++ b/seed/postgresql/README.md @@ -5,49 +5,12 @@ include_toc: true # postgresql -## Description +## Synopsis Postgresql, a database. [For more informations](https://www.postgresql.org) -## Examples - -Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. - -With minimum providers: - -``` -postgresql: - applicationservice: postgresql - provider_zone: postgresql - zones_name: - - localdns -``` - -With all providers: - -``` -postgresql: - applicationservice: postgresql - provider_zone: postgresql - zones_name: - - journald - - localdns -``` - -## Dependances - -- [base-fedora-37](../base-fedora-37/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) - ## Variables ### Général (*general*) @@ -93,6 +56,43 @@ This a dynamic family generated from the variable "accounts.remotes". - [+]: 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: + +``` +postgresql: + applicationservice: postgresql + provider_zone: postgresql + zones_name: + - localdns +``` + +With all providers: + +``` +postgresql: + applicationservice: postgresql + provider_zone: postgresql + zones_name: + - journald + - localdns +``` + +## Dependances + +- [base-fedora-37](../base-fedora-37/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) + ## Supplier [postgresql-client](../postgresql-client/README.md) diff --git a/seed/prometheus/README.md b/seed/prometheus/README.md index 0367bb4d..91dbd3c4 100644 --- a/seed/prometheus/README.md +++ b/seed/prometheus/README.md @@ -5,12 +5,26 @@ include_toc: true # prometheus -## Description +## Synopsis Prometheus, an event monitoring. [For more informations](https://prometheus.io/) +## Variables + +### Général (*general*) + +#### prometheus (*general.prometheus*) + +| Description | Type | Provider | +|----------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------| +| *[client_addresses](dictionaries/20_prometheus.xml)* [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Prometheus | + + +- [+]: 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. @@ -48,20 +62,6 @@ prometheus: - [journald](../journald/README.md) - [resolved](../resolved/README.md) -## Variables - -### Général (*general*) - -#### prometheus (*general.prometheus*) - -| Description | Type | Provider | -|----------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------| -| *[client_addresses](dictionaries/20_prometheus.xml)* [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Prometheus | - - -- [+]: variable is multiple -- **bold**: variable is mandatory - ## Supplier [host-systemd-machined](../host-systemd-machined/README.md) diff --git a/seed/provider-systemd-machined/README.md b/seed/provider-systemd-machined/README.md index d1a9f5bc..14d778a2 100644 --- a/seed/provider-systemd-machined/README.md +++ b/seed/provider-systemd-machined/README.md @@ -5,22 +5,12 @@ include_toc: true # provider-systemd-machined -## Description +## Synopsis Machine started in Systemd Machined environment. [For more informations](https://www.freedesktop.org/wiki/Software/systemd/machined/) -## Dependances - -- [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) - ## Variables ### Général (*general*) @@ -44,6 +34,16 @@ Machine started in Systemd Machined environment. - [+]: variable is multiple - **bold**: variable is mandatory +## Dependances + +- [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) + ## Provider [host-systemd-machined](../host-systemd-machined/README.md) diff --git a/seed/redis-client/README.md b/seed/redis-client/README.md index 765ac65d..d53dbc97 100644 --- a/seed/redis-client/README.md +++ b/seed/redis-client/README.md @@ -5,16 +5,12 @@ include_toc: true # redis-client -## Description +## Synopsis Application service needs interact with a Redis server. [For more informations](https://redis.io/) -## Dependances - -- [redis-common](../redis-common/README.md) - ## Variables ### Général (*general*) @@ -32,6 +28,10 @@ Application service needs interact with a Redis server. - [+]: variable is multiple - **bold**: variable is mandatory +## Dependances + +- [redis-common](../redis-common/README.md) + ## Used by - [peertube](../peertube/README.md) diff --git a/seed/redis-common/README.md b/seed/redis-common/README.md index dc733d76..7b9f5f7d 100644 --- a/seed/redis-common/README.md +++ b/seed/redis-common/README.md @@ -5,7 +5,7 @@ include_toc: true # redis-common -## Description +## Synopsis Redis, an in-memory data structure store. diff --git a/seed/redis/README.md b/seed/redis/README.md index 87fc64f3..33db57a0 100644 --- a/seed/redis/README.md +++ b/seed/redis/README.md @@ -5,12 +5,43 @@ include_toc: true # redis -## Description +## Synopsis Redis, an in-memory data structure store. [For more informations](https://redis.io/) +## Variables + +### Général (*general*) + +#### Redis (*general.redis*) + +Configuration du service de cache Redis + +| Description | Values | Help | Type | Choices | +|----------------------------------------------------------------------------------------------------------------------------|--------------|--------------------------|------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| **Nom de l'instance** (*[redis_instance_name](dictionaries/90_redis.xml)*) | | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | +| **Activer la persistence des données** (*[redis_save](dictionaries/90_redis.xml)*) | False | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | +| **Quantité de mémoire utilisable par Redis** (*[redis_max_memory](dictionaries/90_redis.xml)*) | 512 | La valeur est en Mo | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | +| **Méthode de libération de mémoire lorsque le maximum est atteint** (*[redis_memory_policy](dictionaries/90_redis.xml)*) | noeviction | | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | volatile-lru
allkeys-lru
volatile-lfu
allkeys-lfu
volatile-random
allkeys-random
volatile-ttl
noeviction | +| **Intervalle entre le dernier envoi de paquet TCP et la réponse ACK** (*[redis_tcp_keepalive](dictionaries/90_redis.xml)*) | 300 | La valeur est en seconde | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | +| **Nombre de client maximum autorisé** (*[redis_max_clients](dictionaries/90_redis.xml)*) | 10000 | | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | + +### Accounts (*accounts*) + +#### remote_ (*accounts.remote_*) + +This a dynamic family generated from the variable "accounts.remotes". + +| Description | Type | Values | +|----------------------------------------------|--------------------------------------------------------------------------------------------------------------------|--------------| +| *[**ip_**](extras/accounts/00_accounts.xml)* | [ip](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 + ## Examples Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. @@ -49,37 +80,6 @@ redis: - [resolved](../resolved/README.md) - [redis-common](../redis-common/README.md) -## Variables - -### Général (*general*) - -#### Redis (*general.redis*) - -Configuration du service de cache Redis - -| Description | Values | Help | Type | Choices | -|----------------------------------------------------------------------------------------------------------------------------|--------------|--------------------------|------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| -| **Nom de l'instance** (*[redis_instance_name](dictionaries/90_redis.xml)*) | | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | -| **Activer la persistence des données** (*[redis_save](dictionaries/90_redis.xml)*) | False | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | -| **Quantité de mémoire utilisable par Redis** (*[redis_max_memory](dictionaries/90_redis.xml)*) | 512 | La valeur est en Mo | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | -| **Méthode de libération de mémoire lorsque le maximum est atteint** (*[redis_memory_policy](dictionaries/90_redis.xml)*) | noeviction | | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | volatile-lru
allkeys-lru
volatile-lfu
allkeys-lfu
volatile-random
allkeys-random
volatile-ttl
noeviction | -| **Intervalle entre le dernier envoi de paquet TCP et la réponse ACK** (*[redis_tcp_keepalive](dictionaries/90_redis.xml)*) | 300 | La valeur est en seconde | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | -| **Nombre de client maximum autorisé** (*[redis_max_clients](dictionaries/90_redis.xml)*) | 10000 | | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | - -### Accounts (*accounts*) - -#### remote_ (*accounts.remote_*) - -This a dynamic family generated from the variable "accounts.remotes". - -| Description | Type | Values | -|----------------------------------------------|--------------------------------------------------------------------------------------------------------------------|--------------| -| *[**ip_**](extras/accounts/00_accounts.xml)* | [ip](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 - ## Supplier [redis-client](../redis-client/README.md) diff --git a/seed/relay-lmtp-client/README.md b/seed/relay-lmtp-client/README.md index 46608c99..431c59ec 100644 --- a/seed/relay-lmtp-client/README.md +++ b/seed/relay-lmtp-client/README.md @@ -5,14 +5,10 @@ include_toc: true # relay-lmtp-client -## Description +## Synopsis Application service needs interact with a Postfix server with LMTP protocol. -## Dependances - -- [relay-mail-client](../relay-mail-client/README.md) - ## Variables ### Général (*general*) @@ -25,6 +21,10 @@ Application service needs interact with a Postfix server with LMTP protocol. - [+]: variable is multiple - **bold**: variable is mandatory +## Dependances + +- [relay-mail-client](../relay-mail-client/README.md) + ## Used by - [mailman](../mailman/README.md) diff --git a/seed/relay-mail-client/README.md b/seed/relay-mail-client/README.md index e4213a0e..0f73ed9c 100644 --- a/seed/relay-mail-client/README.md +++ b/seed/relay-mail-client/README.md @@ -5,7 +5,7 @@ include_toc: true # relay-mail-client -## Description +## Synopsis Client SMTP. diff --git a/seed/resolved/README.md b/seed/resolved/README.md index ffb3f81f..fd79b182 100644 --- a/seed/resolved/README.md +++ b/seed/resolved/README.md @@ -5,7 +5,7 @@ include_toc: true # resolved -## Description +## Synopsis Resolved. diff --git a/seed/reverse-proxy-client/README.md b/seed/reverse-proxy-client/README.md index 30f0f511..629a8bf3 100644 --- a/seed/reverse-proxy-client/README.md +++ b/seed/reverse-proxy-client/README.md @@ -5,7 +5,7 @@ include_toc: true # reverse-proxy-client -## Description +## Synopsis Application service needs interact with a a reverse proxy server. @@ -19,11 +19,11 @@ Application service needs interact with a a reverse proxy server. This a family is a leadership. -| Description | Type | 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) | ReverseProxy:external | -| **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 | +| Description | Example | Type | Supplier | +|---------------------------------------------------------------------------------------------------------------------------|---------------------|----------------------------------------------------------------------------------------------------------------------------|----------------------------| +| **Nom de domaine exterieur du serveur** (*[revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)*) [+] | service.example.net | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | ReverseProxy:external | +| **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 | - [+]: variable is multiple diff --git a/seed/reverse-proxy-client/dictionaries/21_revprox_client.xml b/seed/reverse-proxy-client/dictionaries/21_revprox_client.xml index b6905d53..eb9f833c 100644 --- a/seed/reverse-proxy-client/dictionaries/21_revprox_client.xml +++ b/seed/reverse-proxy-client/dictionaries/21_revprox_client.xml @@ -11,7 +11,7 @@ - + diff --git a/seed/vaultwarden/README.md b/seed/vaultwarden/README.md index 1a592c4d..850a87de 100644 --- a/seed/vaultwarden/README.md +++ b/seed/vaultwarden/README.md @@ -5,12 +5,42 @@ include_toc: true # vaultwarden -## Description +## Synopsis Vaultwarden, a password manager. [For more informations](https://github.com/dani-garcia/vaultwarden) +## Variables + +### Général (*general*) + +#### revprox (*general.revprox*) + +| Description | Values | +|--------------------------------------------------------------------|-------------| +| *[**revprox_client_cert_owner**](dictionaries/40_vaultwarden.xml)* | vaultwarden | + +#### Vaultwarden (*general.vaultwarden*) + +| Description | Example | Type | Values | +|-----------------------------------------------------------------------------------------------------------------------|-------------------|----------------------------------------------------------------------------------------------------------------------------|-------------| +| **Nom de domaine d'accès à Vaultwarden** (*[vaultwarden_domainname](dictionaries/40_vaultwarden.xml)*) | vault.example.net | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | +| **Nom de l'utilisateur Risotto de Vaultwarden** (*[password_admin_username](dictionaries/40_vaultwarden.xml)*) | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | risotto | +| **Adresse courriel de l'utilisateur Risotto** (*[vaultwarden_admin_email](dictionaries/40_vaultwarden.xml)*) | admin@example.net | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | +| **Taille par défaut du mot de passe** (*[vaultwarden_length](dictionaries/40_vaultwarden.xml)*) | | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 20 | +| **Nom de l'organisation lors de l'envoi des invitations** (*[vaultwarden_org_name](dictionaries/40_vaultwarden.xml)*) | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Vaultwarden | + +#### PostgreSQL (*general.postgresql*) + +| Description | Values | +|--------------------------------------------------------------|-------------| +| *[**pg_client_key_owner**](dictionaries/40_vaultwarden.xml)* | vaultwarden | + + +- [+]: 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. @@ -25,6 +55,9 @@ vaultwarden: - reverseproxy - smtp - postgresql + values: + general.vaultwarden.vaultwarden_domainname: vault.example.net + general.vaultwarden.vaultwarden_admin_email: admin@example.net ``` With all providers: @@ -38,6 +71,9 @@ vaultwarden: - reverseproxy - smtp - postgresql + values: + general.vaultwarden.vaultwarden_domainname: vault.example.net + general.vaultwarden.vaultwarden_admin_email: admin@example.net ``` ## Dependances @@ -55,34 +91,4 @@ vaultwarden: - [relay-mail-client](../relay-mail-client/README.md) - [reverse-proxy-client](../reverse-proxy-client/README.md) -## Variables - -### Général (*general*) - -#### revprox (*general.revprox*) - -| Description | Values | -|--------------------------------------------------------------------|-------------| -| *[**revprox_client_cert_owner**](dictionaries/40_vaultwarden.xml)* | vaultwarden | - -#### Vaultwarden (*general.vaultwarden*) - -| Description | Type | Values | -|-----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|-------------| -| **Nom de domaine d'accès à Vaultwarden** (*[vaultwarden_domainname](dictionaries/40_vaultwarden.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | -| **Nom de l'utilisateur Risotto de Vaultwarden** (*[password_admin_username](dictionaries/40_vaultwarden.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | risotto | -| **Adresse courriel de l'utilisateur Risotto** (*[vaultwarden_admin_email](dictionaries/40_vaultwarden.xml)*) | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | -| **Taille par défaut du mot de passe** (*[vaultwarden_length](dictionaries/40_vaultwarden.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 20 | -| **Nom de l'organisation lors de l'envoi des invitations** (*[vaultwarden_org_name](dictionaries/40_vaultwarden.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Vaultwarden | - -#### PostgreSQL (*general.postgresql*) - -| Description | Values | -|--------------------------------------------------------------|-------------| -| *[**pg_client_key_owner**](dictionaries/40_vaultwarden.xml)* | vaultwarden | - - -- [+]: variable is multiple -- **bold**: variable is mandatory - [All applications services for this dataset.](../README.md) diff --git a/seed/vaultwarden/dictionaries/40_vaultwarden.xml b/seed/vaultwarden/dictionaries/40_vaultwarden.xml index 811502da..7daa77c1 100644 --- a/seed/vaultwarden/dictionaries/40_vaultwarden.xml +++ b/seed/vaultwarden/dictionaries/40_vaultwarden.xml @@ -18,11 +18,11 @@ - + risotto - + - + autosigne autosigne letsencrypt - - - + + + - - + + - +