From c9162a5042991f7d18478c4a45aadaef227d14ac 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 | 29 +++ seed/README.IMAP.md | 23 ++ seed/README.Journald.md | 54 ++++ seed/README.LDAP.md | 34 +++ seed/README.LMTP.md | 27 ++ seed/README.LocalDNS.md | 48 ++++ seed/README.Loki.md | 23 ++ seed/README.MariaDB.md | 28 +++ seed/README.OAuth2.md | 45 ++++ seed/README.Postgresql.md | 36 +++ seed/README.Prometheus.md | 19 ++ seed/README.Redis.md | 33 +++ seed/README.ReverseProxy.md | 44 ++++ seed/README.SMTP.md | 37 +++ seed/README.Vector.md | 22 ++ seed/README.md | 69 ++---- seed/apache/README.md | 21 +- seed/apache/dictionaries/20_web.xml | 6 +- seed/base-debian-bullseye/README.md | 23 +- seed/base-debian/README.md | 21 +- seed/base-fedora-35/README.md | 23 +- seed/base-fedora-36/README.md | 23 +- seed/base-fedora-37/README.md | 23 +- seed/base-fedora-38/README.md | 23 +- seed/base-fedora/README.md | 21 +- seed/base-machine/README.md | 10 +- 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 | 157 ++++++------ seed/dovecot/applicationservice.yml | 3 +- seed/dovecot/dictionaries/31_dovecot.xml | 12 +- seed/dovecot/templates/config-v1.1.xml | 2 +- seed/forgejo/README.md | 137 +++++------ seed/gitea/README.md | 163 ++++++------ seed/grafana/README.md | 120 +++++---- seed/host-systemd-machined/README.md | 38 ++- .../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 | 7 +- seed/journald_remote/README.md | 11 +- .../extras/accounts/00_accounts.xml | 11 +- seed/ldap-client/README.md | 26 +- .../dictionaries/21_ldap-client.xml | 26 +- seed/lemonldap/README.md | 204 +++++++-------- seed/lemonldap/extras/oauth2/00_oauth2.xml | 16 +- seed/loki/README.md | 46 ++-- seed/loki/dictionaries/20_loki.xml | 4 +- seed/mailman/README.md | 165 ++++++------- seed/mariadb-client/README.md | 11 +- .../dictionaries/20_mariadb.xml | 4 +- seed/mariadb/README.md | 46 ++-- seed/mariadb/extras/accounts/00_accounts.xml | 10 +- seed/nextcloud/README.md | 221 ++++++++--------- 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 | 11 +- seed/nginx-reverse-proxy/README.md | 112 +++++---- .../applicationservice.yml | 3 + .../dictionaries/25_nginx.xml | 14 +- .../extras/nginx/00_nginx.xml | 14 +- seed/nginx-static/README.md | 150 ++++++----- seed/nsd-local/README.md | 77 +++--- seed/nsd-local/dictionaries/21_nsd-local.xml | 4 +- seed/nsd/README.md | 138 ++++++----- seed/oauth2-client/README.md | 30 ++- .../dictionaries/30_oauth2_client.xml | 6 +- seed/odoo/README.md | 187 +++++++------- seed/openldap/README.md | 86 ++++--- seed/openldap/extras/accounts/00_account.xml | 10 +- seed/peertube/README.md | 179 +++++++------- seed/php-fpm/README.md | 6 +- seed/php/README.md | 30 +-- seed/php/dictionaries/20_php.xml | 25 +- seed/php/templates/php.ini | 9 +- seed/piwigo/README.md | 232 ++++++++---------- seed/pki-tls/README.md | 4 +- seed/postfix-lmtp-relay/README.md | 11 +- .../extras/lmtp/00_lmtp.xml | 6 +- seed/postfix-relay/README.md | 89 ++++--- seed/postfix-relay/applicationservice.yml | 3 + .../postfix-relay/dictionaries/30_postfix.xml | 29 ++- seed/postfix-relay/templates/postfix.service | 2 +- seed/postgresql-client/README.md | 25 +- .../dictionaries/23_postgresql.xml | 10 +- seed/postgresql/README.md | 78 +++--- .../extras/accounts/00_accounts.xml | 10 +- seed/postgresql/templates/postgresql.conf | 5 +- seed/prometheus/README.md | 46 ++-- .../prometheus/dictionaries/20_prometheus.xml | 2 +- seed/provider-systemd-machined/README.md | 50 +--- .../dictionaries/16_machined.xml | 6 +- seed/redis-client/README.md | 26 +- seed/redis-client/dictionaries/23_redis.xml | 12 +- seed/redis-common/README.md | 7 +- seed/redis/README.md | 77 +++--- seed/redis/extras/accounts/00_accounts.xml | 10 +- seed/relay-lmtp-client/README.md | 10 +- .../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 | 34 ++- .../dictionaries/21_revprox_client.xml | 8 +- seed/roundcube/README.md | 211 +++++++--------- seed/speedtest-rs/README.md | 106 ++++---- seed/systemd/README.md | 19 +- seed/systemd/dictionaries/15_systemd.xml | 2 +- .../templates/systemd-firstboot.service | 2 +- seed/unbound/README.md | 70 +++--- seed/unbound/dictionaries/20_unbound.xml | 7 +- seed/vaultwarden/README.md | 117 ++++----- seed/vector/README.md | 82 ++++--- seed/vector/dictionaries/20_vector.xml | 8 +- seed/vector/templates/vector.toml | 1 + seed/znc/README.md | 108 ++++---- seed/znc/applicationservice.yml | 1 + seed/znc/dictionaries/40_znc.xml | 18 +- 126 files changed, 2612 insertions(+), 2360 deletions(-) create mode 100644 seed/README.ExternalDNS.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 0000000..6f81124 --- /dev/null +++ b/seed/README.ExternalDNS.md @@ -0,0 +1,29 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# ExternalDNS + +## Synopsis + +DNS forwarder for all DNS zones.
This provider is able to answer query for external and internal domain name. + +## Variables + +| Parameter | Comment | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------| +| **ExternalDNS:authority_zones**
multiple
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Local DNS server can export own authority zones. | + +## Provider + +[unbound](unbound/README.md): Unbound, a validating, recursive, caching DNS resolver. + +## Suppliers + +- [postfix-relay](postfix-relay/README.md): Postfix, the mail server, as relay. +- [peertube](peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform. +- [znc](znc/README.md): ZNC, a bouncer IRC. +- [nsd-local](nsd-local/README.md): NSD, an authoritative DNS name server for local resolution. diff --git a/seed/README.IMAP.md b/seed/README.IMAP.md new file mode 100644 index 0000000..ee5ae50 --- /dev/null +++ b/seed/README.IMAP.md @@ -0,0 +1,23 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# IMAP + +## Synopsis + +IMAP server connexion. + +## Variables + + +## Provider + +[dovecot](dovecot/README.md): Postfix and Dovecot as mail servers (IMAP and submission). + +## Supplier + +[roundcube](roundcube/README.md): Roundcube, a webmail. diff --git a/seed/README.Journald.md b/seed/README.Journald.md new file mode 100644 index 0000000..c0b93ae --- /dev/null +++ b/seed/README.Journald.md @@ -0,0 +1,54 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# Journald + +## Synopsis + +Concentrate journal messages on one host. + +## Variables + +| Parameter | Comment | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------| +| **Journald:message**
mandatory, multiple
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Message to exclude for *supplier name*. | +| **Journald:service**
mandatory, multiple
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Log from this service to exclude for *supplier name*. | +| **Journald:function**
multiple
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Function use to compare message (if not defined, exlude same message) for *supplier name*. | + +## Provider + +[vector](vector/README.md): Vector, a lightweight, ultra-fast tool for building observability pipelines. + +## Suppliers + +- [odoo](odoo/README.md): Odoo, an ERP and CRM. +- [nginx-static](nginx-static/README.md): Nginx as static web site. +- [grafana](grafana/README.md): Grafana is an analytics and interactive visualization web application. +- [postgresql](postgresql/README.md): Postgresql, a database. +- [postfix-relay](postfix-relay/README.md): Postfix, the mail server, as relay. +- [mailman](mailman/README.md): GNU Mailman, managing electronic mail discussion and e-newsletter lists. +- [peertube](peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform. +- [piwigo](piwigo/README.md): Piwigo, a photo management software. +- [vector](vector/README.md): Vector, a lightweight, ultra-fast tool for building observability pipelines. +- [dovecot](dovecot/README.md): Postfix and Dovecot as mail servers (IMAP and submission). +- [unbound](unbound/README.md): Unbound, a validating, recursive, caching DNS resolver. +- [redis](redis/README.md): Redis, an in-memory data structure store. +- [loki](loki/README.md): Loki, a log aggregation platform. +- [forgejo](forgejo/README.md): Forgejo, a community managed lightweight code hosting solution. +- [nsd](nsd/README.md): NSD, an authoritative DNS name server. +- [speedtest-rs](speedtest-rs/README.md): Speedtest-rs, a very lightweight Speedtest. +- [nginx-reverse-proxy](nginx-reverse-proxy/README.md): Nginx as reverse proxy. +- [roundcube](roundcube/README.md): Roundcube, a webmail. +- [znc](znc/README.md): ZNC, a bouncer IRC. +- [vaultwarden](vaultwarden/README.md): Vaultwarden, a password manager. +- [prometheus](prometheus/README.md): Prometheus, an event monitoring. +- [mariadb](mariadb/README.md): MariaDB, a relational database. +- [nsd-local](nsd-local/README.md): NSD, an authoritative DNS name server for local resolution. +- [nextcloud](nextcloud/README.md): Nextcloud, Online collaboration platform. +- [lemonldap](lemonldap/README.md): LemonLDAP, a Web Single Sign On and Access Management. +- [openldap](openldap/README.md): OpenLDAP, the LDAP server. +- [gitea](gitea/README.md): Transitional package for Gitea to Forgejo. diff --git a/seed/README.LDAP.md b/seed/README.LDAP.md new file mode 100644 index 0000000..3841910 --- /dev/null +++ b/seed/README.LDAP.md @@ -0,0 +1,34 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# LDAP + +## Synopsis + +Create account and connexion to a LDAP server. + +## Variables + +| Parameter | Comment | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------| +| **LDAP:family**
**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | LDAP family name for *supplier name*. | +| **LDAP:dn**
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | LDAP account DN for *supplier name*. | +| **LDAP:password**
mandatory
**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | LDAP passowrd for *supplier name*. | +| **LDAP:base_dn**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | LDAP base DN for *supplier name*. | + +## Provider + +[openldap](openldap/README.md): OpenLDAP, the LDAP server. + +## Suppliers + +- [odoo](odoo/README.md): Odoo, an ERP and CRM. +- [piwigo](piwigo/README.md): Piwigo, a photo management software. +- [dovecot](dovecot/README.md): Postfix and Dovecot as mail servers (IMAP and submission). +- [roundcube](roundcube/README.md): Roundcube, a webmail. +- [nextcloud](nextcloud/README.md): Nextcloud, Online collaboration platform. +- [lemonldap](lemonldap/README.md): LemonLDAP, a Web Single Sign On and Access Management. diff --git a/seed/README.LMTP.md b/seed/README.LMTP.md new file mode 100644 index 0000000..b4af1dc --- /dev/null +++ b/seed/README.LMTP.md @@ -0,0 +1,27 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# LMTP + +## Synopsis + +LMTP remote server.
A service needs send email with LMTP protocol. + +## Variables + +| Parameter | Comment | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| +| **LMTP:criteria**
mandatory, multiple
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Domain name allowes to send email with LMTP protocol for *supplier name*. | + +## Provider + +[postfix-relay](postfix-relay/README.md): Postfix, the mail server, as relay. + +## Suppliers + +- [mailman](mailman/README.md): GNU Mailman, managing electronic mail discussion and e-newsletter lists. +- [dovecot](dovecot/README.md): Postfix and Dovecot as mail servers (IMAP and submission). diff --git a/seed/README.LocalDNS.md b/seed/README.LocalDNS.md new file mode 100644 index 0000000..3aa6c89 --- /dev/null +++ b/seed/README.LocalDNS.md @@ -0,0 +1,48 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# LocalDNS + +## Synopsis + +DNS forwarder for local domain name. + +## Variables + +| Parameter | Comment | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| **LocalDNS:DNSSEC_DS**
multiple
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | DNSSEC DS informations. | + +## Provider + +[nsd-local](nsd-local/README.md): NSD, an authoritative DNS name server for local resolution. + +## Suppliers + +- [odoo](odoo/README.md): Odoo, an ERP and CRM. +- [nginx-static](nginx-static/README.md): Nginx as static web site. +- [grafana](grafana/README.md): Grafana is an analytics and interactive visualization web application. +- [postgresql](postgresql/README.md): Postgresql, a database. +- [mailman](mailman/README.md): GNU Mailman, managing electronic mail discussion and e-newsletter lists. +- [piwigo](piwigo/README.md): Piwigo, a photo management software. +- [vector](vector/README.md): Vector, a lightweight, ultra-fast tool for building observability pipelines. +- [dovecot](dovecot/README.md): Postfix and Dovecot as mail servers (IMAP and submission). +- [redis](redis/README.md): Redis, an in-memory data structure store. +- [loki](loki/README.md): Loki, a log aggregation platform. +- [forgejo](forgejo/README.md): Forgejo, a community managed lightweight code hosting solution. +- [nsd](nsd/README.md): NSD, an authoritative DNS name server. +- [speedtest-rs](speedtest-rs/README.md): Speedtest-rs, a very lightweight Speedtest. +- [nginx-reverse-proxy](nginx-reverse-proxy/README.md): Nginx as reverse proxy. +- [roundcube](roundcube/README.md): Roundcube, a webmail. +- [vaultwarden](vaultwarden/README.md): Vaultwarden, a password manager. +- [prometheus](prometheus/README.md): Prometheus, an event monitoring. +- [mariadb](mariadb/README.md): MariaDB, a relational database. +- [nsd-local](nsd-local/README.md): NSD, an authoritative DNS name server for local resolution. +- [nextcloud](nextcloud/README.md): Nextcloud, Online collaboration platform. +- [lemonldap](lemonldap/README.md): LemonLDAP, a Web Single Sign On and Access Management. +- [openldap](openldap/README.md): OpenLDAP, the LDAP server. +- [gitea](gitea/README.md): Transitional package for Gitea to Forgejo. diff --git a/seed/README.Loki.md b/seed/README.Loki.md new file mode 100644 index 0000000..20a14d4 --- /dev/null +++ b/seed/README.Loki.md @@ -0,0 +1,23 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# Loki + +## Synopsis + +Concentrate log messages. + +## Variables + + +## Provider + +[loki](loki/README.md): Loki, a log aggregation platform. + +## Supplier + +[vector](vector/README.md): Vector, a lightweight, ultra-fast tool for building observability pipelines. diff --git a/seed/README.MariaDB.md b/seed/README.MariaDB.md new file mode 100644 index 0000000..bdb4ccf --- /dev/null +++ b/seed/README.MariaDB.md @@ -0,0 +1,28 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# MariaDB + +## Synopsis + +Create account and connexion to a MariaDB server. + +## Variables + +| Parameter | Comment | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------| +| **MariaDB:username**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | MariaDB user name for *supplier name*. | +| **MariaDB:password**
mandatory
**Type:** [`secret`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | MariaDB password for *supplier name*. | +| **MariaDB:database**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | MariaDB database name for *supplier name*. | + +## Provider + +[mariadb](mariadb/README.md): MariaDB, a relational database. + +## Supplier + +[piwigo](piwigo/README.md): Piwigo, a photo management software. diff --git a/seed/README.OAuth2.md b/seed/README.OAuth2.md new file mode 100644 index 0000000..039b06d --- /dev/null +++ b/seed/README.OAuth2.md @@ -0,0 +1,45 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# OAuth2 + +## Synopsis + +Remote clients needing to verify OAuth2 account. + +## Variables + +| Parameter | Comment | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| +| **OAuth2:name**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Remote name for *supplier name*. | +| **OAuth2:description**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Remote description for *supplier name*. | +| **OAuth2:login**
**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Remote URL to login for *supplier name*. | +| **OAuth2:external**
mandatory, multiple
**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Remote external for *supplier name*. | +| **OAuth2:family**
mandatory, multiple
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Remote family for *supplier name*. | +| **OAuth2:category**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Remode category for *supplier name*. | +| **OAuth2:logo**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Logo for *supplier name*. | +| **OAuth2:client_id**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Remote client id for *supplier name*. | +| **OAuth2:secret**
mandatory
**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Remote secret for *supplier name*. | +| **OAuth2:token_signature_algo**
mandatory
**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 token signature algorithm for *supplier name*.
**Choices:**
- `HS512`
- `RS256` | +| **OAuth2:external_domain**
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 server domain name. | + +## Provider + +[lemonldap](lemonldap/README.md): LemonLDAP, a Web Single Sign On and Access Management. + +## Suppliers + +- [odoo](odoo/README.md): Odoo, an ERP and CRM. +- [grafana](grafana/README.md): Grafana is an analytics and interactive visualization web application. +- [mailman](mailman/README.md): GNU Mailman, managing electronic mail discussion and e-newsletter lists. +- [peertube](peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform. +- [piwigo](piwigo/README.md): Piwigo, a photo management software. +- [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. +- [roundcube](roundcube/README.md): Roundcube, a webmail. +- [nextcloud](nextcloud/README.md): Nextcloud, Online collaboration platform. +- [gitea](gitea/README.md): Transitional package for Gitea to Forgejo. diff --git a/seed/README.Postgresql.md b/seed/README.Postgresql.md new file mode 100644 index 0000000..6bd05cf --- /dev/null +++ b/seed/README.Postgresql.md @@ -0,0 +1,36 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# Postgresql + +## Synopsis + +Create account and connexion to a PostgreSQL server. + +## Variables + +| Parameter | Comment | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| +| **Postgresql:username**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Postgresql username for *supplier name*. | +| **Postgresql:password**
mandatory
**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Postgresql password for *supplier name*. | +| **Postgresql:database**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Postgresql database name for *supplier name*. | + +## Provider + +[postgresql](postgresql/README.md): Postgresql, a database. + +## Suppliers + +- [odoo](odoo/README.md): Odoo, an ERP and CRM. +- [grafana](grafana/README.md): Grafana is an analytics and interactive visualization web application. +- [mailman](mailman/README.md): GNU Mailman, managing electronic mail discussion and e-newsletter lists. +- [peertube](peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform. +- [forgejo](forgejo/README.md): Forgejo, a community managed lightweight code hosting solution. +- [roundcube](roundcube/README.md): Roundcube, a webmail. +- [vaultwarden](vaultwarden/README.md): Vaultwarden, a password manager. +- [nextcloud](nextcloud/README.md): Nextcloud, Online collaboration platform. +- [gitea](gitea/README.md): Transitional package for Gitea to Forgejo. diff --git a/seed/README.Prometheus.md b/seed/README.Prometheus.md new file mode 100644 index 0000000..a116b62 --- /dev/null +++ b/seed/README.Prometheus.md @@ -0,0 +1,19 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# Prometheus + +## Synopsis + +Configure Prometheus exporter. + +## Variables + + +## Provider + +[prometheus](prometheus/README.md): Prometheus, an event monitoring. diff --git a/seed/README.Redis.md b/seed/README.Redis.md new file mode 100644 index 0000000..4b4020a --- /dev/null +++ b/seed/README.Redis.md @@ -0,0 +1,33 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# Redis + +## Synopsis + +Create account and connexion to a Redis server. + +## Variables + +| Parameter | Comment | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------| +| **Redis:username**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Redis user name for *supplier name*. | +| **Redis:password**
mandatory
**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Redis password for *supplier name*. | +| **Redis:index**
mandatory
**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Redis database index.
Only index 0 is allowed, Redis project discourage to use the server with several database. | + +## Provider + +[redis](redis/README.md): Redis, an in-memory data structure store. + +## Suppliers + +- [peertube](peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform. +- [piwigo](piwigo/README.md): Piwigo, a photo management software. +- [forgejo](forgejo/README.md): Forgejo, a community managed lightweight code hosting solution. +- [roundcube](roundcube/README.md): Roundcube, a webmail. +- [nextcloud](nextcloud/README.md): Nextcloud, Online collaboration platform. +- [gitea](gitea/README.md): Transitional package for Gitea to Forgejo. diff --git a/seed/README.ReverseProxy.md b/seed/README.ReverseProxy.md new file mode 100644 index 0000000..6dfb166 --- /dev/null +++ b/seed/README.ReverseProxy.md @@ -0,0 +1,44 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# ReverseProxy + +## Synopsis + +Register to service to a reverse proxy server. + +## Variables + +| Parameter | Comment | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| +| **ReverseProxy:external**
mandatory, multiple
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | External domain name for *supplier name*. | +| **ReverseProxy:location**
mandatory
**Type:** [`filename`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | URI to redirect for *supplier name*.
Relative redirected URI (without domaine name).
**Example:** /mail | +| **ReverseProxy:max_body_size**
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Body size max for *supplier name*. | +| **ReverseProxy:websocket**
mandatory
**Type:** [`boolean`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The entry point is a websocket for *supplier name*.
**Default:** [True] | +| **ReverseProxy:url**
mandatory
**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Internal URL for *supplier name*. | +| **ReverseProxy:http**
mandatory
**Type:** [`boolean`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The website is in HTTP for *supplier name*.
**Default:** True | + +## Provider + +[nginx-reverse-proxy](nginx-reverse-proxy/README.md): Nginx as reverse proxy. + +## Suppliers + +- [odoo](odoo/README.md): Odoo, an ERP and CRM. +- [nginx-static](nginx-static/README.md): Nginx as static web site. +- [grafana](grafana/README.md): Grafana is an analytics and interactive visualization web application. +- [mailman](mailman/README.md): GNU Mailman, managing electronic mail discussion and e-newsletter lists. +- [peertube](peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform. +- [piwigo](piwigo/README.md): Piwigo, a photo management software. +- [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. +- [speedtest-rs](speedtest-rs/README.md): Speedtest-rs, a very lightweight Speedtest. +- [roundcube](roundcube/README.md): Roundcube, a webmail. +- [vaultwarden](vaultwarden/README.md): Vaultwarden, a password manager. +- [nextcloud](nextcloud/README.md): Nextcloud, Online collaboration platform. +- [lemonldap](lemonldap/README.md): LemonLDAP, a Web Single Sign On and Access Management. +- [gitea](gitea/README.md): Transitional package for Gitea to Forgejo. diff --git a/seed/README.SMTP.md b/seed/README.SMTP.md new file mode 100644 index 0000000..4f62ec2 --- /dev/null +++ b/seed/README.SMTP.md @@ -0,0 +1,37 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# SMTP + +## Synopsis + +Create a SMTP relay account and authorize sending email.
A service needs send email with SMTP protocol, so an account is created and SMTP relay accept sending mail by this account. + +## Variables + +| Parameter | Comment | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| +| **SMTP:username**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | User account to send email for *supplier name*. | +| **SMTP:password**
mandatory
**Type:** [`secret`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Password to send email for *supplier name*. | + +## Provider + +[postfix-relay](postfix-relay/README.md): Postfix, the mail server, as relay. + +## Suppliers + +- [odoo](odoo/README.md): Odoo, an ERP and CRM. +- [grafana](grafana/README.md): Grafana is an analytics and interactive visualization web application. +- [mailman](mailman/README.md): GNU Mailman, managing electronic mail discussion and e-newsletter lists. +- [peertube](peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform. +- [piwigo](piwigo/README.md): Piwigo, a photo management software. +- [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. +- [vaultwarden](vaultwarden/README.md): Vaultwarden, a password manager. +- [nextcloud](nextcloud/README.md): Nextcloud, Online collaboration platform. +- [lemonldap](lemonldap/README.md): LemonLDAP, a Web Single Sign On and Access Management. +- [gitea](gitea/README.md): Transitional package for Gitea to Forgejo. diff --git a/seed/README.Vector.md b/seed/README.Vector.md new file mode 100644 index 0000000..b9ec073 --- /dev/null +++ b/seed/README.Vector.md @@ -0,0 +1,22 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# Vector + +## Synopsis + +Collect observability data from another Vector instance. + +## Variables + +| Parameter | Comment | +|-------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| **Vector:address**
**Type:** [`ip`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Send Journal on this IP address.
Vector must listen on this address, clients are configured to use this destination IP. | + +## Provider + +[vector](vector/README.md): Vector, a lightweight, ultra-fast tool for building observability pipelines. diff --git a/seed/README.md b/seed/README.md index e13feb2..73689e4 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 @@ -72,55 +72,20 @@ - [reverse-proxy-client](reverse-proxy-client/README.md): Application service needs interact with a a reverse proxy server - [systemd](systemd/README.md): Systemd, a system and service manager -# Providers and suppliers +# Providers -- ExternalDNS: - - Provider: [unbound](unbound/README.md) - - Suppliers: - - [dns-external](dns-external/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) -- Journald: - - Provider: [journald_remote](journald_remote/README.md) - - Supplier: [journald](journald/README.md) -- LDAP: - - Provider: [openldap](openldap/README.md) - - Supplier: [ldap-client](ldap-client/README.md) -- LMTP: - - Provider: [postfix-lmtp-relay](postfix-lmtp-relay/README.md) - - Supplier: [relay-lmtp-client](relay-lmtp-client/README.md) -- LocalDNS: - - Provider: [nsd-local](nsd-local/README.md) - - Supplier: [dns-local](dns-local/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) -- OAuth2: - - Provider: [lemonldap](lemonldap/README.md) - - Supplier: [oauth2-client](oauth2-client/README.md) -- Postgresql: - - Provider: [postgresql](postgresql/README.md) - - Supplier: [postgresql-client](postgresql-client/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) -- ReverseProxy: - - Provider: [nginx-reverse-proxy](nginx-reverse-proxy/README.md) - - Supplier: [reverse-proxy-client](reverse-proxy-client/README.md) -- SMTP: - - Provider: [postfix-relay](postfix-relay/README.md) - - Supplier: [relay-mail-client](relay-mail-client/README.md) -- Vector: - - Provider: [vector](vector/README.md) - - Supplier: [host-systemd-machined](host-systemd-machined/README.md) +- [ExternalDNS](README.ExternalDNS.md): DNS forwarder for all DNS zones. +- [IMAP](README.IMAP.md): IMAP server connexion. +- [Journald](README.Journald.md): Concentrate journal messages on one host. +- [LDAP](README.LDAP.md): Create account and connexion to a LDAP server. +- [LMTP](README.LMTP.md): LMTP remote server. +- [LocalDNS](README.LocalDNS.md): DNS forwarder for local domain name. +- [Loki](README.Loki.md): Concentrate log messages. +- [MariaDB](README.MariaDB.md): Create account and connexion to a MariaDB server. +- [OAuth2](README.OAuth2.md): Remote clients needing to verify OAuth2 account. +- [Postgresql](README.Postgresql.md): Create account and connexion to a PostgreSQL server. +- [Prometheus](README.Prometheus.md): Configure Prometheus exporter. +- [Redis](README.Redis.md): Create account and connexion to a Redis server. +- [ReverseProxy](README.ReverseProxy.md): Register to service to a reverse proxy server. +- [SMTP](README.SMTP.md): Create a SMTP relay account and authorize sending email. +- [Vector](README.Vector.md): Collect observability data from another Vector instance. diff --git a/seed/apache/README.md b/seed/apache/README.md index 661853c..d7004c6 100644 --- a/seed/apache/README.md +++ b/seed/apache/README.md @@ -3,35 +3,34 @@ 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 -- [reverse-proxy-client](../reverse-proxy-client/README.md) +- [reverse-proxy-client](../reverse-proxy-client/README.md): Application service needs interact with a a reverse proxy server. ## 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 7a2aaf0..c885b4c 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 ec2829e..32941e5 100644 --- a/seed/base-debian-bullseye/README.md +++ b/seed/base-debian-bullseye/README.md @@ -3,29 +3,28 @@ 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 -- [base-debian](../base-debian/README.md) - - [systemd](../systemd/README.md) - - [base-machine](../base-machine/README.md) - - [base](../base/README.md) - - [dns-local](../dns-local/README.md) - - [pki-tls](../pki-tls/README.md) - - [journald](../journald/README.md) - - [resolved](../resolved/README.md) +- [base-debian](../base-debian/README.md): Base information of a Debian server. + - [systemd](../systemd/README.md): Systemd, a system and service manager. + - [base-machine](../base-machine/README.md): Base information for a machine. + - [base](../base/README.md): Base of all application services. + - [dns-local](../dns-local/README.md): DNS client with access to local zones. + - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates. + - [journald](../journald/README.md): Journald. + - [resolved](../resolved/README.md): Resolved. ## Used by - [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..fb34da0 100644 --- a/seed/base-debian/README.md +++ b/seed/base-debian/README.md @@ -3,26 +3,25 @@ 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 -- [systemd](../systemd/README.md) - - [base-machine](../base-machine/README.md) - - [base](../base/README.md) - - [dns-local](../dns-local/README.md) - - [pki-tls](../pki-tls/README.md) - - [journald](../journald/README.md) - - [resolved](../resolved/README.md) +- [systemd](../systemd/README.md): Systemd, a system and service manager. + - [base-machine](../base-machine/README.md): Base information for a machine. + - [base](../base/README.md): Base of all application services. + - [dns-local](../dns-local/README.md): DNS client with access to local zones. + - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates. + - [journald](../journald/README.md): Journald. + - [resolved](../resolved/README.md): Resolved. ## 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..6add3e3 100644 --- a/seed/base-fedora-35/README.md +++ b/seed/base-fedora-35/README.md @@ -3,27 +3,26 @@ 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 -- [base-fedora](../base-fedora/README.md) - - [systemd](../systemd/README.md) - - [base-machine](../base-machine/README.md) - - [base](../base/README.md) - - [dns-local](../dns-local/README.md) - - [pki-tls](../pki-tls/README.md) - - [journald](../journald/README.md) - - [resolved](../resolved/README.md) +- [base-fedora](../base-fedora/README.md): Base information of a Fedora. + - [systemd](../systemd/README.md): Systemd, a system and service manager. + - [base-machine](../base-machine/README.md): Base information for a machine. + - [base](../base/README.md): Base of all application services. + - [dns-local](../dns-local/README.md): DNS client with access to local zones. + - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates. + - [journald](../journald/README.md): Journald. + - [resolved](../resolved/README.md): Resolved. ## 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..a5b172f 100644 --- a/seed/base-fedora-36/README.md +++ b/seed/base-fedora-36/README.md @@ -3,24 +3,25 @@ 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 -- [base-fedora](../base-fedora/README.md) - - [systemd](../systemd/README.md) - - [base-machine](../base-machine/README.md) - - [base](../base/README.md) - - [dns-local](../dns-local/README.md) - - [pki-tls](../pki-tls/README.md) - - [journald](../journald/README.md) - - [resolved](../resolved/README.md) +- [base-fedora](../base-fedora/README.md): Base information of a Fedora. + - [systemd](../systemd/README.md): Systemd, a system and service manager. + - [base-machine](../base-machine/README.md): Base information for a machine. + - [base](../base/README.md): Base of all application services. + - [dns-local](../dns-local/README.md): DNS client with access to local zones. + - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates. + - [journald](../journald/README.md): Journald. + - [resolved](../resolved/README.md): Resolved. ## Used by @@ -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..656eab5 100644 --- a/seed/base-fedora-37/README.md +++ b/seed/base-fedora-37/README.md @@ -3,24 +3,25 @@ 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 -- [base-fedora](../base-fedora/README.md) - - [systemd](../systemd/README.md) - - [base-machine](../base-machine/README.md) - - [base](../base/README.md) - - [dns-local](../dns-local/README.md) - - [pki-tls](../pki-tls/README.md) - - [journald](../journald/README.md) - - [resolved](../resolved/README.md) +- [base-fedora](../base-fedora/README.md): Base information of a Fedora. + - [systemd](../systemd/README.md): Systemd, a system and service manager. + - [base-machine](../base-machine/README.md): Base information for a machine. + - [base](../base/README.md): Base of all application services. + - [dns-local](../dns-local/README.md): DNS client with access to local zones. + - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates. + - [journald](../journald/README.md): Journald. + - [resolved](../resolved/README.md): Resolved. ## Used by @@ -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..0103d01 100644 --- a/seed/base-fedora-38/README.md +++ b/seed/base-fedora-38/README.md @@ -3,24 +3,25 @@ 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 -- [base-fedora](../base-fedora/README.md) - - [systemd](../systemd/README.md) - - [base-machine](../base-machine/README.md) - - [base](../base/README.md) - - [dns-local](../dns-local/README.md) - - [pki-tls](../pki-tls/README.md) - - [journald](../journald/README.md) - - [resolved](../resolved/README.md) +- [base-fedora](../base-fedora/README.md): Base information of a Fedora. + - [systemd](../systemd/README.md): Systemd, a system and service manager. + - [base-machine](../base-machine/README.md): Base information for a machine. + - [base](../base/README.md): Base of all application services. + - [dns-local](../dns-local/README.md): DNS client with access to local zones. + - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates. + - [journald](../journald/README.md): Journald. + - [resolved](../resolved/README.md): Resolved. ## Used by @@ -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..89b9f61 100644 --- a/seed/base-fedora/README.md +++ b/seed/base-fedora/README.md @@ -3,23 +3,24 @@ 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 -- [systemd](../systemd/README.md) - - [base-machine](../base-machine/README.md) - - [base](../base/README.md) - - [dns-local](../dns-local/README.md) - - [pki-tls](../pki-tls/README.md) - - [journald](../journald/README.md) - - [resolved](../resolved/README.md) +- [systemd](../systemd/README.md): Systemd, a system and service manager. + - [base-machine](../base-machine/README.md): Base information for a machine. + - [base](../base/README.md): Base of all application services. + - [dns-local](../dns-local/README.md): DNS client with access to local zones. + - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates. + - [journald](../journald/README.md): Journald. + - [resolved](../resolved/README.md): Resolved. ## Used by @@ -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..afa89d4 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 @@ -21,12 +23,10 @@ Base information for a machine. ## Dependances -- [base](../base/README.md) -- [dns-local](../dns-local/README.md) -- [pki-tls](../pki-tls/README.md) +- [base](../base/README.md): Base of all application services. +- [dns-local](../dns-local/README.md): DNS client with access to local zones. +- [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates. ## 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/base/dictionaries/00_base.xml b/seed/base/dictionaries/00_base.xml index 031667c..2ccdace 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 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..2758fb9 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 78203c7..4cd0191 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 ed2d599..39f17ef 100644 --- a/seed/dovecot/README.md +++ b/seed/dovecot/README.md @@ -3,73 +3,16 @@ 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/) -## Basic variables - -### Général - -#### Mail configuration - -##### 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 | - -## Variables - -### 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 - -#### Annuaire OpenLDAP - -##### 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* | - - - -## Requirements services - -- **LocalDNS** -- Journald -- **SMTP** -- **LDAP** -- **ReverseProxy** -- **LMTP** -- **OAuth2** - -**bold**: provider is mandatory +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. ## Example @@ -82,10 +25,9 @@ dovecot: zones_name: - ldap - localdns + - oauth2 - reverseproxy - smtp - - lmtp - - oauth2 values: general.mail.domain.mail_domains: - example.net @@ -95,27 +37,76 @@ dovecot: '0': submission.example.net ``` +## Basic variables + +### 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) | 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 | + +| 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` | + +## Variables + +### General + +#### OpenLDAP directory + +##### Client + +| Parameter | Comment | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| +| **[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 + +### Mandatories + +- [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name. +- [SMTP](../README.SMTP.md): Create a SMTP relay account and authorize sending email. +- [LDAP](../README.LDAP.md): Create account and connexion to a LDAP server. +- [ReverseProxy](../README.ReverseProxy.md): Register to service to a reverse proxy server. +- [OAuth2](../README.OAuth2.md): Remote clients needing to verify OAuth2 account. + +### Optionals + +- [Journald](../README.Journald.md): Concentrate journal messages on one host. + ## Dependances -- [base-fedora-36](../base-fedora-36/README.md) - - [base-fedora](../base-fedora/README.md) - - [systemd](../systemd/README.md) - - [base-machine](../base-machine/README.md) - - [base](../base/README.md) - - [dns-local](../dns-local/README.md) - - [pki-tls](../pki-tls/README.md) - - [journald](../journald/README.md) - - [resolved](../resolved/README.md) -- [relay-lmtp-client](../relay-lmtp-client/README.md) - - [relay-mail-client](../relay-mail-client/README.md) -- [ldap-client](../ldap-client/README.md) -- [oauth2-client](../oauth2-client/README.md) -- [nginx-https](../nginx-https/README.md) - - [nginx-common](../nginx-common/README.md) - - [reverse-proxy-client](../reverse-proxy-client/README.md) +- [base-fedora-36](../base-fedora-36/README.md): Base information of a Fedora 36. + - [base-fedora](../base-fedora/README.md): Base information of a Fedora. + - [systemd](../systemd/README.md): Systemd, a system and service manager. + - [base-machine](../base-machine/README.md): Base information for a machine. + - [base](../base/README.md): Base of all application services. + - [dns-local](../dns-local/README.md): DNS client with access to local zones. + - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates. + - [journald](../journald/README.md): Journald. + - [resolved](../resolved/README.md): Resolved. +- [relay-lmtp-client](../relay-lmtp-client/README.md): Application service needs interact with a Postfix server with LMTP protocol. + - [relay-mail-client](../relay-mail-client/README.md): Client SMTP. +- [ldap-client](../ldap-client/README.md): Application service needs interact with a LDAP server. +- [oauth2-client](../oauth2-client/README.md): Application service needs interact with a Oauth2 server. +- [nginx-https](../nginx-https/README.md): Nginx as HTTPS web site. + - [nginx-common](../nginx-common/README.md): Nginx common configuration. + - [reverse-proxy-client](../reverse-proxy-client/README.md): Application service needs interact with a a reverse proxy server. -## 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 3875576..9c6d812 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 6aab827..06d5381 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 f45092d..55e986b 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 1454e67..0cf0702 100644 --- a/seed/forgejo/README.md +++ b/seed/forgejo/README.md @@ -3,28 +3,49 @@ 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/) + +## Example + +Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. + +``` +forgejo: + applicationservice: forgejo + zones_name: + - localdns + - oauth2 + - postgresql + - redis + - reverseproxy + - smtp + values: + general.revprox.revprox_client.revprox_client_external_domainnames: + - service.example.net + general.forgejo.forgejo_mail_sender: admin@example.net +``` ## 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 | Comment | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------| +| **[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 @@ -35,39 +56,23 @@ Git forge Forgejo. | **[general.forgejo.forgejo_title](dictionaries/31_forgejo.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Titre de la forge.
**Default:** Forgejo : Au-delà du développement. Nous forgeons. | | **[general.forgejo.forgejo_mail_sender](dictionaries/31_forgejo.xml)**
mandatory
**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Les courriels sont envoyés à partir de cet adresse.
**Example:** admin@example.net | +## Variables -## 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 | Comment | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| **[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 -| Parameter | Comments | +| Parameter | Comment | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------| | **[general.oauth2_client.oauth2_client_name](dictionaries/31_forgejo.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.
**Default:** Forge
**Example:** example | | **[general.oauth2_client.oauth2_client_description](dictionaries/31_forgejo.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.
**Default:** Forge logiciel Forgejo
**Example:** Example description | @@ -80,65 +85,47 @@ This family is a leadership. | **[general.oauth2_client.external.oauth2_client_external](dictionaries/31_forgejo.xml)**
mandatory, multiple
**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client external.
**Default:** *calculated* | | **[general.oauth2_client.external.oauth2_client_family](dictionaries/30_oauth2_client.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 family.
**Default:** users | -| Parameter | Comments | +| Parameter | Comment | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| | **[general.oauth2_client.oauth2_client_category](dictionaries/31_forgejo.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.
**Default:** Développement | | **[general.oauth2_client.oauth2_client_logo](dictionaries/31_forgejo.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.
**Default:** silique_note.png | + ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **ReverseProxy** -- **Postgresql** -- **Redis** -- **OAuth2** +### Mandatories -**bold**: provider is mandatory +- [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name. +- [SMTP](../README.SMTP.md): Create a SMTP relay account and authorize sending email. +- [ReverseProxy](../README.ReverseProxy.md): Register to service to a reverse proxy server. +- [Postgresql](../README.Postgresql.md): Create account and connexion to a PostgreSQL server. +- [OAuth2](../README.OAuth2.md): Remote clients needing to verify OAuth2 account. +- [Redis](../README.Redis.md): Create account and connexion to a Redis server. -## Example +### Optionals -Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. - -``` -forgejo: - applicationservice: forgejo - zones_name: - - localdns - - reverseproxy - - smtp - - redis - - oauth2 - - postgresql - values: - general.revprox.revprox_client.revprox_client_external_domainnames: - - service.example.net - general.forgejo.forgejo_mail_sender: admin@example.net -``` +- [Journald](../README.Journald.md): Concentrate journal messages on one host. ## Dependances -- [base-fedora-38](../base-fedora-38/README.md) - - [base-fedora](../base-fedora/README.md) - - [systemd](../systemd/README.md) - - [base-machine](../base-machine/README.md) - - [base](../base/README.md) - - [dns-local](../dns-local/README.md) - - [pki-tls](../pki-tls/README.md) - - [journald](../journald/README.md) - - [resolved](../resolved/README.md) -- [postgresql-client](../postgresql-client/README.md) -- [reverse-proxy-client](../reverse-proxy-client/README.md) -- [relay-mail-client](../relay-mail-client/README.md) -- [redis-client](../redis-client/README.md) - - [redis-common](../redis-common/README.md) -- [oauth2-client](../oauth2-client/README.md) +- [base-fedora-38](../base-fedora-38/README.md): Base information of a Fedora 38. + - [base-fedora](../base-fedora/README.md): Base information of a Fedora. + - [systemd](../systemd/README.md): Systemd, a system and service manager. + - [base-machine](../base-machine/README.md): Base information for a machine. + - [base](../base/README.md): Base of all application services. + - [dns-local](../dns-local/README.md): DNS client with access to local zones. + - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates. + - [journald](../journald/README.md): Journald. + - [resolved](../resolved/README.md): Resolved. +- [postgresql-client](../postgresql-client/README.md): Application service needs interact with a Postgresql server. +- [reverse-proxy-client](../reverse-proxy-client/README.md): Application service needs interact with a a reverse proxy server. +- [relay-mail-client](../relay-mail-client/README.md): Client SMTP. +- [redis-client](../redis-client/README.md): Application service needs interact with a Redis server. + - [redis-common](../redis-common/README.md): Redis, an in-memory data structure store. +- [oauth2-client](../oauth2-client/README.md): Application service needs interact with a Oauth2 server. ## 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..954dd13 100644 --- a/seed/gitea/README.md +++ b/seed/gitea/README.md @@ -3,32 +3,53 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # gitea ## Synopsis Transitional package for Gitea to Forgejo. +## Example + +Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. + +``` +gitea: + applicationservice: gitea + zones_name: + - localdns + - oauth2 + - postgresql + - redis + - reverseproxy + - smtp + values: + general.revprox.revprox_client.revprox_client_external_domainnames: + - service.example.net +``` + ## 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 | Comment | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------| +| **[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 Git forge Forgejo. -| Parameter | Comments | +| Parameter | Comment | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------| | **[general.forgejo.forgejo_title](dictionaries/31_forgejo.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Titre de la forge.
**Default:** Forgejo : Au-delà du développement. Nous forgeons. | @@ -36,54 +57,21 @@ Git forge Forgejo. ## Variables -### Général - -#### Forgejo - -Git forge Forgejo. - -| Parameter | Comments | -|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------| -| **[general.forgejo.forgejo_mail_sender](dictionaries/31_forgejo.xml)**
mandatory
**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Les courriels sont envoyés à partir de cet adresse.
**Default:** *calculated*
**Example:** admin@example.net | - -#### Transitional family - -| Parameter | Comments | -|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------| -| **[general.gitea.gitea_mail_sender](dictionaries/32_gitea.xml)**
**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Transitional variable, please do not use it. | - -## 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 | Comment | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| **[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 -| Parameter | Comments | +| Parameter | Comment | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------| | **[general.oauth2_client.oauth2_client_name](dictionaries/31_forgejo.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.
**Default:** Forge
**Example:** example | | **[general.oauth2_client.oauth2_client_description](dictionaries/31_forgejo.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.
**Default:** Forge logiciel Forgejo
**Example:** Example description | @@ -96,61 +84,56 @@ This family is a leadership. | **[general.oauth2_client.external.oauth2_client_external](dictionaries/31_forgejo.xml)**
mandatory, multiple
**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client external.
**Default:** *calculated* | | **[general.oauth2_client.external.oauth2_client_family](dictionaries/30_oauth2_client.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 family.
**Default:** users | -| Parameter | Comments | +| Parameter | Comment | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| | **[general.oauth2_client.oauth2_client_category](dictionaries/31_forgejo.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.
**Default:** Développement | | **[general.oauth2_client.oauth2_client_logo](dictionaries/31_forgejo.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.
**Default:** silique_note.png | +#### Forgejo + +Git forge Forgejo. + +| Parameter | Comment | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------| +| **[general.forgejo.forgejo_mail_sender](dictionaries/31_forgejo.xml)**
mandatory
**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Les courriels sont envoyés à partir de cet adresse.
**Default:** *calculated*
**Example:** admin@example.net | + +#### Transitional family + +| Parameter | Comments | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------| +| **[general.gitea.gitea_mail_sender](dictionaries/32_gitea.xml)**
**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Transitional variable, please do not use it. | ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **ReverseProxy** -- **Postgresql** -- **Redis** -- **OAuth2** +### Mandatories -**bold**: provider is mandatory +- [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name. +- [SMTP](../README.SMTP.md): Create a SMTP relay account and authorize sending email. +- [ReverseProxy](../README.ReverseProxy.md): Register to service to a reverse proxy server. +- [Postgresql](../README.Postgresql.md): Create account and connexion to a PostgreSQL server. +- [OAuth2](../README.OAuth2.md): Remote clients needing to verify OAuth2 account. +- [Redis](../README.Redis.md): Create account and connexion to a Redis server. -## Example +### Optionals -Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. - -``` -gitea: - applicationservice: gitea - zones_name: - - localdns - - reverseproxy - - smtp - - redis - - oauth2 - - postgresql - values: - general.revprox.revprox_client.revprox_client_external_domainnames: - - service.example.net -``` +- [Journald](../README.Journald.md): Concentrate journal messages on one host. ## Dependances -- [forgejo](../forgejo/README.md) - - [base-fedora-38](../base-fedora-38/README.md) - - [base-fedora](../base-fedora/README.md) - - [systemd](../systemd/README.md) - - [base-machine](../base-machine/README.md) - - [base](../base/README.md) - - [dns-local](../dns-local/README.md) - - [pki-tls](../pki-tls/README.md) - - [journald](../journald/README.md) - - [resolved](../resolved/README.md) - - [postgresql-client](../postgresql-client/README.md) - - [reverse-proxy-client](../reverse-proxy-client/README.md) - - [relay-mail-client](../relay-mail-client/README.md) - - [redis-client](../redis-client/README.md) - - [redis-common](../redis-common/README.md) - - [oauth2-client](../oauth2-client/README.md) - -[All applications services for this dataset.](../README.md) +- [forgejo](../forgejo/README.md): Forgejo, a community managed lightweight code hosting solution. + - [base-fedora-38](../base-fedora-38/README.md): Base information of a Fedora 38. + - [base-fedora](../base-fedora/README.md): Base information of a Fedora. + - [systemd](../systemd/README.md): Systemd, a system and service manager. + - [base-machine](../base-machine/README.md): Base information for a machine. + - [base](../base/README.md): Base of all application services. + - [dns-local](../dns-local/README.md): DNS client with access to local zones. + - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates. + - [journald](../journald/README.md): Journald. + - [resolved](../resolved/README.md): Resolved. + - [postgresql-client](../postgresql-client/README.md): Application service needs interact with a Postgresql server. + - [reverse-proxy-client](../reverse-proxy-client/README.md): Application service needs interact with a a reverse proxy server. + - [relay-mail-client](../relay-mail-client/README.md): Client SMTP. + - [redis-client](../redis-client/README.md): Application service needs interact with a Redis server. + - [redis-common](../redis-common/README.md): Redis, an in-memory data structure store. + - [oauth2-client](../oauth2-client/README.md): Application service needs interact with a Oauth2 server. diff --git a/seed/grafana/README.md b/seed/grafana/README.md index 46cbcb0..579ec07 100644 --- a/seed/grafana/README.md +++ b/seed/grafana/README.md @@ -3,28 +3,48 @@ 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/) + +## Example + +Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. + +``` +grafana: + applicationservice: grafana + zones_name: + - localdns + - oauth2 + - postgresql + - reverseproxy + - smtp + values: + general.revprox.revprox_client.revprox_client_external_domainnames: + - service.example.net + general.oauth2_client.oauth2_email_domain: example.net +``` ## 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 | Comment | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------| +| **[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 @@ -34,32 +54,23 @@ This family is a leadership. |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------| | **[general.oauth2_client.oauth2_email_domain](dictionaries/31_grafana.xml)**
mandatory
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Domain name allowed to log on Grafana.
**Example:** example.net | +## Variables -## 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 | Comment | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| **[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 -| Parameter | Comments | +| Parameter | Comment | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------| | **[general.oauth2_client.oauth2_client_name](dictionaries/31_grafana.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.
**Default:** Grafana
**Example:** example | | **[general.oauth2_client.oauth2_client_description](dictionaries/31_grafana.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.
**Default:** Visualisation de données
**Example:** Example description | @@ -77,50 +88,33 @@ This family is a leadership. | **[general.oauth2_client.oauth2_client_category](dictionaries/31_grafana.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.
**Default:** Administration | | **[general.oauth2_client.oauth2_client_logo](dictionaries/31_grafana.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.
**Default:** silique_note.png | + ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **ReverseProxy** -- **Postgresql** -- **OAuth2** +### Mandatories -**bold**: provider is mandatory +- [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name. +- [SMTP](../README.SMTP.md): Create a SMTP relay account and authorize sending email. +- [ReverseProxy](../README.ReverseProxy.md): Register to service to a reverse proxy server. +- [Postgresql](../README.Postgresql.md): Create account and connexion to a PostgreSQL server. +- [OAuth2](../README.OAuth2.md): Remote clients needing to verify OAuth2 account. -## Example +### Optionals -Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. - -``` -grafana: - applicationservice: grafana - zones_name: - - localdns - - reverseproxy - - smtp - - oauth2 - - postgresql - values: - general.revprox.revprox_client.revprox_client_external_domainnames: - - service.example.net - general.oauth2_client.oauth2_email_domain: example.net -``` +- [Journald](../README.Journald.md): Concentrate journal messages on one host. ## Dependances -- [base-fedora-38](../base-fedora-38/README.md) - - [base-fedora](../base-fedora/README.md) - - [systemd](../systemd/README.md) - - [base-machine](../base-machine/README.md) - - [base](../base/README.md) - - [dns-local](../dns-local/README.md) - - [pki-tls](../pki-tls/README.md) - - [journald](../journald/README.md) - - [resolved](../resolved/README.md) -- [postgresql-client](../postgresql-client/README.md) -- [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) +- [base-fedora-38](../base-fedora-38/README.md): Base information of a Fedora 38. + - [base-fedora](../base-fedora/README.md): Base information of a Fedora. + - [systemd](../systemd/README.md): Systemd, a system and service manager. + - [base-machine](../base-machine/README.md): Base information for a machine. + - [base](../base/README.md): Base of all application services. + - [dns-local](../dns-local/README.md): DNS client with access to local zones. + - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates. + - [journald](../journald/README.md): Journald. + - [resolved](../resolved/README.md): Resolved. +- [postgresql-client](../postgresql-client/README.md): Application service needs interact with a Postgresql server. +- [oauth2-client](../oauth2-client/README.md): Application service needs interact with a Oauth2 server. +- [reverse-proxy-client](../reverse-proxy-client/README.md): Application service needs interact with a a reverse proxy server. +- [relay-mail-client](../relay-mail-client/README.md): Client SMTP. diff --git a/seed/host-systemd-machined/README.md b/seed/host-systemd-machined/README.md index 8799fc5..0dc4b4c 100644 --- a/seed/host-systemd-machined/README.md +++ b/seed/host-systemd-machined/README.md @@ -3,21 +3,22 @@ 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 -| Parameter | Comments | +| Parameter | Comment | |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| | **[general.network.output_interface](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) | Nom de l'interface de sortie. | @@ -34,34 +35,29 @@ This family is a leadership. ## Variables -### Général +### General -| Parameter | Comments | +| Parameter | Comment | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------| | **[general.vm_swappiness](dictionaries/21_machined.xml)**
mandatory
**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Ajustement de la mémoire virtuelle.
**Default:** 60 | +#### base + +| Parameter | Comment | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| **[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 | + #### network ##### interfaces 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` | ## 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) +- [base](../base/README.md): Base of all application services. diff --git a/seed/host-systemd-machined/dictionaries/21_machined.xml b/seed/host-systemd-machined/dictionaries/21_machined.xml index b6fbbe8..39e9bef 100644 --- a/seed/host-systemd-machined/dictionaries/21_machined.xml +++ b/seed/host-systemd-machined/dictionaries/21_machined.xml @@ -33,10 +33,10 @@ - +