From 570368ddd100b6c5c86e3344b08ff22be42faa38 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Wed, 2 Aug 2023 09:26:54 +0200 Subject: [PATCH] update doc --- seed/apache/README.md | 18 ------ seed/apache/applicationservice.yml | 1 - seed/base/funcs/base.py | 9 +++ seed/dovecot/README.md | 28 +++++++-- seed/dovecot/dictionaries/26_dovecot.xml | 6 +- seed/forgejo/README.md | 16 +++-- seed/forgejo/dictionaries/31_forgejo.xml | 2 +- seed/grafana/README.md | 26 +++++--- seed/grafana/dictionaries/31_grafana.xml | 2 +- seed/lemonldap/README.md | 16 +++-- .../dictionaries/70_lemonldap_ng.xml | 2 +- seed/mailman/README.md | 18 ++++-- seed/mailman/dictionaries/31_mailman.xml | 2 +- seed/nextcloud/README.md | 16 +++-- seed/nextcloud/dictionaries/31_nextcloud.xml | 2 +- seed/nsd/README.md | 12 +++- seed/nsd/dictionaries/20_nsd.xml | 2 +- seed/oauth2-client/README.md | 20 +++--- .../dictionaries/30_oauth2_client.xml | 4 +- seed/odoo/README.md | 62 ++++++++++++++----- seed/odoo/dictionaries/40_odoo.xml | 22 +++---- seed/openldap/README.md | 14 ++--- seed/openldap/extras/accounts/00_account.xml | 8 +-- seed/peertube/README.md | 18 ++++-- seed/peertube/dictionaries/30_peertube.xml | 2 +- seed/piwigo/README.md | 32 +++++++--- seed/piwigo/dictionaries/31_piwigo.xml | 6 +- seed/reverse-proxy-client/README.md | 10 +-- .../dictionaries/21_revprox_client.xml | 2 +- .../funcs/revprox_client.py | 9 --- seed/roundcube/README.md | 20 ++++-- seed/roundcube/dictionaries/31_roundcube.xml | 4 +- seed/speedtest-rs/README.md | 6 ++ seed/unbound/README.md | 12 +++- seed/unbound/dictionaries/20_unbound.xml | 2 +- seed/vaultwarden/README.md | 20 +++--- .../dictionaries/40_vaultwarden.xml | 4 +- seed/znc/README.md | 46 ++++++++++---- seed/znc/dictionaries/40_znc.xml | 14 ++--- 39 files changed, 332 insertions(+), 183 deletions(-) diff --git a/seed/apache/README.md b/seed/apache/README.md index 9d734927..49f26c5a 100644 --- a/seed/apache/README.md +++ b/seed/apache/README.md @@ -11,24 +11,6 @@ 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) 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/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/dovecot/README.md b/seed/dovecot/README.md index 2a464a07..501f5f1d 100644 --- a/seed/dovecot/README.md +++ b/seed/dovecot/README.md @@ -28,6 +28,15 @@ dovecot: - 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: @@ -44,6 +53,15 @@ dovecot: - 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 @@ -94,11 +112,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*) 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..2f6590ab 100644 --- a/seed/forgejo/README.md +++ b/seed/forgejo/README.md @@ -27,6 +27,10 @@ forgejo: - 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: @@ -42,6 +46,10 @@ forgejo: - redis - oauth2 - postgresql + values: + general.revprox.revprox_client.revprox_client_external_domainnames: + - service.example.net + general.forgejo.forgejo_mail_sender: admin@example.net ``` ## Dependances @@ -82,10 +90,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*) 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/lemonldap/README.md b/seed/lemonldap/README.md index 441b6750..b03b6f76 100644 --- a/seed/lemonldap/README.md +++ b/seed/lemonldap/README.md @@ -26,6 +26,10 @@ lemonldap: - 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: @@ -40,6 +44,10 @@ lemonldap: - localdns - reverseproxy - smtp + values: + general.revprox.revprox_client.revprox_client_external_domainnames: + - service.example.net + general.lemonldap.lemon_mail_admin: admin@example.net ``` ## Dependances @@ -73,10 +81,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*) 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/mailman/README.md b/seed/mailman/README.md index aa9d7c8f..be32eec8 100644 --- a/seed/mailman/README.md +++ b/seed/mailman/README.md @@ -27,6 +27,11 @@ mailman: - 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: @@ -42,6 +47,11 @@ mailman: - lmtp - oauth2 - postgresql + values: + general.revprox.revprox_client.revprox_client_external_domainnames: + - service.example.net + general.mailman.mailman_domains: + - list.example.net ``` ## Dependances @@ -70,10 +80,10 @@ mailman: #### 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*) 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/nextcloud/README.md b/seed/nextcloud/README.md index dbb3fac9..f8424212 100644 --- a/seed/nextcloud/README.md +++ b/seed/nextcloud/README.md @@ -28,6 +28,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 +48,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 @@ -74,10 +82,10 @@ nextcloud: #### 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) | +| 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*) 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..90e17e6e 100644 --- a/seed/oauth2-client/README.md +++ b/seed/oauth2-client/README.md @@ -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..eb66e735 100644 --- a/seed/odoo/README.md +++ b/seed/odoo/README.md @@ -27,6 +27,20 @@ odoo: - 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: @@ -42,6 +56,20 @@ odoo: - 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 @@ -70,23 +98,23 @@ odoo: #### 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*) 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..1a3bbb0d 100644 --- a/seed/peertube/README.md +++ b/seed/peertube/README.md @@ -27,6 +27,10 @@ peertube: - 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: @@ -43,6 +47,10 @@ peertube: - 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 @@ -79,11 +87,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*) 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/piwigo/README.md b/seed/piwigo/README.md index 999abdda..83a1ce6e 100644 --- a/seed/piwigo/README.md +++ b/seed/piwigo/README.md @@ -28,6 +28,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 +52,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 @@ -75,19 +91,19 @@ piwigo: #### 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 | +| 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 | 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) | +| 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*) 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/reverse-proxy-client/README.md b/seed/reverse-proxy-client/README.md index 30f0f511..827e4b59 100644 --- a/seed/reverse-proxy-client/README.md +++ b/seed/reverse-proxy-client/README.md @@ -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..5054256e 100644 --- a/seed/vaultwarden/README.md +++ b/seed/vaultwarden/README.md @@ -25,6 +25,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 +41,9 @@ vaultwarden: - reverseproxy - smtp - postgresql + values: + general.vaultwarden.vaultwarden_domainname: vault.example.net + general.vaultwarden.vaultwarden_admin_email: admin@example.net ``` ## Dependances @@ -67,13 +73,13 @@ 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 | +| 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*) 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 - - - + + + - - + + - +