diff --git a/seed/apache/README.md b/seed/apache/README.md
index 9d734927..1598b2ab 100644
--- a/seed/apache/README.md
+++ b/seed/apache/README.md
@@ -5,30 +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)
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..efca5509 100644
--- a/seed/base-machine/README.md
+++ b/seed/base-machine/README.md
@@ -5,7 +5,7 @@ include_toc: true
# base-machine
-## Description
+## Synopsis
Base information for a machine.
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..e5367403 100644
--- a/seed/dovecot/README.md
+++ b/seed/dovecot/README.md
@@ -5,47 +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)
@@ -94,11 +59,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 +90,59 @@ 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
+```
+
## 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..8e2cad9f 100644
--- a/seed/forgejo/README.md
+++ b/seed/forgejo/README.md
@@ -5,45 +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)
@@ -82,10 +49,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 +94,47 @@ 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
+```
+
## 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/gitea/README.md b/seed/gitea/README.md
index 6cacc957..ed6b19d0 100644
--- a/seed/gitea/README.md
+++ b/seed/gitea/README.md
@@ -5,7 +5,7 @@ include_toc: true
# gitea
-## Description
+## Synopsis
Transitional package for Gitea to Forgejo.
diff --git a/seed/grafana/README.md b/seed/grafana/README.md
index c4a10194..9d79876b 100644
--- a/seed/grafana/README.md
+++ b/seed/grafana/README.md
@@ -5,43 +5,12 @@ include_toc: true
# grafana
-## Description
+## Synopsis
Grafana is an analytics and interactive visualization web application.
[For more informations](https://grafana.com/)
-## Examples
-
-Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
-
-With minimum providers:
-
-```
-grafana:
- applicationservice: grafana
- zones_name:
- - localdns
- - reverseproxy
- - smtp
- - oauth2
- - postgresql
-```
-
-With all providers:
-
-```
-grafana:
- applicationservice: grafana
- zones_name:
- - journald
- - localdns
- - reverseproxy
- - smtp
- - oauth2
- - postgresql
-```
-
## Dependances
- [base-fedora-38](../base-fedora-38/README.md)
@@ -77,15 +46,15 @@ grafana:
#### oauth2_client (*general.oauth2_client*)
-| Description | Values | Type |
-|--------------------------------------------------------------------------------------------------|--------------------------|----------------------------------------------------------------------------------------------------------------------------|
-| *[**oauth2_is_client_application**](dictionaries/31_grafana.xml)* | True | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
-| *[**oauth2_client_name**](dictionaries/31_grafana.xml)* | Grafana | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
-| *[**oauth2_client_description**](dictionaries/31_grafana.xml)* | Visualisation de données | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
-| *[**oauth2_client_category**](dictionaries/31_grafana.xml)* | Administration | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
-| *[**oauth2_client_logo**](dictionaries/31_grafana.xml)* | silique_note.png | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
-| *[**oauth2_client_token_signature_algo**](dictionaries/31_grafana.xml)* | RS256 | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
-| **Domain name allowed to log on Grafana** (*[oauth2_email_domain](dictionaries/31_grafana.xml)*) | | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
+| Description | Values | Example | Type |
+|--------------------------------------------------------------------------------------------------|--------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------|
+| *[**oauth2_is_client_application**](dictionaries/31_grafana.xml)* | True | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
+| *[**oauth2_client_name**](dictionaries/31_grafana.xml)* | Grafana | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
+| *[**oauth2_client_description**](dictionaries/31_grafana.xml)* | Visualisation de données | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
+| *[**oauth2_client_category**](dictionaries/31_grafana.xml)* | Administration | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
+| *[**oauth2_client_logo**](dictionaries/31_grafana.xml)* | silique_note.png | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
+| *[**oauth2_client_token_signature_algo**](dictionaries/31_grafana.xml)* | RS256 | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
+| **Domain name allowed to log on Grafana** (*[oauth2_email_domain](dictionaries/31_grafana.xml)*) | | example.net | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
#### postgresql (*general.postgresql*)
@@ -97,4 +66,43 @@ grafana:
- [+]: 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:
+
+```
+grafana:
+ applicationservice: grafana
+ zones_name:
+ - localdns
+ - reverseproxy
+ - smtp
+ - oauth2
+ - postgresql
+ values:
+ general.revprox.revprox_client.revprox_client_external_domainnames:
+ - service.example.net
+ general.oauth2_client.oauth2_email_domain: example.net
+```
+
+With all providers:
+
+```
+grafana:
+ applicationservice: grafana
+ zones_name:
+ - journald
+ - localdns
+ - reverseproxy
+ - smtp
+ - oauth2
+ - postgresql
+ values:
+ general.revprox.revprox_client.revprox_client_external_domainnames:
+ - service.example.net
+ general.oauth2_client.oauth2_email_domain: example.net
+```
+
[All applications services for this dataset.](../README.md)
diff --git a/seed/grafana/dictionaries/31_grafana.xml b/seed/grafana/dictionaries/31_grafana.xml
index 6b63d30e..b1530587 100644
--- a/seed/grafana/dictionaries/31_grafana.xml
+++ b/seed/grafana/dictionaries/31_grafana.xml
@@ -44,7 +44,7 @@
RS256
-
+
diff --git a/seed/host-systemd-machined/README.md b/seed/host-systemd-machined/README.md
index ec961830..9fa4d179 100644
--- a/seed/host-systemd-machined/README.md
+++ b/seed/host-systemd-machined/README.md
@@ -5,7 +5,7 @@ include_toc: true
# host-systemd-machined
-## Description
+## Synopsis
Host with machine started in Systemd Machined environment.
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..491839da 100644
--- a/seed/lemonldap/README.md
+++ b/seed/lemonldap/README.md
@@ -5,43 +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)
@@ -73,10 +42,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 +77,45 @@ 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
+```
+
## 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..5dcafcd6 100644
--- a/seed/loki/README.md
+++ b/seed/loki/README.md
@@ -5,37 +5,12 @@ include_toc: true
# loki
-## Description
+## Synopsis
Loki, a log aggregation platform.
[For more informations](https://grafana.com/)
-## Examples
-
-Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
-
-With minimum providers:
-
-```
-loki:
- applicationservice: loki
- provider_zone: loki
- zones_name:
- - localdns
-```
-
-With all providers:
-
-```
-loki:
- applicationservice: loki
- provider_zone: loki
- zones_name:
- - journald
- - localdns
-```
-
## Dependances
- [base-fedora-38](../base-fedora-38/README.md)
@@ -62,6 +37,31 @@ 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.
+
+With minimum providers:
+
+```
+loki:
+ applicationservice: loki
+ provider_zone: loki
+ zones_name:
+ - localdns
+```
+
+With all providers:
+
+```
+loki:
+ applicationservice: loki
+ provider_zone: loki
+ zones_name:
+ - journald
+ - localdns
+```
+
## Supplier
[vector](../vector/README.md)
diff --git a/seed/mailman/README.md b/seed/mailman/README.md
index aa9d7c8f..4cc1482d 100644
--- a/seed/mailman/README.md
+++ b/seed/mailman/README.md
@@ -5,45 +5,12 @@ 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)
@@ -70,10 +37,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*)
@@ -127,4 +94,47 @@ 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
+```
+
[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..f989a8a8 100644
--- a/seed/mariadb/README.md
+++ b/seed/mariadb/README.md
@@ -5,12 +5,36 @@ include_toc: true
# mariadb
-## Description
+## Synopsis
MariaDB, a relational database.
[For more informations](https://mariadb.org/)
+## 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)
+
+## 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.
@@ -36,30 +60,6 @@ mariadb:
- localdns
```
-## 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)
-
-## 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..03d2ed76 100644
--- a/seed/nextcloud/README.md
+++ b/seed/nextcloud/README.md
@@ -5,47 +5,12 @@ include_toc: true
# nextcloud
-## Description
+## Synopsis
Nextcloud, Online collaboration platform.
[For more informations](https://nextcloud.com/)
-## Examples
-
-Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
-
-With minimum providers:
-
-```
-nextcloud:
- applicationservice: nextcloud
- zones_name:
- - ldap
- - localdns
- - reverseproxy
- - smtp
- - redis
- - oauth2
- - postgresql
-```
-
-With all providers:
-
-```
-nextcloud:
- applicationservice: nextcloud
- zones_name:
- - journald
- - ldap
- - localdns
- - reverseproxy
- - smtp
- - redis
- - oauth2
- - postgresql
-```
-
## Dependances
- [base-fedora-36](../base-fedora-36/README.md)
@@ -74,10 +39,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*)
@@ -100,4 +65,47 @@ nextcloud:
- [+]: 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:
+
+```
+nextcloud:
+ applicationservice: nextcloud
+ zones_name:
+ - ldap
+ - localdns
+ - reverseproxy
+ - smtp
+ - 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:
+
+```
+nextcloud:
+ applicationservice: nextcloud
+ zones_name:
+ - journald
+ - ldap
+ - localdns
+ - reverseproxy
+ - smtp
+ - redis
+ - oauth2
+ - postgresql
+ values:
+ general.revprox.revprox_client.revprox_client_external_domainnames:
+ - service.example.net
+ general.nextcloud.nextcloud_mail_admin: admin@example.net
+```
+
[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/nginx-common/README.md b/seed/nginx-common/README.md
index 4f12040f..38531827 100644
--- a/seed/nginx-common/README.md
+++ b/seed/nginx-common/README.md
@@ -5,7 +5,7 @@ include_toc: true
# nginx-common
-## Description
+## Synopsis
Nginx common configuration.
diff --git a/seed/nginx-https/README.md b/seed/nginx-https/README.md
index 2fcaf890..c3eb4da9 100644
--- a/seed/nginx-https/README.md
+++ b/seed/nginx-https/README.md
@@ -5,7 +5,7 @@ include_toc: true
# nginx-https
-## Description
+## Synopsis
Nginx as HTTPS web site.
diff --git a/seed/nginx-reverse-proxy/README.md b/seed/nginx-reverse-proxy/README.md
index 73ec1376..998e8732 100644
--- a/seed/nginx-reverse-proxy/README.md
+++ b/seed/nginx-reverse-proxy/README.md
@@ -5,37 +5,12 @@ include_toc: true
# nginx-reverse-proxy
-## Description
+## Synopsis
Nginx as reverse proxy.
[For more informations](https://nginx.org/)
-## Examples
-
-Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
-
-With minimum providers:
-
-```
-nginx-reverse-proxy:
- applicationservice: nginx-reverse-proxy
- provider_zone: reverseproxy
- zones_name:
- - localdns
-```
-
-With all providers:
-
-```
-nginx-reverse-proxy:
- applicationservice: nginx-reverse-proxy
- provider_zone: reverseproxy
- zones_name:
- - journald
- - localdns
-```
-
## Dependances
- [nginx-common](../nginx-common/README.md)
@@ -89,6 +64,31 @@ Paramétrage global de NGINX
- [+]: 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:
+
+```
+nginx-reverse-proxy:
+ applicationservice: nginx-reverse-proxy
+ provider_zone: reverseproxy
+ zones_name:
+ - localdns
+```
+
+With all providers:
+
+```
+nginx-reverse-proxy:
+ applicationservice: nginx-reverse-proxy
+ provider_zone: reverseproxy
+ zones_name:
+ - journald
+ - localdns
+```
+
## Supplier
[reverse-proxy-client](../reverse-proxy-client/README.md)
diff --git a/seed/nginx-static/README.md b/seed/nginx-static/README.md
index 188898ba..47aa003f 100644
--- a/seed/nginx-static/README.md
+++ b/seed/nginx-static/README.md
@@ -5,7 +5,7 @@ include_toc: true
# nginx-static
-## Description
+## Synopsis
Nginx as static web site.
diff --git a/seed/nsd-local/README.md b/seed/nsd-local/README.md
index 2b49f571..3d1ee0dc 100644
--- a/seed/nsd-local/README.md
+++ b/seed/nsd-local/README.md
@@ -5,38 +5,12 @@ include_toc: true
# nsd-local
-## Description
+## Synopsis
NSD, an authoritative DNS name server for local resolution.
[For more informations](https://www.nlnetlabs.nl/projects/nsd/about/)
-## Examples
-
-Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
-
-With minimum providers:
-
-```
-nsd-local:
- applicationservice: nsd-local
- provider_zone: localdns
- zones_name:
- - localdns
-```
-
-With all providers:
-
-```
-nsd-local:
- applicationservice: nsd-local
- provider_zone: localdns
- zones_name:
- - journald
- - externaldns
- - localdns
-```
-
## Dependances
- [nsd](../nsd/README.md)
@@ -64,6 +38,32 @@ nsd-local:
- [+]: 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:
+
+```
+nsd-local:
+ applicationservice: nsd-local
+ provider_zone: localdns
+ zones_name:
+ - localdns
+```
+
+With all providers:
+
+```
+nsd-local:
+ applicationservice: nsd-local
+ provider_zone: localdns
+ zones_name:
+ - journald
+ - externaldns
+ - localdns
+```
+
## Supplier
[dns-local](../dns-local/README.md)
diff --git a/seed/nsd/README.md b/seed/nsd/README.md
index 9bb219e3..bc154d5c 100644
--- a/seed/nsd/README.md
+++ b/seed/nsd/README.md
@@ -5,35 +5,12 @@ include_toc: true
# nsd
-## Description
+## Synopsis
NSD, an authoritative DNS name server.
[For more informations](https://www.nlnetlabs.nl/projects/nsd/about/)
-## Examples
-
-Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
-
-With minimum providers:
-
-```
-nsd:
- applicationservice: nsd
- zones_name:
- - localdns
-```
-
-With all providers:
-
-```
-nsd:
- applicationservice: nsd
- zones_name:
- - journald
- - localdns
-```
-
## Dependances
- [base-fedora-37](../base-fedora-37/README.md)
@@ -65,9 +42,9 @@ nsd:
#### Zone DNS (*general.dns_zone*)
-| Description | Type |
-|------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
-| **Zones DNS** (*[nsd_zones](dictionaries/20_nsd.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
+| Description | Example | Type |
+|------------------------------------------------------------|-----------------------|----------------------------------------------------------------------------------------------------------------------------|
+| **Zones DNS** (*[nsd_zones](dictionaries/20_nsd.xml)*) [+] | subdomain.example.net | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
#### Zone DNS reverse (*general.dns_reverses*)
@@ -111,6 +88,35 @@ 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:
+
+```
+nsd:
+ applicationservice: nsd
+ zones_name:
+ - localdns
+ values:
+ general.dns_zone.nsd_zones:
+ - subdomain.example.net
+```
+
+With all providers:
+
+```
+nsd:
+ applicationservice: nsd
+ zones_name:
+ - journald
+ - localdns
+ values:
+ general.dns_zone.nsd_zones:
+ - subdomain.example.net
+```
+
## Used by
[nsd-local](../nsd-local/README.md)
diff --git a/seed/nsd/dictionaries/20_nsd.xml b/seed/nsd/dictionaries/20_nsd.xml
index 74736b18..95890433 100644
--- a/seed/nsd/dictionaries/20_nsd.xml
+++ b/seed/nsd/dictionaries/20_nsd.xml
@@ -25,7 +25,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..378594b8 100644
--- a/seed/odoo/README.md
+++ b/seed/odoo/README.md
@@ -5,45 +5,12 @@ 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)
@@ -70,23 +37,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*)
@@ -129,4 +96,65 @@ 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
+```
+
[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 @@
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-
-
-
-
+
+
+
+
standard
standard
diff --git a/seed/openldap/README.md b/seed/openldap/README.md
index aa49dee4..99d069ed 100644
--- a/seed/openldap/README.md
+++ b/seed/openldap/README.md
@@ -5,37 +5,12 @@ include_toc: true
# openldap
-## Description
+## Synopsis
OpenLDAP, a LDAP server.
[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:
-
-```
-openldap:
- applicationservice: openldap
- provider_zone: ldap
- zones_name:
- - localdns
-```
-
-With all providers:
-
-```
-openldap:
- applicationservice: openldap
- provider_zone: ldap
- zones_name:
- - journald
- - localdns
-```
-
## Dependances
- [base-fedora-37](../base-fedora-37/README.md)
@@ -100,13 +75,13 @@ openldap:
This a family is a leadership.
-| Description | Type |
-|-------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
-| Adresse courriel du compte (*[ldap_user_mail](extras/accounts/00_account.xml)*) [+] | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
-| Aliases du mail (*[ldap_user_aliases](extras/accounts/00_account.xml)*) [+] | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
-| **Nom de compte** (*[ldap_user_uid](extras/accounts/00_account.xml)*) | [unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
-| **Prénom** (*[ldap_user_sn](extras/accounts/00_account.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
-| **Nom de famille** (*[ldap_user_gn](extras/accounts/00_account.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
+| Description | Help | Type |
+|-------------------------------------------------------------------------------------|---------------------|---------------------------------------------------------------------------------------------------------------------------|
+| Adresse courriel du compte (*[ldap_user_mail](extras/accounts/00_account.xml)*) [+] | johndoe@example.net | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
+| Aliases du mail (*[ldap_user_aliases](extras/accounts/00_account.xml)*) [+] | | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
+| **Nom de compte** (*[ldap_user_uid](extras/accounts/00_account.xml)*) | jdoe | [unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
+| **Prénom** (*[ldap_user_sn](extras/accounts/00_account.xml)*) | John | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
+| **Nom de famille** (*[ldap_user_gn](extras/accounts/00_account.xml)*) | Doe | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
#### Gestion de la famille (*accounts.family_*)
@@ -128,6 +103,31 @@ 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:
+
+```
+openldap:
+ applicationservice: openldap
+ provider_zone: ldap
+ zones_name:
+ - localdns
+```
+
+With all providers:
+
+```
+openldap:
+ applicationservice: openldap
+ provider_zone: ldap
+ zones_name:
+ - journald
+ - localdns
+```
+
## Supplier
[ldap-client](../ldap-client/README.md)
diff --git a/seed/openldap/extras/accounts/00_account.xml b/seed/openldap/extras/accounts/00_account.xml
index d858db3c..149b6e0d 100644
--- a/seed/openldap/extras/accounts/00_account.xml
+++ b/seed/openldap/extras/accounts/00_account.xml
@@ -9,11 +9,11 @@
-
+
-
-
-
+
+
+
diff --git a/seed/peertube/README.md b/seed/peertube/README.md
index c6da0cdf..f87072eb 100644
--- a/seed/peertube/README.md
+++ b/seed/peertube/README.md
@@ -5,46 +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)
@@ -79,11 +45,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 +86,46 @@ 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
+```
+
[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..7c298bb7 100644
--- a/seed/php-fpm/README.md
+++ b/seed/php-fpm/README.md
@@ -5,7 +5,7 @@ include_toc: true
# php-fpm
-## Description
+## Synopsis
PHP FPM.
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..c997f214 100644
--- a/seed/piwigo/README.md
+++ b/seed/piwigo/README.md
@@ -5,47 +5,12 @@ include_toc: true
# piwigo
-## Description
+## Synopsis
Piwigo, a photo management software.
[For more informations](http://piwigo.org/)
-## Examples
-
-Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
-
-With minimum providers:
-
-```
-piwigo:
- applicationservice: piwigo
- zones_name:
- - ldap
- - localdns
- - mariadb
- - reverseproxy
- - smtp
- - redis
- - oauth2
-```
-
-With all providers:
-
-```
-piwigo:
- applicationservice: piwigo
- zones_name:
- - journald
- - ldap
- - localdns
- - mariadb
- - reverseproxy
- - smtp
- - redis
- - oauth2
-```
-
## Dependances
- [base-fedora-36](../base-fedora-36/README.md)
@@ -75,19 +40,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*)
@@ -103,4 +68,55 @@ 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:
+
+```
+piwigo:
+ applicationservice: piwigo
+ zones_name:
+ - ldap
+ - localdns
+ - mariadb
+ - reverseproxy
+ - 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:
+
+```
+piwigo:
+ applicationservice: piwigo
+ zones_name:
+ - journald
+ - ldap
+ - localdns
+ - mariadb
+ - reverseproxy
+ - 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
+```
+
[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 @@
-
+
Album photographique
-
-
+
+
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..420c2716 100644
--- a/seed/postfix-relay/README.md
+++ b/seed/postfix-relay/README.md
@@ -5,38 +5,12 @@ include_toc: true
# postfix-relay
-## Description
+## Synopsis
Postfix, the mail server, as relay.
[For more informations](http://www.postfix.org/)
-## Examples
-
-Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
-
-With minimum providers:
-
-```
-postfix-relay:
- applicationservice: postfix-relay
- provider_zone: smtp
- zones_name:
- - localdns
-```
-
-With all providers:
-
-```
-postfix-relay:
- applicationservice: postfix-relay
- provider_zone: smtp
- zones_name:
- - journald
- - externaldns
- - localdns
-```
-
## Dependances
- [base-fedora-35](../base-fedora-35/README.md)
@@ -82,6 +56,32 @@ This a dynamic family generated from the variable "general.postfix.postfix_relay
- [+]: 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:
+
+```
+postfix-relay:
+ applicationservice: postfix-relay
+ provider_zone: smtp
+ zones_name:
+ - localdns
+```
+
+With all providers:
+
+```
+postfix-relay:
+ applicationservice: postfix-relay
+ provider_zone: smtp
+ zones_name:
+ - journald
+ - externaldns
+ - localdns
+```
+
## 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..0b32c55e 100644
--- a/seed/postgresql/README.md
+++ b/seed/postgresql/README.md
@@ -5,37 +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)
@@ -93,6 +68,31 @@ 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
+```
+
## Supplier
[postgresql-client](../postgresql-client/README.md)
diff --git a/seed/prometheus/README.md b/seed/prometheus/README.md
index 0367bb4d..001da8cd 100644
--- a/seed/prometheus/README.md
+++ b/seed/prometheus/README.md
@@ -5,37 +5,12 @@ include_toc: true
# prometheus
-## Description
+## Synopsis
Prometheus, an event monitoring.
[For more informations](https://prometheus.io/)
-## Examples
-
-Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
-
-With minimum providers:
-
-```
-prometheus:
- applicationservice: prometheus
- provider_zone: prometheus
- zones_name:
- - localdns
-```
-
-With all providers:
-
-```
-prometheus:
- applicationservice: prometheus
- provider_zone: prometheus
- zones_name:
- - journald
- - localdns
-```
-
## Dependances
- [base-fedora-38](../base-fedora-38/README.md)
@@ -62,6 +37,31 @@ 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.
+
+With minimum providers:
+
+```
+prometheus:
+ applicationservice: prometheus
+ provider_zone: prometheus
+ zones_name:
+ - localdns
+```
+
+With all providers:
+
+```
+prometheus:
+ applicationservice: prometheus
+ provider_zone: prometheus
+ zones_name:
+ - journald
+ - localdns
+```
+
## 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..1279794e 100644
--- a/seed/provider-systemd-machined/README.md
+++ b/seed/provider-systemd-machined/README.md
@@ -5,7 +5,7 @@ include_toc: true
# provider-systemd-machined
-## Description
+## Synopsis
Machine started in Systemd Machined environment.
diff --git a/seed/redis-client/README.md b/seed/redis-client/README.md
index 765ac65d..c6af4a95 100644
--- a/seed/redis-client/README.md
+++ b/seed/redis-client/README.md
@@ -5,7 +5,7 @@ include_toc: true
# redis-client
-## Description
+## Synopsis
Application service needs interact with a Redis server.
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..7c9d44e7 100644
--- a/seed/redis/README.md
+++ b/seed/redis/README.md
@@ -5,37 +5,12 @@ include_toc: true
# redis
-## Description
+## Synopsis
Redis, an in-memory data structure store.
[For more informations](https://redis.io/)
-## Examples
-
-Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
-
-With minimum providers:
-
-```
-redis:
- applicationservice: redis
- provider_zone: redis
- zones_name:
- - localdns
-```
-
-With all providers:
-
-```
-redis:
- applicationservice: redis
- provider_zone: redis
- zones_name:
- - journald
- - localdns
-```
-
## Dependances
- [base-fedora-38](../base-fedora-38/README.md)
@@ -80,6 +55,31 @@ 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:
+
+```
+redis:
+ applicationservice: redis
+ provider_zone: redis
+ zones_name:
+ - localdns
+```
+
+With all providers:
+
+```
+redis:
+ applicationservice: redis
+ provider_zone: redis
+ zones_name:
+ - journald
+ - localdns
+```
+
## 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..1fc28208 100644
--- a/seed/relay-lmtp-client/README.md
+++ b/seed/relay-lmtp-client/README.md
@@ -5,7 +5,7 @@ include_toc: true
# relay-lmtp-client
-## Description
+## Synopsis
Application service needs interact with a Postfix server with LMTP protocol.
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/reverse-proxy-client/funcs/revprox_client.py b/seed/reverse-proxy-client/funcs/revprox_client.py
index d7ef8c71..1d56324c 100644
--- a/seed/reverse-proxy-client/funcs/revprox_client.py
+++ b/seed/reverse-proxy-client/funcs/revprox_client.py
@@ -16,12 +16,3 @@ def calc_web_address(domain_name: str=None,
if local_location:
web_address += local_location
return web_address
-
-
-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/roundcube/README.md b/seed/roundcube/README.md
index fea6fe4c..6fa3db04 100644
--- a/seed/roundcube/README.md
+++ b/seed/roundcube/README.md
@@ -5,47 +5,12 @@ include_toc: true
# roundcube
-## Description
+## Synopsis
Roundcube, a webmail.
[For more informations](https://roundcube.net/)
-## Examples
-
-Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
-
-With minimum providers:
-
-```
-roundcube:
- applicationservice: roundcube
- zones_name:
- - ldap
- - localdns
- - reverseproxy
- - imap
- - redis
- - oauth2
- - postgresql
-```
-
-With all providers:
-
-```
-roundcube:
- applicationservice: roundcube
- zones_name:
- - journald
- - ldap
- - localdns
- - reverseproxy
- - imap
- - redis
- - oauth2
- - postgresql
-```
-
## Dependances
- [base-fedora-36](../base-fedora-36/README.md)
@@ -79,11 +44,11 @@ roundcube:
This a family is a leadership.
-| Description | Type |
-|----------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
-| **Nom de domaines d'accès à Roundcube** (*[roundcube_domains](dictionaries/31_roundcube.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
-| **Nom de domaines des courriels** (*[roundcube_mail_domain](dictionaries/31_roundcube.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
-| Nom de la famille (*[roundcube_family](dictionaries/31_roundcube.xml)*) | [unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
+| Description | Example | Type |
+|----------------------------------------------------------------------------------------------------|---------------------|----------------------------------------------------------------------------------------------------------------------------|
+| **Nom de domaines d'accès à Roundcube** (*[roundcube_domains](dictionaries/31_roundcube.xml)*) [+] | webmail.example.net | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
+| **Nom de domaines des courriels** (*[roundcube_mail_domain](dictionaries/31_roundcube.xml)*) | mail.example.net | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
+| Nom de la famille (*[roundcube_family](dictionaries/31_roundcube.xml)*) | | [unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
#### oauth2_client (*general.oauth2_client*)
@@ -135,4 +100,49 @@ 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:
+
+```
+roundcube:
+ applicationservice: roundcube
+ zones_name:
+ - ldap
+ - localdns
+ - reverseproxy
+ - imap
+ - redis
+ - oauth2
+ - postgresql
+ values:
+ general.roundcube.roundcube_domain.roundcube_domains:
+ - webmail.example.net
+ general.roundcube.roundcube_domain.roundcube_mail_domain:
+ '0': mail.example.net
+```
+
+With all providers:
+
+```
+roundcube:
+ applicationservice: roundcube
+ zones_name:
+ - journald
+ - ldap
+ - localdns
+ - reverseproxy
+ - imap
+ - redis
+ - oauth2
+ - postgresql
+ values:
+ general.roundcube.roundcube_domain.roundcube_domains:
+ - webmail.example.net
+ general.roundcube.roundcube_domain.roundcube_mail_domain:
+ '0': mail.example.net
+```
+
[All applications services for this dataset.](../README.md)
diff --git a/seed/roundcube/dictionaries/31_roundcube.xml b/seed/roundcube/dictionaries/31_roundcube.xml
index 855a6c85..f6ab4945 100644
--- a/seed/roundcube/dictionaries/31_roundcube.xml
+++ b/seed/roundcube/dictionaries/31_roundcube.xml
@@ -15,8 +15,8 @@
-
-
+
+
diff --git a/seed/speedtest-rs/README.md b/seed/speedtest-rs/README.md
index bdbbfadb..6b528096 100644
--- a/seed/speedtest-rs/README.md
+++ b/seed/speedtest-rs/README.md
@@ -5,37 +5,12 @@ include_toc: true
# speedtest-rs
-## Description
+## Synopsis
Speedtest-rs, a very lightweight Speedtest.
[For more informations](https://cloud.silique.fr/gitea/Silique/speedtest-rs)
-## Examples
-
-Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
-
-With minimum providers:
-
-```
-speedtest-rs:
- applicationservice: speedtest-rs
- zones_name:
- - localdns
- - reverseproxy
-```
-
-With all providers:
-
-```
-speedtest-rs:
- applicationservice: speedtest-rs
- zones_name:
- - journald
- - localdns
- - reverseproxy
-```
-
## Dependances
- [base-fedora-36](../base-fedora-36/README.md)
@@ -72,4 +47,35 @@ speedtest-rs:
- [+]: 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:
+
+```
+speedtest-rs:
+ applicationservice: speedtest-rs
+ zones_name:
+ - localdns
+ - reverseproxy
+ values:
+ general.revprox.revprox_client.revprox_client_external_domainnames:
+ - service.example.net
+```
+
+With all providers:
+
+```
+speedtest-rs:
+ applicationservice: speedtest-rs
+ zones_name:
+ - journald
+ - localdns
+ - reverseproxy
+ values:
+ general.revprox.revprox_client.revprox_client_external_domainnames:
+ - service.example.net
+```
+
[All applications services for this dataset.](../README.md)
diff --git a/seed/systemd/README.md b/seed/systemd/README.md
index 3bb1a019..40f8595c 100644
--- a/seed/systemd/README.md
+++ b/seed/systemd/README.md
@@ -5,7 +5,7 @@ include_toc: true
# systemd
-## Description
+## Synopsis
Systemd, a system and service manager.
diff --git a/seed/unbound/README.md b/seed/unbound/README.md
index 713903f0..a495b5d3 100644
--- a/seed/unbound/README.md
+++ b/seed/unbound/README.md
@@ -5,38 +5,12 @@ include_toc: true
# unbound
-## Description
+## Synopsis
Unbound, a validating, recursive, caching DNS resolver.
[For more informations](https://www.nlnetlabs.nl/projects/unbound/about/)
-## Examples
-
-Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
-
-With minimum providers:
-
-```
-unbound:
- applicationservice: unbound
- provider_zone: externaldns
- zones_name:
- - localdns
-```
-
-With all providers:
-
-```
-unbound:
- applicationservice: unbound
- provider_zone: externaldns
- zones_name:
- - journald
- - externaldns
- - localdns
-```
-
## Dependances
- [dns-external](../dns-external/README.md)
@@ -63,9 +37,9 @@ unbound:
#### Résolveur DNS (*general.dns_resolver*)
-| Description |
-|------------------------------------------------------------------------------------------------------|
-| **Serveur résolveur DNS par défaut** (*[unbound_default_forwards](dictionaries/20_unbound.xml)*) [+] |
+| Description | Example |
+|------------------------------------------------------------------------------------------------------|-----------|
+| **Serveur résolveur DNS par défaut** (*[unbound_default_forwards](dictionaries/20_unbound.xml)*) [+] | 9.9.9.9 |
##### Serveur DNS faisant autorité sur une zone particulière (*general.dns_resolver.forward_zones*)
@@ -89,6 +63,38 @@ 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:
+
+```
+unbound:
+ applicationservice: unbound
+ provider_zone: externaldns
+ zones_name:
+ - localdns
+ values:
+ general.dns_resolver.unbound_default_forwards:
+ - 9.9.9.9
+```
+
+With all providers:
+
+```
+unbound:
+ applicationservice: unbound
+ provider_zone: externaldns
+ zones_name:
+ - journald
+ - externaldns
+ - localdns
+ values:
+ general.dns_resolver.unbound_default_forwards:
+ - 9.9.9.9
+```
+
## Suppliers
- [dns-external](../dns-external/README.md)
diff --git a/seed/unbound/dictionaries/20_unbound.xml b/seed/unbound/dictionaries/20_unbound.xml
index 4c12fd75..342789ac 100644
--- a/seed/unbound/dictionaries/20_unbound.xml
+++ b/seed/unbound/dictionaries/20_unbound.xml
@@ -31,7 +31,7 @@
-
+
diff --git a/seed/vaultwarden/README.md b/seed/vaultwarden/README.md
index 1a592c4d..72b3d85f 100644
--- a/seed/vaultwarden/README.md
+++ b/seed/vaultwarden/README.md
@@ -5,41 +5,12 @@ include_toc: true
# vaultwarden
-## Description
+## Synopsis
Vaultwarden, a password manager.
[For more informations](https://github.com/dani-garcia/vaultwarden)
-## Examples
-
-Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
-
-With minimum providers:
-
-```
-vaultwarden:
- applicationservice: vaultwarden
- zones_name:
- - localdns
- - reverseproxy
- - smtp
- - postgresql
-```
-
-With all providers:
-
-```
-vaultwarden:
- applicationservice: vaultwarden
- zones_name:
- - journald
- - localdns
- - reverseproxy
- - smtp
- - postgresql
-```
-
## Dependances
- [base-fedora-36](../base-fedora-36/README.md)
@@ -67,13 +38,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*)
@@ -85,4 +56,39 @@ 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.
+
+With minimum providers:
+
+```
+vaultwarden:
+ applicationservice: vaultwarden
+ zones_name:
+ - localdns
+ - reverseproxy
+ - smtp
+ - postgresql
+ values:
+ general.vaultwarden.vaultwarden_domainname: vault.example.net
+ general.vaultwarden.vaultwarden_admin_email: admin@example.net
+```
+
+With all providers:
+
+```
+vaultwarden:
+ applicationservice: vaultwarden
+ zones_name:
+ - journald
+ - localdns
+ - reverseproxy
+ - smtp
+ - postgresql
+ values:
+ general.vaultwarden.vaultwarden_domainname: vault.example.net
+ general.vaultwarden.vaultwarden_admin_email: admin@example.net
+```
+
[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
-
+
20
diff --git a/seed/vector/README.md b/seed/vector/README.md
index b0f2af6d..b561306f 100644
--- a/seed/vector/README.md
+++ b/seed/vector/README.md
@@ -5,39 +5,12 @@ include_toc: true
# vector
-## Description
+## Synopsis
Vector, a lightweight, ultra-fast tool for building observability pipelines.
[For more informations](https://vector.dev/)
-## Examples
-
-Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
-
-With minimum providers:
-
-```
-vector:
- applicationservice: vector
- provider_zone: journald
- zones_name:
- - localdns
- - loki
-```
-
-With all providers:
-
-```
-vector:
- applicationservice: vector
- provider_zone: journald
- zones_name:
- - journald
- - localdns
- - loki
-```
-
## Dependances
- [base-fedora-38](../base-fedora-38/README.md)
@@ -71,6 +44,33 @@ vector:
- [+]: 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:
+
+```
+vector:
+ applicationservice: vector
+ provider_zone: journald
+ zones_name:
+ - localdns
+ - loki
+```
+
+With all providers:
+
+```
+vector:
+ applicationservice: vector
+ provider_zone: journald
+ zones_name:
+ - journald
+ - localdns
+ - loki
+```
+
## Supplier
[host-systemd-machined](../host-systemd-machined/README.md)
diff --git a/seed/znc/README.md b/seed/znc/README.md
index 704770e6..854108e9 100644
--- a/seed/znc/README.md
+++ b/seed/znc/README.md
@@ -5,36 +5,12 @@ include_toc: true
# znc
-## Description
+## Synopsis
ZNC, a bouncer IRC.
[For more informations](https://wiki.znc.in/)
-## Examples
-
-Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
-
-With minimum providers:
-
-```
-znc:
- applicationservice: znc
- zones_name:
- - localdns
-```
-
-With all providers:
-
-```
-znc:
- applicationservice: znc
- zones_name:
- - journald
- - externaldns
- - localdns
-```
-
## Dependances
- [base-fedora-36](../base-fedora-36/README.md)
@@ -60,23 +36,23 @@ znc:
#### IRC Bouncer ZNC (*general.znc*)
-| Description | Type | Values | Choices |
-|--------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|-----------|----------------------------|
-| **Nom de domaine externe de ZNC** (*[external_domain_name](dictionaries/40_znc.xml)*) | [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** (*[znc_crt_provider](dictionaries/40_znc.xml)*) | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | autosigne | autosigne
letsencrypt |
-| **Utilisateur IRC et ZNC** (*[user_name](dictionaries/40_znc.xml)*) | [unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
-| **Mot de passe de l'utilisateur ZNC** (*[user_password](dictionaries/40_znc.xml)*) | [password](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
-| **Nom d'utilisateur réel** (*[real_name](dictionaries/40_znc.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
+| Description | Example | Type | Values | Choices |
+|--------------------------------------------------------------------------------------------------------------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------|-----------|----------------------------|
+| **Nom de domaine externe de ZNC** (*[external_domain_name](dictionaries/40_znc.xml)*) | irc.example.net | [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** (*[znc_crt_provider](dictionaries/40_znc.xml)*) | | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | autosigne | autosigne
letsencrypt |
+| **Utilisateur IRC et ZNC** (*[user_name](dictionaries/40_znc.xml)*) | jdoe | [unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
+| **Mot de passe de l'utilisateur ZNC** (*[user_password](dictionaries/40_znc.xml)*) | JD0eP@ss | [password](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
+| **Nom d'utilisateur réel** (*[real_name](dictionaries/40_znc.xml)*) | John Doe | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
##### Serveurs IRC (*general.znc.servers*)
This a family is a leadership.
-| Description | Type |
-|----------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
-| **Adresse du serveur IRC** (*[server_names](dictionaries/40_znc.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
-| **Mot de passe de l'utilisateur sur le serveur IRC** (*[password](dictionaries/40_znc.xml)*) | [password](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
-| **Nom des salons du serveur IRC** (*[channels](dictionaries/40_znc.xml)*) [+] | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
+| Description | Example | Type |
+|----------------------------------------------------------------------------------------------|--------------|----------------------------------------------------------------------------------------------------------------------------|
+| **Adresse du serveur IRC** (*[server_names](dictionaries/40_znc.xml)*) [+] | irc.oftc.net | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
+| **Mot de passe de l'utilisateur sur le serveur IRC** (*[password](dictionaries/40_znc.xml)*) | p@ssw0rd | [password](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
+| **Nom des salons du serveur IRC** (*[channels](dictionaries/40_znc.xml)*) [+] | example | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
### Machine (*machine*)
@@ -90,4 +66,50 @@ 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:
+
+```
+znc:
+ applicationservice: znc
+ zones_name:
+ - localdns
+ values:
+ general.znc.external_domain_name: irc.example.net
+ general.znc.user_name: jdoe
+ general.znc.user_password: JD0eP@ss
+ general.znc.real_name: John Doe
+ general.znc.servers.server_names:
+ - irc.oftc.net
+ general.znc.servers.password:
+ '0': p@ssw0rd
+ general.znc.servers.channels:
+ '0': example
+```
+
+With all providers:
+
+```
+znc:
+ applicationservice: znc
+ zones_name:
+ - journald
+ - externaldns
+ - localdns
+ values:
+ general.znc.external_domain_name: irc.example.net
+ general.znc.user_name: jdoe
+ general.znc.user_password: JD0eP@ss
+ general.znc.real_name: John Doe
+ general.znc.servers.server_names:
+ - irc.oftc.net
+ general.znc.servers.password:
+ '0': p@ssw0rd
+ general.znc.servers.channels:
+ '0': example
+```
+
[All applications services for this dataset.](../README.md)
diff --git a/seed/znc/dictionaries/40_znc.xml b/seed/znc/dictionaries/40_znc.xml
index e6704fe7..3f51846d 100644
--- a/seed/znc/dictionaries/40_znc.xml
+++ b/seed/znc/dictionaries/40_znc.xml
@@ -17,22 +17,22 @@
-
+
autosigne
autosigne
letsencrypt
-
-
-
+
+
+
-
-
+
+
6697
-
+