From 20cc479fe714443a97ddb1efc72ff62e499cf1fd 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.ExternalDNS.md | 11 ++ seed/README.Host.md | 17 ++ seed/README.IMAP.md | 21 +++ seed/README.Journald.md | 25 +++ seed/README.LDAP.md | 15 ++ seed/README.LMTP.md | 15 ++ seed/README.LocalDNS.md | 22 +++ seed/README.Loki.md | 21 +++ seed/README.MariaDB.md | 15 ++ seed/README.OAuth2.md | 15 ++ seed/README.Postgresql.md | 11 ++ seed/README.Prometheus.md | 11 ++ seed/README.Redis.md | 11 ++ seed/README.ReverseProxy.md | 11 ++ seed/README.SMTP.md | 11 ++ seed/README.Vector.md | 11 ++ seed/README.md | 145 +++++++++++++++--- seed/apache/README.md | 19 ++- seed/apache/dictionaries/20_web.xml | 6 +- 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/base/dictionaries/00_base.xml | 4 +- seed/dns-external/README.md | 20 +-- .../dictionaries/14_dns-external.xml | 4 +- seed/dns-local/README.md | 8 +- seed/dovecot/README.md | 77 ++++------ seed/dovecot/applicationservice.yml | 3 +- seed/dovecot/dictionaries/31_dovecot.xml | 12 +- seed/dovecot/templates/config-v1.1.xml | 2 +- seed/forgejo/README.md | 69 ++++----- seed/gitea/README.md | 68 ++++---- seed/grafana/README.md | 58 ++++--- seed/host-systemd-machined/README.md | 37 ++--- .../dictionaries/21_machined.xml | 9 +- .../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 | 10 +- 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 | 120 ++++++--------- seed/nextcloud/applicationservice.yml | 2 +- seed/nextcloud/dictionaries/31_nextcloud.xml | 2 +- seed/nginx-common/README.md | 19 +-- seed/nginx-common/dictionaries/21_nginx.xml | 12 +- seed/nginx-https/README.md | 7 +- seed/nginx-reverse-proxy/README.md | 60 +++++--- .../applicationservice.yml | 3 + .../dictionaries/25_nginx.xml | 14 +- .../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 | 30 ++-- 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/php/dictionaries/20_php.xml | 25 +-- seed/php/templates/php.ini | 9 +- 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 ++++-- seed/postfix-relay/applicationservice.yml | 3 + .../postfix-relay/dictionaries/30_postfix.xml | 28 ++-- seed/postgresql-client/README.md | 25 +-- .../dictionaries/23_postgresql.xml | 10 +- seed/postgresql/README.md | 40 ++--- .../extras/accounts/00_accounts.xml | 10 +- seed/postgresql/templates/postgresql.conf | 5 +- seed/prometheus/README.md | 20 ++- .../prometheus/dictionaries/20_prometheus.xml | 2 +- seed/provider-systemd-machined/README.md | 36 +---- .../dictionaries/16_machined.xml | 6 +- 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/redis/extras/accounts/00_accounts.xml | 8 +- 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/resolved/dictionaries/20_resolved.xml | 2 +- seed/reverse-proxy-client/README.md | 30 ++-- .../dictionaries/21_revprox_client.xml | 8 +- seed/roundcube/README.md | 97 ++++-------- seed/speedtest-rs/README.md | 40 ++--- seed/systemd/README.md | 7 +- seed/systemd/dictionaries/15_systemd.xml | 2 +- .../templates/systemd-firstboot.service | 2 +- 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/applicationservice.yml | 1 + seed/znc/dictionaries/40_znc.xml | 18 +-- 125 files changed, 1402 insertions(+), 1284 deletions(-) create mode 100644 seed/README.ExternalDNS.md create mode 100644 seed/README.Host.md create mode 100644 seed/README.IMAP.md create mode 100644 seed/README.Journald.md create mode 100644 seed/README.LDAP.md create mode 100644 seed/README.LMTP.md create mode 100644 seed/README.LocalDNS.md create mode 100644 seed/README.Loki.md create mode 100644 seed/README.MariaDB.md create mode 100644 seed/README.OAuth2.md create mode 100644 seed/README.Postgresql.md create mode 100644 seed/README.Prometheus.md create mode 100644 seed/README.Redis.md create mode 100644 seed/README.ReverseProxy.md create mode 100644 seed/README.SMTP.md create mode 100644 seed/README.Vector.md diff --git a/seed/README.ExternalDNS.md b/seed/README.ExternalDNS.md new file mode 100644 index 00000000..002aa40b --- /dev/null +++ b/seed/README.ExternalDNS.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# ExternalDNS + +## Synopsis + diff --git a/seed/README.Host.md b/seed/README.Host.md new file mode 100644 index 00000000..7af26d0a --- /dev/null +++ b/seed/README.Host.md @@ -0,0 +1,17 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# Host + +## Synopsis + +Machines started in this host + +## Providers + +| Name | Comment | +|--------|-----------| diff --git a/seed/README.IMAP.md b/seed/README.IMAP.md new file mode 100644 index 00000000..f7ff0331 --- /dev/null +++ b/seed/README.IMAP.md @@ -0,0 +1,21 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# IMAP + +## Synopsis + +IMAP client address + +## Providers + +| Name | Comment | +|--------|-----------| + +## Supplier + +[dovecot](dovecot/README.md) diff --git a/seed/README.Journald.md b/seed/README.Journald.md new file mode 100644 index 00000000..16030bfd --- /dev/null +++ b/seed/README.Journald.md @@ -0,0 +1,25 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# Journald + +## Synopsis + +Remote journald + +## Providers + +| Name | Comment | +|-------------------|-----------------------------------------------------------------------| +| Journald:host | Remote host | +| Journald:service | Log from this service to exclude | +| Journald:function | Function use to compare message (if not defined, exlude same message) | +| Journald:message | Message to exclude | + +## Supplier + +[vector](vector/README.md) diff --git a/seed/README.LDAP.md b/seed/README.LDAP.md new file mode 100644 index 00000000..91ff1e71 --- /dev/null +++ b/seed/README.LDAP.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# LDAP + +## Synopsis + +Remote services with an account + +## Providers + diff --git a/seed/README.LMTP.md b/seed/README.LMTP.md new file mode 100644 index 00000000..0c782258 --- /dev/null +++ b/seed/README.LMTP.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# LMTP + +## Synopsis + +LMTP remote server + +## Providers + diff --git a/seed/README.LocalDNS.md b/seed/README.LocalDNS.md new file mode 100644 index 00000000..f56aa743 --- /dev/null +++ b/seed/README.LocalDNS.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# LocalDNS + +## Synopsis + +Clients + +## Providers + +| Name | Comment | +|--------------------|------------------------| +| LocalDNS:DNSSEC_DS | DNSSEC DS informations | + +## Supplier + +[nsd-local](nsd-local/README.md) diff --git a/seed/README.Loki.md b/seed/README.Loki.md new file mode 100644 index 00000000..e8a4b4ab --- /dev/null +++ b/seed/README.Loki.md @@ -0,0 +1,21 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# Loki + +## Synopsis + +Remote loki client + +## Providers + +| Name | Comment | +|--------|-----------| + +## Supplier + +[loki](loki/README.md) diff --git a/seed/README.MariaDB.md b/seed/README.MariaDB.md new file mode 100644 index 00000000..00118864 --- /dev/null +++ b/seed/README.MariaDB.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# MariaDB + +## Synopsis + +Remote clients needing an account + +## Providers + diff --git a/seed/README.OAuth2.md b/seed/README.OAuth2.md new file mode 100644 index 00000000..e44c7b94 --- /dev/null +++ b/seed/README.OAuth2.md @@ -0,0 +1,15 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# OAuth2 + +## Synopsis + +Remote clients needing to verify OAuth2 account + +## Providers + diff --git a/seed/README.Postgresql.md b/seed/README.Postgresql.md new file mode 100644 index 00000000..87d852ca --- /dev/null +++ b/seed/README.Postgresql.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# Postgresql + +## Synopsis + diff --git a/seed/README.Prometheus.md b/seed/README.Prometheus.md new file mode 100644 index 00000000..094cb379 --- /dev/null +++ b/seed/README.Prometheus.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# Prometheus + +## Synopsis + diff --git a/seed/README.Redis.md b/seed/README.Redis.md new file mode 100644 index 00000000..8482864e --- /dev/null +++ b/seed/README.Redis.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# Redis + +## Synopsis + diff --git a/seed/README.ReverseProxy.md b/seed/README.ReverseProxy.md new file mode 100644 index 00000000..6e52d5bb --- /dev/null +++ b/seed/README.ReverseProxy.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# ReverseProxy + +## Synopsis + diff --git a/seed/README.SMTP.md b/seed/README.SMTP.md new file mode 100644 index 00000000..2b694efd --- /dev/null +++ b/seed/README.SMTP.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# SMTP + +## Synopsis + diff --git a/seed/README.Vector.md b/seed/README.Vector.md new file mode 100644 index 00000000..6227da16 --- /dev/null +++ b/seed/README.Vector.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# Vector + +## Synopsis + diff --git a/seed/README.md b/seed/README.md index e13feb25..416df8f7 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 661853c5..1076c12b 100644 --- a/seed/apache/README.md +++ b/seed/apache/README.md @@ -3,28 +3,29 @@ 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 -Paramètrage avancé du serveur web Apache. +Advance Apache web server settings. -| Parameter | Comments | -|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| -| **[general.apache.apache_timeout](dictionaries/20_web.xml)**
mandatory
**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Temps d'attente des entrées/sorties avant de considérer qu'une requête a échoué.
Temps en secondes.
**Default:** 300 | -| **[general.apache.apache_keepalive](dictionaries/20_web.xml)**
mandatory
**Type:** [`boolean`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Autoriser les connexions persistantes.
**Default:** True | +| Parameter | Comments | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| **[general.apache.apache_timeout](dictionaries/20_web.xml)**
mandatory
**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Amount of time the server will wait for certain events before failing a request.
Time in seconds.
**Default:** 300 | +| **[general.apache.apache_keepalive](dictionaries/20_web.xml)**
mandatory
**Type:** [`boolean`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Enables HTTP persistent connections.
**Default:** True | ## Dependances @@ -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/apache/dictionaries/20_web.xml b/seed/apache/dictionaries/20_web.xml index 7a2aaf02..c885b4c4 100644 --- a/seed/apache/dictionaries/20_web.xml +++ b/seed/apache/dictionaries/20_web.xml @@ -15,11 +15,11 @@ apache - - + + 300 - + diff --git a/seed/base-debian-bullseye/README.md b/seed/base-debian-bullseye/README.md index ec2829ee..b64d6fef 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 455c6d1e..91512b3d 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 a8164be4..1e793b0f 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 03ef07a1..083a1635 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 d8472268..8a5bb61d 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 1e0f4356..1d808c92 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 e532760d..a4960c40 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 1852ce7e..9bf06972 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 b8308440..e95b57d2 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/base/dictionaries/00_base.xml b/seed/base/dictionaries/00_base.xml index 031667cf..2ccdace8 100644 --- a/seed/base/dictionaries/00_base.xml +++ b/seed/base/dictionaries/00_base.xml @@ -1,8 +1,10 @@ - diff --git a/seed/dns-external/README.md b/seed/dns-external/README.md index 56cb8084..7f5d073e 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 06f3b086..2758fb93 100644 --- a/seed/dns-external/dictionaries/14_dns-external.xml +++ b/seed/dns-external/dictionaries/14_dns-external.xml @@ -2,10 +2,10 @@ - + - + diff --git a/seed/dns-local/README.md b/seed/dns-local/README.md index 78203c7b..4cd0191d 100644 --- a/seed/dns-local/README.md +++ b/seed/dns-local/README.md @@ -3,6 +3,8 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # dns-local ## Synopsis @@ -12,9 +14,3 @@ DNS client with access to local zones. ## Used by [base-machine](../base-machine/README.md) - -## Provider - -[nsd-local](../nsd-local/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/dovecot/README.md b/seed/dovecot/README.md index ed2d5999..81e72108 100644 --- a/seed/dovecot/README.md +++ b/seed/dovecot/README.md @@ -3,73 +3,67 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # dovecot ## Synopsis -Postfix and Dovecot as mail servers (Submission and IMAP). -[Software's website.](https://www.dovecot.org/) +[Postfix and Dovecot as mail servers (IMAP and submission).](https://www.dovecot.org/) + +This application service provides email server. Two servers are used: Dovecot as IMAP server and Postfix as submission server. In addition, an auto-detection file of the email configuration is set up. ## Basic variables -### Général +### General #### Mail configuration +Configure IMAP servers and submission to access email accounts and send emails. + ##### Mail domain This family is a leadership. -| Parameter | Comments | -|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------| -| **[general.mail.domain.mail_domains](dictionaries/31_dovecot.xml)**
mandatory, multiple
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Domaine de courriel géré localement.
**Example:** example.net | -| **[general.mail.domain.imap_domainname](dictionaries/31_dovecot.xml)**
mandatory
**Type:** [`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 IMAP.
**Example:** imap.example.net | -| **[general.mail.domain.submission_domainname](dictionaries/31_dovecot.xml)**
mandatory
**Type:** [`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.
**Example:** submission.example.net | +| Parameter | Comments | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **[general.mail.domain.mail_domains](dictionaries/31_dovecot.xml)**
mandatory, multiple
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Final destination email address.
These domain names are the domain names for emails (user@*example.net*) and for auto configuration of email clients (https://*example.net*/.well-known/autoconfig/mail/config-v1.1.xml).
**Example:** example.net | +| **[general.mail.domain.imap_domainname](dictionaries/31_dovecot.xml)**
mandatory
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | External IMAP server address.
Matches TLS connection’s SNI name, if it’s sent by the client. For some email clients, use in DNS configuration a line like "_submissions._tcp IN SRV 1 587 *imap.example.net*.".
**Example:** imap.example.net | +| **[general.mail.domain.submission_domainname](dictionaries/31_dovecot.xml)**
mandatory
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | External submission server address.
Matches TLS connection’s SNI name, if it’s sent by the client. For some email clients, add in DNS configuration a line like "_imaps._tcp IN SRV 0 1 993 *submission.example.net*.".
**Example:** submission.example.net | -## Variables +| Parameter | Comments | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **[general.mail.mail_crt_provider](dictionaries/31_dovecot.xml)**
mandatory
**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Type of certificate autority signing external IMAP and submission domain certificates.
The certificate can be self-signed (therefore invalid by default for the client) or obtained via the Let's Encrypt service (generally valid for the client).
**Choices:**
- `self-signed` ← default
- `letsencrypt` | -### Général - -#### Mail configuration - -##### Mail domain - -This family is a leadership. - -| Parameter | Comments | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| -| **[general.mail.mail_crt_provider](dictionaries/31_dovecot.xml)**
mandatory
**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Autorité de certification signant les certificats des domaines extérieurs.
**Choices:**
- `self-signed` ← default
- `letsencrypt` | ## Variables for expert -### Général +### General -#### Annuaire OpenLDAP +#### OpenLDAP directory ##### Client -| Parameter | Comments | -|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------| -| **[general.ldap.client.ldapclient_family](dictionaries/31_dovecot.xml)**
mandatory
**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de la famille LDAP.
**Default:** all | -| **[general.ldap.client.ldapclient_base_dn](dictionaries/21_ldap-client.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Base DN de l'annuaire.
**Default:** *calculated* | -| **[general.ldap.client.ldapclient_search_dn](dictionaries/21_ldap-client.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Base DN de l'annuaire des utilisateurs.
**Default:** *calculated* | -| **[general.ldap.client.ldapclient_group_dn](dictionaries/21_ldap-client.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Base DN de l'annuaire des groupes.
**Default:** *calculated* | -| **[general.ldap.client.ldapclient_user_dn](dictionaries/21_ldap-client.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Base DN de l'annuaire des utilisateurs n'appartenant à une famille.
**Default:** *calculated* | +| Parameter | Comments | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| +| **[general.ldap.client.ldapclient_family](dictionaries/31_dovecot.xml)**
mandatory
**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Restrict service configuration for a LDAP family.
"all" for all families.
**Default:** all | ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **LDAP** -- **ReverseProxy** -- **LMTP** -- **OAuth2** +### Mandatories -**bold**: provider is mandatory +- [LocalDNS](../README.LocalDNS.md) +- [SMTP](../README.SMTP.md) +- [LDAP](../README.LDAP.md) +- [ReverseProxy](../README.ReverseProxy.md) +- [OAuth2](../README.OAuth2.md) + +### Optionals + +- [Journald](../README.Journald.md) ## Example @@ -82,10 +76,9 @@ dovecot: zones_name: - ldap - localdns + - oauth2 - reverseproxy - smtp - - lmtp - - oauth2 values: general.mail.domain.mail_domains: - example.net @@ -114,8 +107,6 @@ dovecot: - [nginx-common](../nginx-common/README.md) - [reverse-proxy-client](../reverse-proxy-client/README.md) -## Supplier +## Useful for service -[imap-client](../imap-client/README.md) - -[All applications services for this dataset.](../README.md) +[roundcube](../roundcube/README.md): Roundcube, a webmail. diff --git a/seed/dovecot/applicationservice.yml b/seed/dovecot/applicationservice.yml index 3875576a..9c6d8123 100644 --- a/seed/dovecot/applicationservice.yml +++ b/seed/dovecot/applicationservice.yml @@ -1,5 +1,6 @@ format: '0.1' -description: Postfix and Dovecot as mail servers (Submission and IMAP) +description: Postfix and Dovecot as mail servers (IMAP and submission) +help: "This application service provides email server. Two servers are used: Dovecot as IMAP server and Postfix as submission server. In addition, an auto-detection file of the email configuration is set up." website: https://www.dovecot.org/ depends: - base-fedora-36 diff --git a/seed/dovecot/dictionaries/31_dovecot.xml b/seed/dovecot/dictionaries/31_dovecot.xml index 6aab8278..0884b6c3 100644 --- a/seed/dovecot/dictionaries/31_dovecot.xml +++ b/seed/dovecot/dictionaries/31_dovecot.xml @@ -63,21 +63,21 @@ - + - + - + self-signed self-signed letsencrypt - + diff --git a/seed/dovecot/templates/config-v1.1.xml b/seed/dovecot/templates/config-v1.1.xml index f45092d7..55e986b8 100644 --- a/seed/dovecot/templates/config-v1.1.xml +++ b/seed/dovecot/templates/config-v1.1.xml @@ -1,5 +1,5 @@ -# GNUNUX: from https://wiki.mozilla.org/Thunderbird:Autoconfiguration:ConfigFileFormat --> + {%set domain = rougail_variable %} {%set leader = general.mail.domain.mail_domains[mail_domains.index(domain)] %} {%set imap_domain = leader.imap_domainname %} diff --git a/seed/forgejo/README.md b/seed/forgejo/README.md index 1454e67d..614b0142 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.
**Default:** / | #### 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,15 +75,18 @@ This family is a leadership. ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **ReverseProxy** -- **Postgresql** -- **Redis** -- **OAuth2** +### Mandatories -**bold**: provider is mandatory +- [LocalDNS](../README.LocalDNS.md) +- [SMTP](../README.SMTP.md) +- [ReverseProxy](../README.ReverseProxy.md) +- [Postgresql](../README.Postgresql.md) +- [OAuth2](../README.OAuth2.md) +- [Redis](../README.Redis.md) + +### Optionals + +- [Journald](../README.Journald.md) ## Example @@ -108,11 +97,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 +129,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 a6e085ae..59721819 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.
**Default:** / | #### 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,15 +92,18 @@ This family is a leadership. ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **ReverseProxy** -- **Postgresql** -- **Redis** -- **OAuth2** +### Mandatories -**bold**: provider is mandatory +- [LocalDNS](../README.LocalDNS.md) +- [SMTP](../README.SMTP.md) +- [ReverseProxy](../README.ReverseProxy.md) +- [Postgresql](../README.Postgresql.md) +- [OAuth2](../README.OAuth2.md) +- [Redis](../README.Redis.md) + +### Optionals + +- [Journald](../README.Journald.md) ## Example @@ -124,11 +114,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 +142,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 46cbcb0a..702b21c3 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.
**Default:** / | #### 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,14 +72,17 @@ This family is a leadership. ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **ReverseProxy** -- **Postgresql** -- **OAuth2** +### Mandatories -**bold**: provider is mandatory +- [LocalDNS](../README.LocalDNS.md) +- [SMTP](../README.SMTP.md) +- [ReverseProxy](../README.ReverseProxy.md) +- [Postgresql](../README.Postgresql.md) +- [OAuth2](../README.OAuth2.md) + +### Optionals + +- [Journald](../README.Journald.md) ## Example @@ -97,10 +93,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 +118,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 8799fc55..6c7516fc 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 | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------| @@ -46,22 +47,22 @@ This family is a leadership. This family is a leadership. -| Parameter | Comments | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| -| **[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` | +| Parameter | Comments | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------| +| **[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` ← default
- `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 b6fbbe85..39e9befb 100644 --- a/seed/host-systemd-machined/dictionaries/21_machined.xml +++ b/seed/host-systemd-machined/dictionaries/21_machined.xml @@ -33,10 +33,10 @@ - +