From 9b48791d1bfa77e7b44acdbd1b4bd75338947fc9 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Fri, 11 Aug 2023 09:38:05 +0200 Subject: [PATCH] update doc --- seed/README.md | 145 +++++++++++++++--- seed/apache/README.md | 9 +- seed/base-debian-bullseye/README.md | 7 +- seed/base-debian/README.md | 7 +- seed/base-fedora-35/README.md | 7 +- seed/base-fedora-36/README.md | 7 +- seed/base-fedora-37/README.md | 7 +- seed/base-fedora-38/README.md | 7 +- seed/base-fedora/README.md | 7 +- seed/base-machine/README.md | 4 +- seed/base/README.md | 4 +- seed/dns-external/README.md | 20 +-- .../dictionaries/14_dns-external.xml | 2 +- seed/dns-local/README.md | 8 +- seed/dovecot/README.md | 77 +++++----- seed/dovecot/applicationservice.yml | 3 +- seed/dovecot/dictionaries/31_dovecot.xml | 12 +- seed/forgejo/README.md | 69 ++++----- seed/gitea/README.md | 68 ++++---- seed/grafana/README.md | 58 ++++--- seed/host-systemd-machined/README.md | 31 ++-- .../dictionaries/21_machined.xml | 4 +- .../extras/machined/00_machined.xml | 2 +- seed/imap-client/README.md | 8 +- .../dictionaries/21_imap_client.xml | 2 +- seed/journald/README.md | 11 +- seed/journald/dictionaries/20_journald.xml | 2 +- seed/journald_remote/README.md | 11 +- .../extras/accounts/00_accounts.xml | 4 +- seed/ldap-client/README.md | 22 +-- .../dictionaries/21_ldap-client.xml | 26 ++-- seed/lemonldap/README.md | 79 +++++----- seed/lemonldap/extras/oauth2/00_oauth2.xml | 6 +- seed/loki/README.md | 20 ++- seed/loki/dictionaries/20_loki.xml | 2 +- seed/mailman/README.md | 70 ++++----- seed/mariadb-client/README.md | 11 +- .../dictionaries/20_mariadb.xml | 4 +- seed/mariadb/README.md | 20 ++- seed/mariadb/extras/accounts/00_accounts.xml | 10 +- seed/nextcloud/README.md | 110 ++++++------- seed/nginx-common/README.md | 19 +-- seed/nginx-https/README.md | 7 +- seed/nginx-reverse-proxy/README.md | 60 +++++--- .../dictionaries/25_nginx.xml | 2 +- .../extras/nginx/00_nginx.xml | 2 +- seed/nginx-static/README.md | 54 +++---- seed/nsd-local/README.md | 49 ++++-- seed/nsd-local/dictionaries/21_nsd-local.xml | 2 +- seed/nsd/README.md | 18 ++- seed/oauth2-client/README.md | 10 +- .../dictionaries/30_oauth2_client.xml | 6 +- seed/odoo/README.md | 82 +++++----- seed/openldap/README.md | 28 ++-- seed/openldap/extras/accounts/00_account.xml | 2 +- seed/peertube/README.md | 83 +++++----- seed/php-fpm/README.md | 4 +- seed/php/README.md | 30 ++-- seed/piwigo/README.md | 106 ++++++------- seed/pki-tls/README.md | 4 +- seed/postfix-lmtp-relay/README.md | 11 +- .../extras/lmtp/00_lmtp.xml | 6 +- seed/postfix-relay/README.md | 47 ++++-- .../postfix-relay/dictionaries/30_postfix.xml | 8 +- seed/postgresql-client/README.md | 25 +-- .../dictionaries/23_postgresql.xml | 10 +- seed/postgresql/README.md | 40 ++--- .../extras/accounts/00_accounts.xml | 10 +- seed/prometheus/README.md | 20 +-- .../prometheus/dictionaries/20_prometheus.xml | 2 +- seed/provider-systemd-machined/README.md | 36 +---- seed/redis-client/README.md | 24 +-- seed/redis-client/dictionaries/23_redis.xml | 12 +- seed/redis-common/README.md | 7 +- seed/redis/README.md | 37 +++-- seed/relay-lmtp-client/README.md | 8 +- .../dictionaries/30_lmtp.xml | 2 +- seed/relay-mail-client/README.md | 8 +- .../dictionaries/20_smtp_client.xml | 6 +- seed/resolved/README.md | 7 +- seed/reverse-proxy-client/README.md | 30 ++-- seed/roundcube/README.md | 97 ++++-------- seed/speedtest-rs/README.md | 40 ++--- seed/systemd/README.md | 7 +- seed/unbound/README.md | 24 +-- seed/unbound/dictionaries/20_unbound.xml | 8 +- seed/vaultwarden/README.md | 41 ++--- seed/vector/README.md | 54 +++++-- seed/vector/dictionaries/20_vector.xml | 6 +- seed/znc/README.md | 56 ++++--- seed/znc/dictionaries/40_znc.xml | 2 +- 91 files changed, 1084 insertions(+), 1158 deletions(-) diff --git a/seed/README.md b/seed/README.md index e13feb2..416df8f 100644 --- a/seed/README.md +++ b/seed/README.md @@ -1,6 +1,6 @@ # Application services -- [dovecot](dovecot/README.md): Postfix and Dovecot as mail servers (Submission and IMAP) +- [dovecot](dovecot/README.md): Postfix and Dovecot as mail servers (IMAP and submission) - [forgejo](forgejo/README.md): Forgejo, a community managed lightweight code hosting solution - [gitea](gitea/README.md): Transitional package for Gitea to Forgejo - [grafana](grafana/README.md): Grafana is an analytics and interactive visualization web application @@ -77,50 +77,155 @@ - ExternalDNS: - Provider: [unbound](unbound/README.md) - Suppliers: - - [dns-external](dns-external/README.md) + - [postfix-relay](postfix-relay/README.md) + - [peertube](peertube/README.md) + - [znc](znc/README.md) - [nsd-local](nsd-local/README.md) -- Host: - - Provider: [host-systemd-machined](host-systemd-machined/README.md) - - Supplier: [provider-systemd-machined](provider-systemd-machined/README.md) - IMAP: - Provider: [dovecot](dovecot/README.md) - - Supplier: [imap-client](imap-client/README.md) + - Supplier: [roundcube](roundcube/README.md) - Journald: - - Provider: [journald_remote](journald_remote/README.md) - - Supplier: [journald](journald/README.md) + - Provider: [vector](vector/README.md) + - Suppliers: + - [odoo](odoo/README.md) + - [nginx-static](nginx-static/README.md) + - [grafana](grafana/README.md) + - [postgresql](postgresql/README.md) + - [postfix-relay](postfix-relay/README.md) + - [mailman](mailman/README.md) + - [peertube](peertube/README.md) + - [piwigo](piwigo/README.md) + - [vector](vector/README.md) + - [dovecot](dovecot/README.md) + - [unbound](unbound/README.md) + - [redis](redis/README.md) + - [loki](loki/README.md) + - [forgejo](forgejo/README.md) + - [nsd](nsd/README.md) + - [speedtest-rs](speedtest-rs/README.md) + - [nginx-reverse-proxy](nginx-reverse-proxy/README.md) + - [roundcube](roundcube/README.md) + - [znc](znc/README.md) + - [vaultwarden](vaultwarden/README.md) + - [prometheus](prometheus/README.md) + - [mariadb](mariadb/README.md) + - [nsd-local](nsd-local/README.md) + - [nextcloud](nextcloud/README.md) + - [lemonldap](lemonldap/README.md) + - [openldap](openldap/README.md) + - [gitea](gitea/README.md) - LDAP: - Provider: [openldap](openldap/README.md) - - Supplier: [ldap-client](ldap-client/README.md) + - Suppliers: + - [odoo](odoo/README.md) + - [piwigo](piwigo/README.md) + - [dovecot](dovecot/README.md) + - [roundcube](roundcube/README.md) + - [nextcloud](nextcloud/README.md) + - [lemonldap](lemonldap/README.md) - LMTP: - - Provider: [postfix-lmtp-relay](postfix-lmtp-relay/README.md) - - Supplier: [relay-lmtp-client](relay-lmtp-client/README.md) + - Provider: [postfix-relay](postfix-relay/README.md) + - Suppliers: + - [mailman](mailman/README.md) + - [dovecot](dovecot/README.md) - LocalDNS: - Provider: [nsd-local](nsd-local/README.md) - - Supplier: [dns-local](dns-local/README.md) + - Suppliers: + - [odoo](odoo/README.md) + - [nginx-static](nginx-static/README.md) + - [grafana](grafana/README.md) + - [postgresql](postgresql/README.md) + - [mailman](mailman/README.md) + - [piwigo](piwigo/README.md) + - [vector](vector/README.md) + - [dovecot](dovecot/README.md) + - [redis](redis/README.md) + - [loki](loki/README.md) + - [forgejo](forgejo/README.md) + - [nsd](nsd/README.md) + - [speedtest-rs](speedtest-rs/README.md) + - [nginx-reverse-proxy](nginx-reverse-proxy/README.md) + - [roundcube](roundcube/README.md) + - [vaultwarden](vaultwarden/README.md) + - [prometheus](prometheus/README.md) + - [mariadb](mariadb/README.md) + - [nsd-local](nsd-local/README.md) + - [nextcloud](nextcloud/README.md) + - [lemonldap](lemonldap/README.md) + - [openldap](openldap/README.md) + - [gitea](gitea/README.md) - Loki: - Provider: [loki](loki/README.md) - Supplier: [vector](vector/README.md) - MariaDB: - Provider: [mariadb](mariadb/README.md) - - Supplier: [mariadb-client](mariadb-client/README.md) + - Supplier: [piwigo](piwigo/README.md) - OAuth2: - Provider: [lemonldap](lemonldap/README.md) - - Supplier: [oauth2-client](oauth2-client/README.md) + - Suppliers: + - [odoo](odoo/README.md) + - [grafana](grafana/README.md) + - [mailman](mailman/README.md) + - [peertube](peertube/README.md) + - [piwigo](piwigo/README.md) + - [dovecot](dovecot/README.md) + - [forgejo](forgejo/README.md) + - [roundcube](roundcube/README.md) + - [nextcloud](nextcloud/README.md) + - [gitea](gitea/README.md) - Postgresql: - Provider: [postgresql](postgresql/README.md) - - Supplier: [postgresql-client](postgresql-client/README.md) + - Suppliers: + - [odoo](odoo/README.md) + - [grafana](grafana/README.md) + - [mailman](mailman/README.md) + - [peertube](peertube/README.md) + - [forgejo](forgejo/README.md) + - [roundcube](roundcube/README.md) + - [vaultwarden](vaultwarden/README.md) + - [nextcloud](nextcloud/README.md) + - [gitea](gitea/README.md) - Prometheus: - Provider: [prometheus](prometheus/README.md) - - Supplier: [host-systemd-machined](host-systemd-machined/README.md) - Redis: - Provider: [redis](redis/README.md) - - Supplier: [redis-client](redis-client/README.md) + - Suppliers: + - [peertube](peertube/README.md) + - [piwigo](piwigo/README.md) + - [forgejo](forgejo/README.md) + - [roundcube](roundcube/README.md) + - [nextcloud](nextcloud/README.md) + - [gitea](gitea/README.md) - ReverseProxy: - Provider: [nginx-reverse-proxy](nginx-reverse-proxy/README.md) - - Supplier: [reverse-proxy-client](reverse-proxy-client/README.md) + - Suppliers: + - [odoo](odoo/README.md) + - [nginx-static](nginx-static/README.md) + - [grafana](grafana/README.md) + - [mailman](mailman/README.md) + - [peertube](peertube/README.md) + - [piwigo](piwigo/README.md) + - [dovecot](dovecot/README.md) + - [forgejo](forgejo/README.md) + - [speedtest-rs](speedtest-rs/README.md) + - [roundcube](roundcube/README.md) + - [vaultwarden](vaultwarden/README.md) + - [nextcloud](nextcloud/README.md) + - [lemonldap](lemonldap/README.md) + - [gitea](gitea/README.md) - SMTP: - Provider: [postfix-relay](postfix-relay/README.md) - - Supplier: [relay-mail-client](relay-mail-client/README.md) + - Suppliers: + - [odoo](odoo/README.md) + - [grafana](grafana/README.md) + - [mailman](mailman/README.md) + - [peertube](peertube/README.md) + - [piwigo](piwigo/README.md) + - [dovecot](dovecot/README.md) + - [forgejo](forgejo/README.md) + - [vaultwarden](vaultwarden/README.md) + - [nextcloud](nextcloud/README.md) + - [lemonldap](lemonldap/README.md) + - [gitea](gitea/README.md) - Vector: - Provider: [vector](vector/README.md) - - Supplier: [host-systemd-machined](host-systemd-machined/README.md) diff --git a/seed/apache/README.md b/seed/apache/README.md index 661853c..e35218e 100644 --- a/seed/apache/README.md +++ b/seed/apache/README.md @@ -3,19 +3,20 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # apache ## Synopsis -Apache as web server. -[Software's website.](https://httpd.apache.org/) +[Apache as web server.](https://httpd.apache.org/) ## Variables for expert -### Général +### General #### Apache @@ -33,5 +34,3 @@ Paramètrage avancé du serveur web Apache. ## Used by [nextcloud](../nextcloud/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/base-debian-bullseye/README.md b/seed/base-debian-bullseye/README.md index ec2829e..b64d6fe 100644 --- a/seed/base-debian-bullseye/README.md +++ b/seed/base-debian-bullseye/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # base-debian-bullseye ## Synopsis -Base information of a Debian Bulleye server. -[Software's website.](https://www.debian.org/) +[Base information of a Debian Bulleye server.](https://www.debian.org/) ## Dependances @@ -27,5 +28,3 @@ Base information of a Debian Bulleye server. - [odoo](../odoo/README.md) - [mailman](../mailman/README.md) - [lemonldap](../lemonldap/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/base-debian/README.md b/seed/base-debian/README.md index 455c6d1..91512b3 100644 --- a/seed/base-debian/README.md +++ b/seed/base-debian/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # base-debian ## Synopsis -Base information of a Debian server. -[Software's website.](https://www.debian.org/) +[Base information of a Debian server.](https://www.debian.org/) ## Dependances @@ -24,5 +25,3 @@ Base information of a Debian server. ## Used by [base-debian-bullseye](../base-debian-bullseye/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/base-fedora-35/README.md b/seed/base-fedora-35/README.md index a8164be..1e793b0 100644 --- a/seed/base-fedora-35/README.md +++ b/seed/base-fedora-35/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # base-fedora-35 ## Synopsis -Base information of a Fedora 35. -[Software's website.](https://getfedora.org/) +[Base information of a Fedora 35.](https://getfedora.org/) ## Dependances @@ -25,5 +26,3 @@ Base information of a Fedora 35. ## Used by [postfix-relay](../postfix-relay/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/base-fedora-36/README.md b/seed/base-fedora-36/README.md index 03ef07a..083a163 100644 --- a/seed/base-fedora-36/README.md +++ b/seed/base-fedora-36/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # base-fedora-36 ## Synopsis -Base information of a Fedora 36. -[Software's website.](https://getfedora.org/) +[Base information of a Fedora 36.](https://getfedora.org/) ## Dependances @@ -32,5 +33,3 @@ Base information of a Fedora 36. - [vaultwarden](../vaultwarden/README.md) - [mariadb](../mariadb/README.md) - [nextcloud](../nextcloud/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/base-fedora-37/README.md b/seed/base-fedora-37/README.md index d847226..8a5bb61 100644 --- a/seed/base-fedora-37/README.md +++ b/seed/base-fedora-37/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # base-fedora-37 ## Synopsis -Base information of a Fedora 37. -[Software's website.](https://getfedora.org/) +[Base information of a Fedora 37.](https://getfedora.org/) ## Dependances @@ -30,5 +31,3 @@ Base information of a Fedora 37. - [nsd](../nsd/README.md) - [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) - [openldap](../openldap/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/base-fedora-38/README.md b/seed/base-fedora-38/README.md index 1e0f435..1d808c9 100644 --- a/seed/base-fedora-38/README.md +++ b/seed/base-fedora-38/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # base-fedora-38 ## Synopsis -Base information of a Fedora 38. -[Software's website.](https://getfedora.org/) +[Base information of a Fedora 38.](https://getfedora.org/) ## Dependances @@ -31,5 +32,3 @@ Base information of a Fedora 38. - [loki](../loki/README.md) - [forgejo](../forgejo/README.md) - [prometheus](../prometheus/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/base-fedora/README.md b/seed/base-fedora/README.md index e532760..a4960c4 100644 --- a/seed/base-fedora/README.md +++ b/seed/base-fedora/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # base-fedora ## Synopsis -Base information of a Fedora. -[Software's website.](https://getfedora.org/) +[Base information of a Fedora.](https://getfedora.org/) ## Dependances @@ -27,5 +28,3 @@ Base information of a Fedora. - [base-fedora-35](../base-fedora-35/README.md) - [base-fedora-38](../base-fedora-38/README.md) - [base-fedora-37](../base-fedora-37/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/base-machine/README.md b/seed/base-machine/README.md index 1852ce7..9bf0697 100644 --- a/seed/base-machine/README.md +++ b/seed/base-machine/README.md @@ -3,6 +3,8 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # base-machine ## Synopsis @@ -28,5 +30,3 @@ Base information for a machine. ## Used by [systemd](../systemd/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/base/README.md b/seed/base/README.md index b830844..e95b57d 100644 --- a/seed/base/README.md +++ b/seed/base/README.md @@ -3,6 +3,8 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # base ## Synopsis @@ -13,5 +15,3 @@ Base of all application services. - [host-systemd-machined](../host-systemd-machined/README.md) - [base-machine](../base-machine/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/dns-external/README.md b/seed/dns-external/README.md index 56cb808..7f5d073 100644 --- a/seed/dns-external/README.md +++ b/seed/dns-external/README.md @@ -3,33 +3,17 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # dns-external ## Synopsis DNS client with resolution on all zones (especially outside). - -## Variables - -### Général - -#### network - -| Parameter | Comments | -|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| **[general.network.dns_is_only_local](dictionaries/14_dns-external.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | **Default:** False | - - ## Used by - [postfix-relay](../postfix-relay/README.md) - [peertube](../peertube/README.md) - [unbound](../unbound/README.md) - [znc](../znc/README.md) - -## Provider - -[unbound](../unbound/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/dns-external/dictionaries/14_dns-external.xml b/seed/dns-external/dictionaries/14_dns-external.xml index 06f3b08..d6b30b7 100644 --- a/seed/dns-external/dictionaries/14_dns-external.xml +++ b/seed/dns-external/dictionaries/14_dns-external.xml @@ -5,7 +5,7 @@ False - + - + - + - + self-signed self-signed letsencrypt - + diff --git a/seed/forgejo/README.md b/seed/forgejo/README.md index 1454e67..fc2819f 100644 --- a/seed/forgejo/README.md +++ b/seed/forgejo/README.md @@ -3,28 +3,29 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # forgejo ## Synopsis -Forgejo, a community managed lightweight code hosting solution. -[Software's website.](https://forgejo.org/) +[Forgejo, a community managed lightweight code hosting solution.](https://forgejo.org/) ## Basic variables -### Général +### General #### Reverse proxy -##### Point d'entrée des clients +##### Clients configuration This family is a leadership. -| Parameter | Comments | -|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| -| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**
mandatory, multiple
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de domaine exterieur du serveur.
**Example:** service.example.net | -| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**
mandatory
**Type:** [`filename`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de l'arborescence racine du site. | +| Parameter | Comments | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------| +| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**
mandatory, multiple
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Service external domain name.
**Example:** service.example.net | +| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**
mandatory
**Type:** [`filename`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | URI to route request to the correct service. | #### Forgejo @@ -38,32 +39,17 @@ Git forge Forgejo. ## Variables for expert -### Général +### General #### Reverse proxy -##### Point d'entrée des clients +##### Clients configuration This family is a leadership. -| Parameter | Comments | -|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| -| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximum du corps. | - -#### PostgreSQL - -| Parameter | Comments | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------| -| **[general.postgresql.pg_client_username](dictionaries/23_postgresql.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client username.
**Default:** *calculated* | -| **[general.postgresql.pg_client_password](dictionaries/23_postgresql.xml)**
mandatory
**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client password.
**Default:** *calculated* | -| **[general.postgresql.pg_client_database](dictionaries/23_postgresql.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client database.
**Default:** *calculated* | - -#### Redis - -| Parameter | Comments | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------| -| **[general.redis.redis_client_username](dictionaries/23_redis.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom d'utilisateur.
**Default:** *calculated* | -| **[general.redis.redis_client_password](dictionaries/23_redis.xml)**
mandatory
**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Mot de passe de connexion.
**Default:** *calculated* | +| Parameter | Comments | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The maximum allowed size of the client request body. | #### OAuth2 client @@ -89,13 +75,18 @@ This family is a leadership. ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **ReverseProxy** -- **Postgresql** -- **Redis** -- **OAuth2** +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) +- SMTP: [postfix-relay](../postfix-relay/README.md) +- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) +- Postgresql: [postgresql](../postgresql/README.md) +- OAuth2: [lemonldap](../lemonldap/README.md) +- Redis: [redis](../redis/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -108,11 +99,11 @@ forgejo: applicationservice: forgejo zones_name: - localdns - - reverseproxy - - smtp - - redis - oauth2 - postgresql + - redis + - reverseproxy + - smtp values: general.revprox.revprox_client.revprox_client_external_domainnames: - service.example.net @@ -140,5 +131,3 @@ forgejo: ## Used by [gitea](../gitea/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/gitea/README.md b/seed/gitea/README.md index a6e085a..46bdf3d 100644 --- a/seed/gitea/README.md +++ b/seed/gitea/README.md @@ -3,6 +3,8 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # gitea ## Synopsis @@ -11,18 +13,18 @@ Transitional package for Gitea to Forgejo. ## Basic variables -### Général +### General #### Reverse proxy -##### Point d'entrée des clients +##### Clients configuration This family is a leadership. -| Parameter | Comments | -|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| -| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**
mandatory, multiple
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de domaine exterieur du serveur.
**Example:** service.example.net | -| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**
mandatory
**Type:** [`filename`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de l'arborescence racine du site. | +| Parameter | Comments | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------| +| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**
mandatory, multiple
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Service external domain name.
**Example:** service.example.net | +| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**
mandatory
**Type:** [`filename`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | URI to route request to the correct service. | #### Forgejo @@ -36,7 +38,7 @@ Git forge Forgejo. ## Variables -### Général +### General #### Forgejo @@ -54,32 +56,17 @@ Git forge Forgejo. ## Variables for expert -### Général +### General #### Reverse proxy -##### Point d'entrée des clients +##### Clients configuration This family is a leadership. -| Parameter | Comments | -|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| -| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximum du corps. | - -#### PostgreSQL - -| Parameter | Comments | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------| -| **[general.postgresql.pg_client_username](dictionaries/23_postgresql.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client username.
**Default:** *calculated* | -| **[general.postgresql.pg_client_password](dictionaries/23_postgresql.xml)**
mandatory
**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client password.
**Default:** *calculated* | -| **[general.postgresql.pg_client_database](dictionaries/23_postgresql.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client database.
**Default:** *calculated* | - -#### Redis - -| Parameter | Comments | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------| -| **[general.redis.redis_client_username](dictionaries/23_redis.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom d'utilisateur.
**Default:** *calculated* | -| **[general.redis.redis_client_password](dictionaries/23_redis.xml)**
mandatory
**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Mot de passe de connexion.
**Default:** *calculated* | +| Parameter | Comments | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The maximum allowed size of the client request body. | #### OAuth2 client @@ -105,13 +92,18 @@ This family is a leadership. ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **ReverseProxy** -- **Postgresql** -- **Redis** -- **OAuth2** +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) +- SMTP: [postfix-relay](../postfix-relay/README.md) +- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) +- Postgresql: [postgresql](../postgresql/README.md) +- OAuth2: [lemonldap](../lemonldap/README.md) +- Redis: [redis](../redis/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -124,11 +116,11 @@ gitea: applicationservice: gitea zones_name: - localdns - - reverseproxy - - smtp - - redis - oauth2 - postgresql + - redis + - reverseproxy + - smtp values: general.revprox.revprox_client.revprox_client_external_domainnames: - service.example.net @@ -152,5 +144,3 @@ gitea: - [redis-client](../redis-client/README.md) - [redis-common](../redis-common/README.md) - [oauth2-client](../oauth2-client/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/grafana/README.md b/seed/grafana/README.md index 46cbcb0..63c889e 100644 --- a/seed/grafana/README.md +++ b/seed/grafana/README.md @@ -3,28 +3,29 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # grafana ## Synopsis -Grafana is an analytics and interactive visualization web application. -[Software's website.](https://grafana.com/) +[Grafana is an analytics and interactive visualization web application.](https://grafana.com/) ## Basic variables -### Général +### General #### Reverse proxy -##### Point d'entrée des clients +##### Clients configuration This family is a leadership. -| Parameter | Comments | -|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| -| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**
mandatory, multiple
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de domaine exterieur du serveur.
**Example:** service.example.net | -| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**
mandatory
**Type:** [`filename`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de l'arborescence racine du site. | +| Parameter | Comments | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------| +| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**
mandatory, multiple
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Service external domain name.
**Example:** service.example.net | +| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**
mandatory
**Type:** [`filename`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | URI to route request to the correct service. | #### OAuth2 client @@ -37,25 +38,17 @@ This family is a leadership. ## Variables for expert -### Général +### General #### Reverse proxy -##### Point d'entrée des clients +##### Clients configuration This family is a leadership. -| Parameter | Comments | -|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| -| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximum du corps. | - -#### PostgreSQL - -| Parameter | Comments | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------| -| **[general.postgresql.pg_client_username](dictionaries/23_postgresql.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client username.
**Default:** *calculated* | -| **[general.postgresql.pg_client_password](dictionaries/23_postgresql.xml)**
mandatory
**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client password.
**Default:** *calculated* | -| **[general.postgresql.pg_client_database](dictionaries/23_postgresql.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client database.
**Default:** *calculated* | +| Parameter | Comments | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The maximum allowed size of the client request body. | #### OAuth2 client @@ -79,12 +72,17 @@ This family is a leadership. ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **ReverseProxy** -- **Postgresql** -- **OAuth2** +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) +- SMTP: [postfix-relay](../postfix-relay/README.md) +- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) +- Postgresql: [postgresql](../postgresql/README.md) +- OAuth2: [lemonldap](../lemonldap/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -97,10 +95,10 @@ grafana: applicationservice: grafana zones_name: - localdns - - reverseproxy - - smtp - oauth2 - postgresql + - reverseproxy + - smtp values: general.revprox.revprox_client.revprox_client_external_domainnames: - service.example.net @@ -122,5 +120,3 @@ grafana: - [oauth2-client](../oauth2-client/README.md) - [reverse-proxy-client](../reverse-proxy-client/README.md) - [relay-mail-client](../relay-mail-client/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/host-systemd-machined/README.md b/seed/host-systemd-machined/README.md index 8799fc5..1c6a422 100644 --- a/seed/host-systemd-machined/README.md +++ b/seed/host-systemd-machined/README.md @@ -3,17 +3,18 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # host-systemd-machined ## Synopsis -Host with machine started in Systemd Machined environment. -[Software's website.](https://www.freedesktop.org/wiki/Software/systemd/machined/) +[Host with machine started in Systemd Machined environment.](https://www.freedesktop.org/wiki/Software/systemd/machined/) ## Basic variables -### Général +### General #### network @@ -34,7 +35,7 @@ This family is a leadership. ## Variables -### Général +### General | Parameter | Comments | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------| @@ -50,18 +51,18 @@ This family is a leadership. |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| | **[general.network.interfaces.interface_type](dictionaries/21_machined.xml)**
mandatory
**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Type de la carte.
**Choices:**
- `dhcp`
- `ipv4` | +## Variables for expert + +### General + +#### base + +| Parameter | Comments | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| **[general.base.time_zone](dictionaries/21_machined.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Time zone.
**Default:** Europe/Paris | + + ## Dependances - [base](../base/README.md) - -## Supplier - -[provider-systemd-machined](../provider-systemd-machined/README.md) - -## Providers - -- [prometheus](../prometheus/README.md) -- [vector](../vector/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/host-systemd-machined/dictionaries/21_machined.xml b/seed/host-systemd-machined/dictionaries/21_machined.xml index b6fbbe8..cb12ed3 100644 --- a/seed/host-systemd-machined/dictionaries/21_machined.xml +++ b/seed/host-systemd-machined/dictionaries/21_machined.xml @@ -33,10 +33,10 @@ - +