From fd3c7ffcf4ad54f1383e75643b782675aa5c60dd Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Fri, 11 Aug 2023 09:38:05 +0200 Subject: [PATCH] update doc --- seed/README.md | 143 ++++++++++++++++++++--- seed/apache/README.md | 7 +- seed/base-debian-bullseye/README.md | 7 +- seed/base-debian/README.md | 7 +- seed/base-fedora-35/README.md | 7 +- seed/base-fedora-36/README.md | 7 +- seed/base-fedora-37/README.md | 7 +- seed/base-fedora-38/README.md | 7 +- seed/base-fedora/README.md | 7 +- seed/base-machine/README.md | 4 +- seed/base/README.md | 4 +- seed/dns-external/README.md | 8 +- seed/dns-local/README.md | 8 +- seed/dovecot/README.md | 61 +++++----- seed/forgejo/README.md | 32 ++--- seed/gitea/README.md | 29 +++-- seed/grafana/README.md | 28 +++-- seed/host-systemd-machined/README.md | 16 +-- seed/imap-client/README.md | 8 +- seed/journald/README.md | 11 +- seed/journald_remote/README.md | 11 +- seed/ldap-client/README.md | 8 +- seed/lemonldap/README.md | 35 ++++-- seed/loki/README.md | 18 +-- seed/mailman/README.md | 30 ++--- seed/mariadb-client/README.md | 11 +- seed/mariadb/README.md | 20 ++-- seed/nextcloud/README.md | 34 +++--- seed/nginx-common/README.md | 7 +- seed/nginx-https/README.md | 7 +- seed/nginx-reverse-proxy/README.md | 52 +++++++-- seed/nginx-static/README.md | 18 +-- seed/nsd-local/README.md | 50 +++++--- seed/nsd/README.md | 16 ++- seed/oauth2-client/README.md | 8 +- seed/odoo/README.md | 30 ++--- seed/openldap/README.md | 25 ++-- seed/peertube/README.md | 34 +++--- seed/php-fpm/README.md | 4 +- seed/php/README.md | 7 +- seed/piwigo/README.md | 32 ++--- seed/pki-tls/README.md | 4 +- seed/postfix-lmtp-relay/README.md | 11 +- seed/postfix-relay/README.md | 48 +++++--- seed/postgresql-client/README.md | 11 +- seed/postgresql/README.md | 28 +++-- seed/prometheus/README.md | 18 +-- seed/provider-systemd-machined/README.md | 11 +- seed/redis-client/README.md | 11 +- seed/redis-common/README.md | 7 +- seed/redis/README.md | 25 ++-- seed/relay-lmtp-client/README.md | 8 +- seed/relay-mail-client/README.md | 8 +- seed/resolved/README.md | 7 +- seed/reverse-proxy-client/README.md | 8 +- seed/roundcube/README.md | 34 +++--- seed/speedtest-rs/README.md | 18 +-- seed/systemd/README.md | 7 +- seed/unbound/README.md | 20 ++-- seed/unbound/dictionaries/20_unbound.xml | 2 +- seed/vaultwarden/README.md | 24 ++-- seed/vector/README.md | 55 ++++++--- seed/znc/README.md | 42 +++---- 63 files changed, 743 insertions(+), 529 deletions(-) diff --git a/seed/README.md b/seed/README.md index e13feb25..9226e9b7 100644 --- a/seed/README.md +++ b/seed/README.md @@ -77,50 +77,159 @@ - ExternalDNS: - Provider: [unbound](unbound/README.md) - Suppliers: - - [dns-external](dns-external/README.md) + - [postfix-relay](postfix-relay/README.md) + - [peertube](peertube/README.md) + - [znc](znc/README.md) - [nsd-local](nsd-local/README.md) -- Host: - - Provider: [host-systemd-machined](host-systemd-machined/README.md) - - Supplier: [provider-systemd-machined](provider-systemd-machined/README.md) - IMAP: - Provider: [dovecot](dovecot/README.md) - - Supplier: [imap-client](imap-client/README.md) + - Supplier: [roundcube](roundcube/README.md) - Journald: - - Provider: [journald_remote](journald_remote/README.md) - - Supplier: [journald](journald/README.md) + - Provider: [vector](vector/README.md) + - Suppliers: + - [odoo](odoo/README.md) + - [nginx-static](nginx-static/README.md) + - [grafana](grafana/README.md) + - [postgresql](postgresql/README.md) + - [postfix-relay](postfix-relay/README.md) + - [mailman](mailman/README.md) + - [peertube](peertube/README.md) + - [piwigo](piwigo/README.md) + - [vector](vector/README.md) + - [dovecot](dovecot/README.md) + - [unbound](unbound/README.md) + - [redis](redis/README.md) + - [loki](loki/README.md) + - [forgejo](forgejo/README.md) + - [nsd](nsd/README.md) + - [speedtest-rs](speedtest-rs/README.md) + - [nginx-reverse-proxy](nginx-reverse-proxy/README.md) + - [roundcube](roundcube/README.md) + - [znc](znc/README.md) + - [vaultwarden](vaultwarden/README.md) + - [prometheus](prometheus/README.md) + - [mariadb](mariadb/README.md) + - [nsd-local](nsd-local/README.md) + - [nextcloud](nextcloud/README.md) + - [lemonldap](lemonldap/README.md) + - [openldap](openldap/README.md) + - [gitea](gitea/README.md) - LDAP: - Provider: [openldap](openldap/README.md) - - Supplier: [ldap-client](ldap-client/README.md) + - Suppliers: + - [odoo](odoo/README.md) + - [piwigo](piwigo/README.md) + - [dovecot](dovecot/README.md) + - [roundcube](roundcube/README.md) + - [nextcloud](nextcloud/README.md) + - [lemonldap](lemonldap/README.md) - LMTP: - - Provider: [postfix-lmtp-relay](postfix-lmtp-relay/README.md) - - Supplier: [relay-lmtp-client](relay-lmtp-client/README.md) + - Provider: [postfix-relay](postfix-relay/README.md) + - Suppliers: + - [mailman](mailman/README.md) + - [dovecot](dovecot/README.md) - LocalDNS: - Provider: [nsd-local](nsd-local/README.md) - - Supplier: [dns-local](dns-local/README.md) + - Suppliers: + - [odoo](odoo/README.md) + - [nginx-static](nginx-static/README.md) + - [grafana](grafana/README.md) + - [postgresql](postgresql/README.md) + - [mailman](mailman/README.md) + - [piwigo](piwigo/README.md) + - [dns-local](dns-local/README.md) + - [vector](vector/README.md) + - [dovecot](dovecot/README.md) + - [redis](redis/README.md) + - [loki](loki/README.md) + - [forgejo](forgejo/README.md) + - [nsd](nsd/README.md) + - [speedtest-rs](speedtest-rs/README.md) + - [nginx-reverse-proxy](nginx-reverse-proxy/README.md) + - [roundcube](roundcube/README.md) + - [vaultwarden](vaultwarden/README.md) + - [prometheus](prometheus/README.md) + - [mariadb](mariadb/README.md) + - [nsd-local](nsd-local/README.md) + - [nextcloud](nextcloud/README.md) + - [lemonldap](lemonldap/README.md) + - [openldap](openldap/README.md) + - [gitea](gitea/README.md) - Loki: - Provider: [loki](loki/README.md) - Supplier: [vector](vector/README.md) - MariaDB: - Provider: [mariadb](mariadb/README.md) - - Supplier: [mariadb-client](mariadb-client/README.md) + - Supplier: [piwigo](piwigo/README.md) - OAuth2: - Provider: [lemonldap](lemonldap/README.md) - - Supplier: [oauth2-client](oauth2-client/README.md) + - Suppliers: + - [odoo](odoo/README.md) + - [grafana](grafana/README.md) + - [mailman](mailman/README.md) + - [peertube](peertube/README.md) + - [piwigo](piwigo/README.md) + - [dovecot](dovecot/README.md) + - [forgejo](forgejo/README.md) + - [roundcube](roundcube/README.md) + - [nextcloud](nextcloud/README.md) + - [gitea](gitea/README.md) - Postgresql: - Provider: [postgresql](postgresql/README.md) - - Supplier: [postgresql-client](postgresql-client/README.md) + - Suppliers: + - [odoo](odoo/README.md) + - [grafana](grafana/README.md) + - [mailman](mailman/README.md) + - [peertube](peertube/README.md) + - [forgejo](forgejo/README.md) + - [roundcube](roundcube/README.md) + - [vaultwarden](vaultwarden/README.md) + - [nextcloud](nextcloud/README.md) + - [gitea](gitea/README.md) - Prometheus: - Provider: [prometheus](prometheus/README.md) - Supplier: [host-systemd-machined](host-systemd-machined/README.md) - Redis: - Provider: [redis](redis/README.md) - - Supplier: [redis-client](redis-client/README.md) + - Suppliers: + - [peertube](peertube/README.md) + - [piwigo](piwigo/README.md) + - [forgejo](forgejo/README.md) + - [roundcube](roundcube/README.md) + - [nextcloud](nextcloud/README.md) + - [gitea](gitea/README.md) - ReverseProxy: - Provider: [nginx-reverse-proxy](nginx-reverse-proxy/README.md) - - Supplier: [reverse-proxy-client](reverse-proxy-client/README.md) + - Suppliers: + - [odoo](odoo/README.md) + - [nginx-static](nginx-static/README.md) + - [grafana](grafana/README.md) + - [mailman](mailman/README.md) + - [peertube](peertube/README.md) + - [piwigo](piwigo/README.md) + - [dovecot](dovecot/README.md) + - [forgejo](forgejo/README.md) + - [reverse-proxy-client](reverse-proxy-client/README.md) + - [speedtest-rs](speedtest-rs/README.md) + - [roundcube](roundcube/README.md) + - [vaultwarden](vaultwarden/README.md) + - [nextcloud](nextcloud/README.md) + - [lemonldap](lemonldap/README.md) + - [gitea](gitea/README.md) - SMTP: - Provider: [postfix-relay](postfix-relay/README.md) - - Supplier: [relay-mail-client](relay-mail-client/README.md) + - Suppliers: + - [odoo](odoo/README.md) + - [grafana](grafana/README.md) + - [mailman](mailman/README.md) + - [peertube](peertube/README.md) + - [piwigo](piwigo/README.md) + - [dovecot](dovecot/README.md) + - [forgejo](forgejo/README.md) + - [vaultwarden](vaultwarden/README.md) + - [nextcloud](nextcloud/README.md) + - [lemonldap](lemonldap/README.md) + - [gitea](gitea/README.md) - Vector: - Provider: [vector](vector/README.md) - Supplier: [host-systemd-machined](host-systemd-machined/README.md) diff --git a/seed/apache/README.md b/seed/apache/README.md index 661853c5..66ab803d 100644 --- a/seed/apache/README.md +++ b/seed/apache/README.md @@ -3,13 +3,14 @@ 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/) @@ -33,5 +34,3 @@ Paramètrage avancé du serveur web Apache. ## Used by [nextcloud](../nextcloud/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/base-debian-bullseye/README.md b/seed/base-debian-bullseye/README.md index ec2829ee..b64d6fef 100644 --- a/seed/base-debian-bullseye/README.md +++ b/seed/base-debian-bullseye/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # base-debian-bullseye ## Synopsis -Base information of a Debian Bulleye server. -[Software's website.](https://www.debian.org/) +[Base information of a Debian Bulleye server.](https://www.debian.org/) ## Dependances @@ -27,5 +28,3 @@ Base information of a Debian Bulleye server. - [odoo](../odoo/README.md) - [mailman](../mailman/README.md) - [lemonldap](../lemonldap/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/base-debian/README.md b/seed/base-debian/README.md index 455c6d1e..91512b3d 100644 --- a/seed/base-debian/README.md +++ b/seed/base-debian/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # base-debian ## Synopsis -Base information of a Debian server. -[Software's website.](https://www.debian.org/) +[Base information of a Debian server.](https://www.debian.org/) ## Dependances @@ -24,5 +25,3 @@ Base information of a Debian server. ## Used by [base-debian-bullseye](../base-debian-bullseye/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/base-fedora-35/README.md b/seed/base-fedora-35/README.md index a8164be4..1e793b0f 100644 --- a/seed/base-fedora-35/README.md +++ b/seed/base-fedora-35/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # base-fedora-35 ## Synopsis -Base information of a Fedora 35. -[Software's website.](https://getfedora.org/) +[Base information of a Fedora 35.](https://getfedora.org/) ## Dependances @@ -25,5 +26,3 @@ Base information of a Fedora 35. ## Used by [postfix-relay](../postfix-relay/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/base-fedora-36/README.md b/seed/base-fedora-36/README.md index 03ef07a1..083a1635 100644 --- a/seed/base-fedora-36/README.md +++ b/seed/base-fedora-36/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # base-fedora-36 ## Synopsis -Base information of a Fedora 36. -[Software's website.](https://getfedora.org/) +[Base information of a Fedora 36.](https://getfedora.org/) ## Dependances @@ -32,5 +33,3 @@ Base information of a Fedora 36. - [vaultwarden](../vaultwarden/README.md) - [mariadb](../mariadb/README.md) - [nextcloud](../nextcloud/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/base-fedora-37/README.md b/seed/base-fedora-37/README.md index d8472268..8a5bb61d 100644 --- a/seed/base-fedora-37/README.md +++ b/seed/base-fedora-37/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # base-fedora-37 ## Synopsis -Base information of a Fedora 37. -[Software's website.](https://getfedora.org/) +[Base information of a Fedora 37.](https://getfedora.org/) ## Dependances @@ -30,5 +31,3 @@ Base information of a Fedora 37. - [nsd](../nsd/README.md) - [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) - [openldap](../openldap/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/base-fedora-38/README.md b/seed/base-fedora-38/README.md index 1e0f4356..1d808c92 100644 --- a/seed/base-fedora-38/README.md +++ b/seed/base-fedora-38/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # base-fedora-38 ## Synopsis -Base information of a Fedora 38. -[Software's website.](https://getfedora.org/) +[Base information of a Fedora 38.](https://getfedora.org/) ## Dependances @@ -31,5 +32,3 @@ Base information of a Fedora 38. - [loki](../loki/README.md) - [forgejo](../forgejo/README.md) - [prometheus](../prometheus/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/base-fedora/README.md b/seed/base-fedora/README.md index e532760d..a4960c40 100644 --- a/seed/base-fedora/README.md +++ b/seed/base-fedora/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # base-fedora ## Synopsis -Base information of a Fedora. -[Software's website.](https://getfedora.org/) +[Base information of a Fedora.](https://getfedora.org/) ## Dependances @@ -27,5 +28,3 @@ Base information of a Fedora. - [base-fedora-35](../base-fedora-35/README.md) - [base-fedora-38](../base-fedora-38/README.md) - [base-fedora-37](../base-fedora-37/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/base-machine/README.md b/seed/base-machine/README.md index 1852ce7e..9bf06972 100644 --- a/seed/base-machine/README.md +++ b/seed/base-machine/README.md @@ -3,6 +3,8 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # base-machine ## Synopsis @@ -28,5 +30,3 @@ Base information for a machine. ## Used by [systemd](../systemd/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/base/README.md b/seed/base/README.md index b8308440..e95b57d2 100644 --- a/seed/base/README.md +++ b/seed/base/README.md @@ -3,6 +3,8 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # base ## Synopsis @@ -13,5 +15,3 @@ Base of all application services. - [host-systemd-machined](../host-systemd-machined/README.md) - [base-machine](../base-machine/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/dns-external/README.md b/seed/dns-external/README.md index 56cb8084..257a7ad3 100644 --- a/seed/dns-external/README.md +++ b/seed/dns-external/README.md @@ -3,6 +3,8 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # dns-external ## Synopsis @@ -27,9 +29,3 @@ DNS client with resolution on all zones (especially outside). - [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-local/README.md b/seed/dns-local/README.md index 78203c7b..4cd0191d 100644 --- a/seed/dns-local/README.md +++ b/seed/dns-local/README.md @@ -3,6 +3,8 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # dns-local ## Synopsis @@ -12,9 +14,3 @@ DNS client with access to local zones. ## Used by [base-machine](../base-machine/README.md) - -## Provider - -[nsd-local](../nsd-local/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/dovecot/README.md b/seed/dovecot/README.md index ed2d5999..65892e28 100644 --- a/seed/dovecot/README.md +++ b/seed/dovecot/README.md @@ -3,13 +3,14 @@ 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 (Submission and IMAP).](https://www.dovecot.org/) ## Basic variables @@ -17,29 +18,22 @@ Postfix and Dovecot as mail servers (Submission and IMAP). #### 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 +Configure IMAP servers and submission to access email accounts and send emails. ##### 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` | +| 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.
**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.
**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.
**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 for expert @@ -61,13 +55,17 @@ This family is a leadership. ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **LDAP** -- **ReverseProxy** -- **LMTP** -- **OAuth2** +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) +- SMTP: [postfix-relay](../postfix-relay/README.md) +- LDAP: [openldap](../openldap/README.md) +- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) +- OAuth2: [lemonldap](../lemonldap/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -82,10 +80,9 @@ dovecot: zones_name: - ldap - localdns + - oauth2 - reverseproxy - smtp - - lmtp - - oauth2 values: general.mail.domain.mail_domains: - example.net @@ -114,8 +111,6 @@ dovecot: - [nginx-common](../nginx-common/README.md) - [reverse-proxy-client](../reverse-proxy-client/README.md) -## Supplier +## Useful for service -[imap-client](../imap-client/README.md) - -[All applications services for this dataset.](../README.md) +[roundcube](../roundcube/README.md) diff --git a/seed/forgejo/README.md b/seed/forgejo/README.md index 1454e67d..c8bdcc0e 100644 --- a/seed/forgejo/README.md +++ b/seed/forgejo/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # forgejo ## Synopsis -Forgejo, a community managed lightweight code hosting solution. -[Software's website.](https://forgejo.org/) +[Forgejo, a community managed lightweight code hosting solution.](https://forgejo.org/) ## Basic variables @@ -89,13 +90,18 @@ This family is a leadership. ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **ReverseProxy** -- **Postgresql** -- **Redis** -- **OAuth2** +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) +- SMTP: [postfix-relay](../postfix-relay/README.md) +- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) +- Postgresql: [postgresql](../postgresql/README.md) +- OAuth2: [lemonldap](../lemonldap/README.md) +- Redis: [redis](../redis/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -108,11 +114,11 @@ forgejo: applicationservice: forgejo zones_name: - localdns - - reverseproxy - - smtp - - redis - oauth2 - postgresql + - redis + - reverseproxy + - smtp values: general.revprox.revprox_client.revprox_client_external_domainnames: - service.example.net @@ -140,5 +146,3 @@ forgejo: ## Used by [gitea](../gitea/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/gitea/README.md b/seed/gitea/README.md index a6e085ae..9c1ee141 100644 --- a/seed/gitea/README.md +++ b/seed/gitea/README.md @@ -3,6 +3,8 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # gitea ## Synopsis @@ -105,13 +107,18 @@ This family is a leadership. ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **ReverseProxy** -- **Postgresql** -- **Redis** -- **OAuth2** +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) +- SMTP: [postfix-relay](../postfix-relay/README.md) +- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) +- Postgresql: [postgresql](../postgresql/README.md) +- OAuth2: [lemonldap](../lemonldap/README.md) +- Redis: [redis](../redis/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -124,11 +131,11 @@ gitea: applicationservice: gitea zones_name: - localdns - - reverseproxy - - smtp - - redis - oauth2 - postgresql + - redis + - reverseproxy + - smtp values: general.revprox.revprox_client.revprox_client_external_domainnames: - service.example.net @@ -152,5 +159,3 @@ gitea: - [redis-client](../redis-client/README.md) - [redis-common](../redis-common/README.md) - [oauth2-client](../oauth2-client/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/grafana/README.md b/seed/grafana/README.md index 46cbcb0a..afd74168 100644 --- a/seed/grafana/README.md +++ b/seed/grafana/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # grafana ## Synopsis -Grafana is an analytics and interactive visualization web application. -[Software's website.](https://grafana.com/) +[Grafana is an analytics and interactive visualization web application.](https://grafana.com/) ## Basic variables @@ -79,12 +80,17 @@ This family is a leadership. ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **ReverseProxy** -- **Postgresql** -- **OAuth2** +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) +- SMTP: [postfix-relay](../postfix-relay/README.md) +- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) +- Postgresql: [postgresql](../postgresql/README.md) +- OAuth2: [lemonldap](../lemonldap/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -97,10 +103,10 @@ grafana: applicationservice: grafana zones_name: - localdns - - reverseproxy - - smtp - oauth2 - postgresql + - reverseproxy + - smtp values: general.revprox.revprox_client.revprox_client_external_domainnames: - service.example.net @@ -122,5 +128,3 @@ grafana: - [oauth2-client](../oauth2-client/README.md) - [reverse-proxy-client](../reverse-proxy-client/README.md) - [relay-mail-client](../relay-mail-client/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/host-systemd-machined/README.md b/seed/host-systemd-machined/README.md index 8799fc55..a07123ab 100644 --- a/seed/host-systemd-machined/README.md +++ b/seed/host-systemd-machined/README.md @@ -3,13 +3,14 @@ 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 @@ -54,14 +55,3 @@ This family is a leadership. ## Dependances - [base](../base/README.md) - -## Supplier - -[provider-systemd-machined](../provider-systemd-machined/README.md) - -## Providers - -- [prometheus](../prometheus/README.md) -- [vector](../vector/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/imap-client/README.md b/seed/imap-client/README.md index 469d5cbc..2039558f 100644 --- a/seed/imap-client/README.md +++ b/seed/imap-client/README.md @@ -3,6 +3,8 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # imap-client ## Synopsis @@ -12,9 +14,3 @@ Application service needs interact with an IMAP server. ## Used by [roundcube](../roundcube/README.md) - -## Provider - -[dovecot](../dovecot/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/journald/README.md b/seed/journald/README.md index 00a1d5e1..3d5e8627 100644 --- a/seed/journald/README.md +++ b/seed/journald/README.md @@ -3,20 +3,15 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # journald ## Synopsis -Journald. -[Software's website.](https://systemd.io/) +[Journald.](https://systemd.io/) ## Used by [systemd](../systemd/README.md) - -## Provider - -[journald_remote](../journald_remote/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/journald_remote/README.md b/seed/journald_remote/README.md index b9bab683..d68657e0 100644 --- a/seed/journald_remote/README.md +++ b/seed/journald_remote/README.md @@ -3,20 +3,15 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # journald_remote ## Synopsis -Journald remote. -[Software's website.](https://systemd.io/) +[Journald remote.](https://systemd.io/) ## Used by [vector](../vector/README.md) - -## Supplier - -[journald](../journald/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/ldap-client/README.md b/seed/ldap-client/README.md index 23a8a20a..0c609bd7 100644 --- a/seed/ldap-client/README.md +++ b/seed/ldap-client/README.md @@ -3,6 +3,8 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # ldap-client ## Synopsis @@ -35,9 +37,3 @@ Application service needs interact with a LDAP server. - [roundcube](../roundcube/README.md) - [nextcloud](../nextcloud/README.md) - [lemonldap](../lemonldap/README.md) - -## Provider - -[openldap](../openldap/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/lemonldap/README.md b/seed/lemonldap/README.md index 343873ee..f79f00f1 100644 --- a/seed/lemonldap/README.md +++ b/seed/lemonldap/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # lemonldap ## Synopsis -LemonLDAP, a Web Single Sign On and Access Management. -[Software's website.](https://lemonldap-ng.org/) +[LemonLDAP, a Web Single Sign On and Access Management.](https://lemonldap-ng.org/) ## Basic variables @@ -80,11 +81,16 @@ Configuration de la solution d'authentification unique LemonLDAP::NG. ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **LDAP** -- **ReverseProxy** +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) +- SMTP: [postfix-relay](../postfix-relay/README.md) +- LDAP: [openldap](../openldap/README.md) +- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -124,8 +130,15 @@ lemonldap: - [journald](../journald/README.md) - [resolved](../resolved/README.md) -## Supplier +## Useful for services -[oauth2-client](../oauth2-client/README.md) - -[All applications services for this dataset.](../README.md) +- [dovecot](../dovecot/README.md) +- [forgejo](../forgejo/README.md) +- [gitea](../gitea/README.md) +- [grafana](../grafana/README.md) +- [mailman](../mailman/README.md) +- [nextcloud](../nextcloud/README.md) +- [odoo](../odoo/README.md) +- [peertube](../peertube/README.md) +- [piwigo](../piwigo/README.md) +- [roundcube](../roundcube/README.md) diff --git a/seed/loki/README.md b/seed/loki/README.md index 41689faf..24362021 100644 --- a/seed/loki/README.md +++ b/seed/loki/README.md @@ -3,18 +3,24 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # loki ## Synopsis -Loki, a log aggregation platform. -[Software's website.](https://grafana.com/) +[Loki, a log aggregation platform.](https://grafana.com/) ## Requirements services -- **LocalDNS** -- Journald +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -42,8 +48,6 @@ loki: - [journald](../journald/README.md) - [resolved](../resolved/README.md) -## Supplier +## Useful for service [vector](../vector/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/mailman/README.md b/seed/mailman/README.md index beb4b9f6..7603fe4c 100644 --- a/seed/mailman/README.md +++ b/seed/mailman/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # mailman ## Synopsis -GNU Mailman, managing electronic mail discussion and e-newsletter lists. -[Software's website.](https://www.list.org) +[GNU Mailman, managing electronic mail discussion and e-newsletter lists.](https://www.list.org) ## Basic variables @@ -99,13 +100,17 @@ This family is a leadership. ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **ReverseProxy** -- **Postgresql** -- **LMTP** -- **OAuth2** +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) +- SMTP: [postfix-relay](../postfix-relay/README.md) +- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) +- Postgresql: [postgresql](../postgresql/README.md) +- OAuth2: [lemonldap](../lemonldap/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -118,11 +123,10 @@ mailman: applicationservice: mailman zones_name: - localdns - - reverseproxy - - smtp - - lmtp - oauth2 - postgresql + - reverseproxy + - smtp values: general.revprox.revprox_client.revprox_client_external_domainnames: - service.example.net @@ -150,5 +154,3 @@ mailman: - [nginx-common](../nginx-common/README.md) - [reverse-proxy-client](../reverse-proxy-client/README.md) - [oauth2-client](../oauth2-client/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/mariadb-client/README.md b/seed/mariadb-client/README.md index dca610f0..0eb02b26 100644 --- a/seed/mariadb-client/README.md +++ b/seed/mariadb-client/README.md @@ -3,20 +3,15 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # mariadb-client ## Synopsis -Application service needs interact with a MariaDB server. -[Software's website.](https://mariadb.org/) +[Application service needs interact with a MariaDB server.](https://mariadb.org/) ## Used by [piwigo](../piwigo/README.md) - -## Provider - -[mariadb](../mariadb/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/mariadb/README.md b/seed/mariadb/README.md index dbf9232a..18deff78 100644 --- a/seed/mariadb/README.md +++ b/seed/mariadb/README.md @@ -3,18 +3,24 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # mariadb ## Synopsis -MariaDB, a relational database. -[Software's website.](https://mariadb.org/) +[MariaDB, a relational database.](https://mariadb.org/) ## Requirements services -- **LocalDNS** -- Journald +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -42,8 +48,6 @@ mariadb: - [journald](../journald/README.md) - [resolved](../resolved/README.md) -## Supplier +## Useful for service -[mariadb-client](../mariadb-client/README.md) - -[All applications services for this dataset.](../README.md) +[piwigo](../piwigo/README.md) diff --git a/seed/nextcloud/README.md b/seed/nextcloud/README.md index d72cd4e6..b1f25519 100644 --- a/seed/nextcloud/README.md +++ b/seed/nextcloud/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # nextcloud ## Synopsis -Nextcloud, Online collaboration platform. -[Software's website.](https://nextcloud.com/) +[Nextcloud, Online collaboration platform.](https://nextcloud.com/) ## Basic variables @@ -125,14 +126,19 @@ This family is a leadership. ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **LDAP** -- **ReverseProxy** -- **Postgresql** -- **Redis** -- **OAuth2** +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) +- SMTP: [postfix-relay](../postfix-relay/README.md) +- LDAP: [openldap](../openldap/README.md) +- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) +- Postgresql: [postgresql](../postgresql/README.md) +- OAuth2: [lemonldap](../lemonldap/README.md) +- Redis: [redis](../redis/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -146,11 +152,11 @@ nextcloud: zones_name: - ldap - localdns - - reverseproxy - - smtp - - redis - oauth2 - postgresql + - redis + - reverseproxy + - smtp values: general.revprox.revprox_client.revprox_client_external_domainnames: - service.example.net @@ -178,5 +184,3 @@ nextcloud: - [reverse-proxy-client](../reverse-proxy-client/README.md) - [php-fpm](../php-fpm/README.md) - [php](../php/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/nginx-common/README.md b/seed/nginx-common/README.md index 15c4ba28..84278994 100644 --- a/seed/nginx-common/README.md +++ b/seed/nginx-common/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # nginx-common ## Synopsis -Nginx common configuration. -[Software's website.](https://nginx.org/) +[Nginx common configuration.](https://nginx.org/) @@ -30,5 +31,3 @@ Paramétrage global de NGINX. - [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) - [nginx-https](../nginx-https/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/nginx-https/README.md b/seed/nginx-https/README.md index 996375c5..0ded496d 100644 --- a/seed/nginx-https/README.md +++ b/seed/nginx-https/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # nginx-https ## Synopsis -Nginx as HTTPS web site. -[Software's website.](https://nginx.org/) +[Nginx as HTTPS web site.](https://nginx.org/) ## Dependances @@ -26,5 +27,3 @@ Nginx as HTTPS web site. - [dovecot](../dovecot/README.md) - [roundcube](../roundcube/README.md) - [lemonldap](../lemonldap/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/nginx-reverse-proxy/README.md b/seed/nginx-reverse-proxy/README.md index a220c079..d5e21e8f 100644 --- a/seed/nginx-reverse-proxy/README.md +++ b/seed/nginx-reverse-proxy/README.md @@ -3,14 +3,26 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # nginx-reverse-proxy ## Synopsis -Nginx as reverse proxy. -[Software's website.](https://nginx.org/) +[Nginx as reverse proxy.](https://nginx.org/) +## Basic variables + +### Général + +#### NGINX + +Paramétrage global de NGINX. + +| Parameter | Comments | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **[general.nginx.nginx_certificates_provider](dictionaries/25_nginx.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 le certificat des domaines extérieurs.
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 @@ -20,10 +32,9 @@ Nginx as reverse proxy. Paramétrage global de NGINX. -| Parameter | Comments | -|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **[general.nginx.nginx_default](dictionaries/25_nginx.xml)**
mandatory
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de domaine du serveur mandataire inverse par défaut.
Si un client accède au serveur avec un nom de domaine non déclaré, le flux est redirigé vers ce domaine.
**Default:** *calculated* | -| **[general.nginx.nginx_certificates_provider](dictionaries/25_nginx.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 le certificat des domaines extérieurs.
**Choices:**
- `self-signed` ← default
- `letsencrypt` | +| Parameter | Comments | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **[general.nginx.nginx_default](dictionaries/25_nginx.xml)**
mandatory
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de domaine du serveur mandataire inverse par défaut.
Si un client accède au serveur avec un nom de domaine non déclaré, le flux est redirigé vers ce domaine.
**Default:** *calculated* | ## Variables for expert @@ -40,8 +51,13 @@ Paramétrage global de NGINX. ## Requirements services -- **LocalDNS** -- Journald +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -70,8 +86,20 @@ nginx-reverse-proxy: - [journald](../journald/README.md) - [resolved](../resolved/README.md) -## Supplier +## Useful for services -[reverse-proxy-client](../reverse-proxy-client/README.md) - -[All applications services for this dataset.](../README.md) +- [dovecot](../dovecot/README.md) +- [forgejo](../forgejo/README.md) +- [gitea](../gitea/README.md) +- [grafana](../grafana/README.md) +- [lemonldap](../lemonldap/README.md) +- [mailman](../mailman/README.md) +- [nextcloud](../nextcloud/README.md) +- [nginx-static](../nginx-static/README.md) +- [odoo](../odoo/README.md) +- [peertube](../peertube/README.md) +- [piwigo](../piwigo/README.md) +- [reverse-proxy-client](../reverse-proxy-client/README.md) +- [roundcube](../roundcube/README.md) +- [speedtest-rs](../speedtest-rs/README.md) +- [vaultwarden](../vaultwarden/README.md) diff --git a/seed/nginx-static/README.md b/seed/nginx-static/README.md index 878c578c..f54cdec4 100644 --- a/seed/nginx-static/README.md +++ b/seed/nginx-static/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # nginx-static ## Synopsis -Nginx as static web site. -[Software's website.](https://nginx.org/) +[Nginx as static web site.](https://nginx.org/) ## Basic variables @@ -65,9 +66,14 @@ This family is a leadership. ## Requirements services -- **LocalDNS** -- Journald -- **ReverseProxy** +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) +- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -100,5 +106,3 @@ nginx-static: - [pki-tls](../pki-tls/README.md) - [journald](../journald/README.md) - [resolved](../resolved/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/nsd-local/README.md b/seed/nsd-local/README.md index 54ea59cb..ae1c9955 100644 --- a/seed/nsd-local/README.md +++ b/seed/nsd-local/README.md @@ -3,19 +3,25 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # nsd-local ## Synopsis -NSD, an authoritative DNS name server for local resolution. -[Software's website.](https://www.nlnetlabs.nl/projects/nsd/about/) +[NSD, an authoritative DNS name server for local resolution.](https://www.nlnetlabs.nl/projects/nsd/about/) ## Requirements services -- **LocalDNS** -- Journald -- ExternalDNS +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) +- ExternalDNS: [unbound](../unbound/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -28,6 +34,7 @@ nsd-local: applicationservice: nsd-local provider_zone: localdns zones_name: + - externaldns - localdns ``` @@ -44,12 +51,29 @@ nsd-local: - [journald](../journald/README.md) - [resolved](../resolved/README.md) -## Supplier +## Useful for services -[dns-local](../dns-local/README.md) - -## Provider - -[unbound](../unbound/README.md) - -[All applications services for this dataset.](../README.md) +- [dns-local](../dns-local/README.md) +- [dovecot](../dovecot/README.md) +- [forgejo](../forgejo/README.md) +- [gitea](../gitea/README.md) +- [grafana](../grafana/README.md) +- [lemonldap](../lemonldap/README.md) +- [loki](../loki/README.md) +- [mailman](../mailman/README.md) +- [mariadb](../mariadb/README.md) +- [nextcloud](../nextcloud/README.md) +- [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) +- [nginx-static](../nginx-static/README.md) +- [nsd](../nsd/README.md) +- [nsd-local](../nsd-local/README.md) +- [odoo](../odoo/README.md) +- [openldap](../openldap/README.md) +- [piwigo](../piwigo/README.md) +- [postgresql](../postgresql/README.md) +- [prometheus](../prometheus/README.md) +- [redis](../redis/README.md) +- [roundcube](../roundcube/README.md) +- [speedtest-rs](../speedtest-rs/README.md) +- [vaultwarden](../vaultwarden/README.md) +- [vector](../vector/README.md) diff --git a/seed/nsd/README.md b/seed/nsd/README.md index 526650aa..94d89a51 100644 --- a/seed/nsd/README.md +++ b/seed/nsd/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # nsd ## Synopsis -NSD, an authoritative DNS name server. -[Software's website.](https://www.nlnetlabs.nl/projects/nsd/about/) +[NSD, an authoritative DNS name server.](https://www.nlnetlabs.nl/projects/nsd/about/) ## Basic variables @@ -61,8 +62,13 @@ This family is a leadership. ## Requirements services -- **LocalDNS** -- Journald +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -95,5 +101,3 @@ nsd: ## Used by [nsd-local](../nsd-local/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/oauth2-client/README.md b/seed/oauth2-client/README.md index 22d8fa00..4f47a8ba 100644 --- a/seed/oauth2-client/README.md +++ b/seed/oauth2-client/README.md @@ -3,6 +3,8 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # oauth2-client ## Synopsis @@ -46,9 +48,3 @@ Application service needs interact with a Oauth2 server. - [forgejo](../forgejo/README.md) - [roundcube](../roundcube/README.md) - [nextcloud](../nextcloud/README.md) - -## Provider - -[lemonldap](../lemonldap/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/odoo/README.md b/seed/odoo/README.md index 4b52c6e4..a3bf897f 100644 --- a/seed/odoo/README.md +++ b/seed/odoo/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # odoo ## Synopsis -Odoo, an ERP and CRM. -[Software's website.](https://www.odoo.com/fr) +[Odoo, an ERP and CRM.](https://www.odoo.com/fr) ## Basic variables @@ -117,13 +118,18 @@ This family is a leadership. ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **LDAP** -- **ReverseProxy** -- **Postgresql** -- **OAuth2** +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) +- SMTP: [postfix-relay](../postfix-relay/README.md) +- LDAP: [openldap](../openldap/README.md) +- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) +- Postgresql: [postgresql](../postgresql/README.md) +- OAuth2: [lemonldap](../lemonldap/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -137,10 +143,10 @@ odoo: zones_name: - ldap - localdns - - reverseproxy - - smtp - oauth2 - postgresql + - reverseproxy + - smtp values: general.revprox.revprox_client.revprox_client_external_domainnames: - service.example.net @@ -176,5 +182,3 @@ odoo: - [nginx-https](../nginx-https/README.md) - [nginx-common](../nginx-common/README.md) - [reverse-proxy-client](../reverse-proxy-client/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/openldap/README.md b/seed/openldap/README.md index f190b051..c0a96429 100644 --- a/seed/openldap/README.md +++ b/seed/openldap/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # openldap ## Synopsis -OpenLDAP, the LDAP server. -[Software's website.](https://www.openldap.org/) +[OpenLDAP, the LDAP server.](https://www.openldap.org/) This service provides a LDAP server. @@ -96,8 +97,13 @@ Management of manually created users. Those users are classified in a family. Th ## Requirements services -- **LocalDNS** -- Journald +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -125,8 +131,11 @@ openldap: - [journald](../journald/README.md) - [resolved](../resolved/README.md) -## Supplier +## Useful for services -[ldap-client](../ldap-client/README.md) - -[All applications services for this dataset.](../README.md) +- [dovecot](../dovecot/README.md) +- [lemonldap](../lemonldap/README.md) +- [nextcloud](../nextcloud/README.md) +- [odoo](../odoo/README.md) +- [piwigo](../piwigo/README.md) +- [roundcube](../roundcube/README.md) diff --git a/seed/peertube/README.md b/seed/peertube/README.md index b1605d4d..99f1d4a5 100644 --- a/seed/peertube/README.md +++ b/seed/peertube/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # peertube ## Synopsis -Peertube, a federated (ActivityPub) video streaming platform. -[Software's website.](https://www.openldap.org/) +[Peertube, a federated (ActivityPub) video streaming platform.](https://www.openldap.org/) ## Basic variables @@ -105,13 +106,18 @@ This family is a leadership. ## Requirements services -- **ExternalDNS** -- Journald -- **SMTP** -- **ReverseProxy** -- **Postgresql** -- **Redis** -- **OAuth2** +### Mandatories + +- SMTP: [postfix-relay](../postfix-relay/README.md) +- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) +- Postgresql: [postgresql](../postgresql/README.md) +- OAuth2: [lemonldap](../lemonldap/README.md) +- ExternalDNS: [unbound](../unbound/README.md) +- Redis: [redis](../redis/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -123,12 +129,12 @@ Zone names are provided as examples. Think about adapting with the value of prov peertube: applicationservice: peertube zones_name: - - localdns - - reverseproxy - - smtp - - redis + - externaldns - oauth2 - postgresql + - redis + - reverseproxy + - smtp values: general.revprox.revprox_client.revprox_client_external_domainnames: - service.example.net @@ -156,5 +162,3 @@ peertube: - [nginx-common](../nginx-common/README.md) - [reverse-proxy-client](../reverse-proxy-client/README.md) - [oauth2-client](../oauth2-client/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/php-fpm/README.md b/seed/php-fpm/README.md index 1670268f..3318a36d 100644 --- a/seed/php-fpm/README.md +++ b/seed/php-fpm/README.md @@ -3,6 +3,8 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # php-fpm ## Synopsis @@ -18,5 +20,3 @@ PHP FPM. - [piwigo](../piwigo/README.md) - [roundcube](../roundcube/README.md) - [nextcloud](../nextcloud/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/php/README.md b/seed/php/README.md index 99e6d89b..13bd2a8f 100644 --- a/seed/php/README.md +++ b/seed/php/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # php ## Synopsis -PHP, a popular general-purpose scripting language. -[Software's website.](https://secure.php.net/) +[PHP, a popular general-purpose scripting language.](https://secure.php.net/) @@ -38,5 +39,3 @@ Paramètrage avancé de PHP. ## Used by [php-fpm](../php-fpm/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/piwigo/README.md b/seed/piwigo/README.md index 5bce79dc..68bdeb3a 100644 --- a/seed/piwigo/README.md +++ b/seed/piwigo/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # piwigo ## Synopsis -Piwigo, a photo management software. -[Software's website.](http://piwigo.org/) +[Piwigo, a photo management software.](http://piwigo.org/) ## Basic variables @@ -137,14 +138,19 @@ This family is a leadership. ## Requirements services -- **LocalDNS** -- Journald -- **MariaDB** -- **SMTP** -- **LDAP** -- **ReverseProxy** -- **Redis** -- **OAuth2** +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) +- SMTP: [postfix-relay](../postfix-relay/README.md) +- LDAP: [openldap](../openldap/README.md) +- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) +- OAuth2: [lemonldap](../lemonldap/README.md) +- Redis: [redis](../redis/README.md) +- MariaDB: [mariadb](../mariadb/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -159,10 +165,10 @@ piwigo: - ldap - localdns - mariadb + - oauth2 + - redis - reverseproxy - smtp - - redis - - oauth2 values: general.revprox.revprox_client.revprox_client_external_domainnames: - service.example.net @@ -195,5 +201,3 @@ piwigo: - [reverse-proxy-client](../reverse-proxy-client/README.md) - [php-fpm](../php-fpm/README.md) - [php](../php/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/pki-tls/README.md b/seed/pki-tls/README.md index 291e3777..52bef95c 100644 --- a/seed/pki-tls/README.md +++ b/seed/pki-tls/README.md @@ -3,6 +3,8 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # pki-tls ## Synopsis @@ -12,5 +14,3 @@ Autosign PKI or Let's encrypt support for TLS certificates. ## Used by [base-machine](../base-machine/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/postfix-lmtp-relay/README.md b/seed/postfix-lmtp-relay/README.md index 16864935..660897d6 100644 --- a/seed/postfix-lmtp-relay/README.md +++ b/seed/postfix-lmtp-relay/README.md @@ -3,20 +3,15 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # postfix-lmtp-relay ## Synopsis -Postfix, the mail server, as LMTP relay. -[Software's website.](http://www.postfix.org/) +[Postfix, the mail server, as LMTP relay.](http://www.postfix.org/) ## Used by [postfix-relay](../postfix-relay/README.md) - -## Supplier - -[relay-lmtp-client](../relay-lmtp-client/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/postfix-relay/README.md b/seed/postfix-relay/README.md index ebd48a41..2c2b10be 100644 --- a/seed/postfix-relay/README.md +++ b/seed/postfix-relay/README.md @@ -3,14 +3,24 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # postfix-relay ## Synopsis -Postfix, the mail server, as relay. -[Software's website.](http://www.postfix.org/) +[Postfix, the mail server, as relay.](http://www.postfix.org/) +## Basic variables + +### Général + +#### Postfix mail server + +| Parameter | Comments | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **[general.postfix.postfix_crt_provider](dictionaries/30_postfix.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 le certificat du domaine extérieur.
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 @@ -18,16 +28,20 @@ Postfix, the mail server, as relay. #### Postfix mail server -| Parameter | Comments | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| -| **[general.postfix.postfix_mail_hostname](dictionaries/30_postfix.xml)**
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de domaine extérieur du serveur de courriel.
Cette variable est obligatoire pour recevoir des courriels depuis l'extérieur. | -| **[general.postfix.postfix_crt_provider](dictionaries/30_postfix.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 le certificat du domaine extérieur.
**Choices:**
- `self-signed` ← default
- `letsencrypt` | +| Parameter | Comments | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| **[general.postfix.postfix_mail_hostname](dictionaries/30_postfix.xml)**
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de domaine extérieur du serveur de courriel.
Cette variable est obligatoire pour recevoir des courriels depuis l'extérieur. | ## Requirements services -- **ExternalDNS** -- Journald +### Mandatories + +- ExternalDNS: [unbound](../unbound/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -40,7 +54,7 @@ postfix-relay: applicationservice: postfix-relay provider_zone: smtp zones_name: - - localdns + - externaldns ``` ## Dependances @@ -57,8 +71,16 @@ postfix-relay: - [dns-external](../dns-external/README.md) - [postfix-lmtp-relay](../postfix-lmtp-relay/README.md) -## Supplier +## Useful for services -[relay-mail-client](../relay-mail-client/README.md) - -[All applications services for this dataset.](../README.md) +- [dovecot](../dovecot/README.md) +- [forgejo](../forgejo/README.md) +- [gitea](../gitea/README.md) +- [grafana](../grafana/README.md) +- [lemonldap](../lemonldap/README.md) +- [mailman](../mailman/README.md) +- [nextcloud](../nextcloud/README.md) +- [odoo](../odoo/README.md) +- [peertube](../peertube/README.md) +- [piwigo](../piwigo/README.md) +- [vaultwarden](../vaultwarden/README.md) diff --git a/seed/postgresql-client/README.md b/seed/postgresql-client/README.md index cdb79b1f..699156f1 100644 --- a/seed/postgresql-client/README.md +++ b/seed/postgresql-client/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # postgresql-client ## Synopsis -Application service needs interact with a Postgresql server. -[Software's website.](https://www.postgresql.org) +[Application service needs interact with a Postgresql server.](https://www.postgresql.org) @@ -35,9 +36,3 @@ Application service needs interact with a Postgresql server. - [roundcube](../roundcube/README.md) - [vaultwarden](../vaultwarden/README.md) - [nextcloud](../nextcloud/README.md) - -## Provider - -[postgresql](../postgresql/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/postgresql/README.md b/seed/postgresql/README.md index c1a841e1..d07e0307 100644 --- a/seed/postgresql/README.md +++ b/seed/postgresql/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # postgresql ## Synopsis -Postgresql, a database. -[Software's website.](https://www.postgresql.org) +[Postgresql, a database.](https://www.postgresql.org) ## Variables @@ -52,8 +53,13 @@ This a dynamic family generated from the variable "accounts.remotes". ## Requirements services -- **LocalDNS** -- Journald +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -81,8 +87,14 @@ postgresql: - [journald](../journald/README.md) - [resolved](../resolved/README.md) -## Supplier +## Useful for services -[postgresql-client](../postgresql-client/README.md) - -[All applications services for this dataset.](../README.md) +- [forgejo](../forgejo/README.md) +- [gitea](../gitea/README.md) +- [grafana](../grafana/README.md) +- [mailman](../mailman/README.md) +- [nextcloud](../nextcloud/README.md) +- [odoo](../odoo/README.md) +- [peertube](../peertube/README.md) +- [roundcube](../roundcube/README.md) +- [vaultwarden](../vaultwarden/README.md) diff --git a/seed/prometheus/README.md b/seed/prometheus/README.md index 6c83bb70..9db3d42b 100644 --- a/seed/prometheus/README.md +++ b/seed/prometheus/README.md @@ -3,18 +3,24 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # prometheus ## Synopsis -Prometheus, an event monitoring. -[Software's website.](https://prometheus.io/) +[Prometheus, an event monitoring.](https://prometheus.io/) ## Requirements services -- **LocalDNS** -- Journald +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -42,8 +48,6 @@ prometheus: - [journald](../journald/README.md) - [resolved](../resolved/README.md) -## Supplier +## Useful for service [host-systemd-machined](../host-systemd-machined/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/provider-systemd-machined/README.md b/seed/provider-systemd-machined/README.md index 4be5dc95..3c030377 100644 --- a/seed/provider-systemd-machined/README.md +++ b/seed/provider-systemd-machined/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # provider-systemd-machined ## Synopsis -Machine started in Systemd Machined environment. -[Software's website.](https://www.freedesktop.org/wiki/Software/systemd/machined/) +[Machine started in Systemd Machined environment.](https://www.freedesktop.org/wiki/Software/systemd/machined/) ## Variables @@ -45,9 +46,3 @@ Machine started in Systemd Machined environment. - [pki-tls](../pki-tls/README.md) - [journald](../journald/README.md) - [resolved](../resolved/README.md) - -## Provider - -[host-systemd-machined](../host-systemd-machined/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/redis-client/README.md b/seed/redis-client/README.md index b0275c8c..a4809976 100644 --- a/seed/redis-client/README.md +++ b/seed/redis-client/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # redis-client ## Synopsis -Application service needs interact with a Redis server. -[Software's website.](https://redis.io/) +[Application service needs interact with a Redis server.](https://redis.io/) @@ -35,9 +36,3 @@ Application service needs interact with a Redis server. - [forgejo](../forgejo/README.md) - [roundcube](../roundcube/README.md) - [nextcloud](../nextcloud/README.md) - -## Provider - -[redis](../redis/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/redis-common/README.md b/seed/redis-common/README.md index eccb4583..225399c8 100644 --- a/seed/redis-common/README.md +++ b/seed/redis-common/README.md @@ -3,17 +3,16 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # redis-common ## Synopsis -Redis, an in-memory data structure store. -[Software's website.](https://redis.io/) +[Redis, an in-memory data structure store.](https://redis.io/) ## Used by - [redis](../redis/README.md) - [redis-client](../redis-client/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/redis/README.md b/seed/redis/README.md index 8832d3e0..a3e717cd 100644 --- a/seed/redis/README.md +++ b/seed/redis/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # redis ## Synopsis -Redis, an in-memory data structure store. -[Software's website.](https://redis.io/) +[Redis, an in-memory data structure store.](https://redis.io/) ## Variables @@ -42,8 +43,13 @@ This a dynamic family generated from the variable "accounts.remotes". ## Requirements services -- **LocalDNS** -- Journald +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -72,8 +78,11 @@ redis: - [resolved](../resolved/README.md) - [redis-common](../redis-common/README.md) -## Supplier +## Useful for services -[redis-client](../redis-client/README.md) - -[All applications services for this dataset.](../README.md) +- [forgejo](../forgejo/README.md) +- [gitea](../gitea/README.md) +- [nextcloud](../nextcloud/README.md) +- [peertube](../peertube/README.md) +- [piwigo](../piwigo/README.md) +- [roundcube](../roundcube/README.md) diff --git a/seed/relay-lmtp-client/README.md b/seed/relay-lmtp-client/README.md index 2cf2eca0..48dbda8c 100644 --- a/seed/relay-lmtp-client/README.md +++ b/seed/relay-lmtp-client/README.md @@ -3,6 +3,8 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # relay-lmtp-client ## Synopsis @@ -17,9 +19,3 @@ Application service needs interact with a Postfix server with LMTP protocol. - [mailman](../mailman/README.md) - [dovecot](../dovecot/README.md) - -## Provider - -[postfix-lmtp-relay](../postfix-lmtp-relay/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/relay-mail-client/README.md b/seed/relay-mail-client/README.md index eca8416a..e0f2c4f4 100644 --- a/seed/relay-mail-client/README.md +++ b/seed/relay-mail-client/README.md @@ -3,6 +3,8 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # relay-mail-client ## Synopsis @@ -20,9 +22,3 @@ Client SMTP. - [relay-lmtp-client](../relay-lmtp-client/README.md) - [nextcloud](../nextcloud/README.md) - [lemonldap](../lemonldap/README.md) - -## Provider - -[postfix-relay](../postfix-relay/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/resolved/README.md b/seed/resolved/README.md index eec0fc5c..6a0c3cd0 100644 --- a/seed/resolved/README.md +++ b/seed/resolved/README.md @@ -3,16 +3,15 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # resolved ## Synopsis -Resolved. -[Software's website.](https://systemd.io/) +[Resolved.](https://systemd.io/) ## Used by [systemd](../systemd/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/reverse-proxy-client/README.md b/seed/reverse-proxy-client/README.md index c77c9588..ba5cb6a2 100644 --- a/seed/reverse-proxy-client/README.md +++ b/seed/reverse-proxy-client/README.md @@ -3,6 +3,8 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # reverse-proxy-client ## Synopsis @@ -50,9 +52,3 @@ This family is a leadership. - [nginx-https](../nginx-https/README.md) - [vaultwarden](../vaultwarden/README.md) - [apache](../apache/README.md) - -## Provider - -[nginx-reverse-proxy](../nginx-reverse-proxy/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/roundcube/README.md b/seed/roundcube/README.md index 78d3d2c1..85639d3b 100644 --- a/seed/roundcube/README.md +++ b/seed/roundcube/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # roundcube ## Synopsis -Roundcube, a webmail. -[Software's website.](https://roundcube.net/) +[Roundcube, a webmail.](https://roundcube.net/) ## Basic variables @@ -121,14 +122,19 @@ Paramétrage global de NGINX. ## Requirements services -- **LocalDNS** -- Journald -- **IMAP** -- **LDAP** -- **ReverseProxy** -- **Postgresql** -- **Redis** -- **OAuth2** +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) +- LDAP: [openldap](../openldap/README.md) +- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) +- Postgresql: [postgresql](../postgresql/README.md) +- OAuth2: [lemonldap](../lemonldap/README.md) +- Redis: [redis](../redis/README.md) +- IMAP: [dovecot](../dovecot/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -140,13 +146,13 @@ Zone names are provided as examples. Think about adapting with the value of prov roundcube: applicationservice: roundcube zones_name: + - imap - ldap - localdns - - reverseproxy - - imap - - redis - oauth2 - postgresql + - redis + - reverseproxy values: general.roundcube.roundcube_domain.roundcube_domains: - webmail.example.net @@ -176,5 +182,3 @@ roundcube: - [php-fpm](../php-fpm/README.md) - [php](../php/README.md) - [ldap-client](../ldap-client/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/speedtest-rs/README.md b/seed/speedtest-rs/README.md index a04828fc..b195eeee 100644 --- a/seed/speedtest-rs/README.md +++ b/seed/speedtest-rs/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # speedtest-rs ## Synopsis -Speedtest-rs, a very lightweight Speedtest. -[Software's website.](https://cloud.silique.fr/gitea/Silique/speedtest-rs) +[Speedtest-rs, a very lightweight Speedtest.](https://cloud.silique.fr/gitea/Silique/speedtest-rs) ## Basic variables @@ -43,9 +44,14 @@ This family is a leadership. ## Requirements services -- **LocalDNS** -- Journald -- **ReverseProxy** +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) +- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -76,5 +82,3 @@ speedtest-rs: - [journald](../journald/README.md) - [resolved](../resolved/README.md) - [reverse-proxy-client](../reverse-proxy-client/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/systemd/README.md b/seed/systemd/README.md index 3529d6c1..63d7d5b0 100644 --- a/seed/systemd/README.md +++ b/seed/systemd/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # systemd ## Synopsis -Systemd, a system and service manager. -[Software's website.](https://systemd.io/) +[Systemd, a system and service manager.](https://systemd.io/) ## Dependances @@ -25,5 +26,3 @@ Systemd, a system and service manager. - [base-fedora](../base-fedora/README.md) - [base-debian](../base-debian/README.md) - [provider-systemd-machined](../provider-systemd-machined/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/unbound/README.md b/seed/unbound/README.md index 9153704b..4ef84b1f 100644 --- a/seed/unbound/README.md +++ b/seed/unbound/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # unbound ## Synopsis -Unbound, a validating, recursive, caching DNS resolver. -[Software's website.](https://www.nlnetlabs.nl/projects/unbound/about/) +[Unbound, a validating, recursive, caching DNS resolver.](https://www.nlnetlabs.nl/projects/unbound/about/) ## Basic variables @@ -25,8 +26,9 @@ Unbound, a validating, recursive, caching DNS resolver. ## Requirements services -- **ExternalDNS** -- Journald +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -38,8 +40,6 @@ Zone names are provided as examples. Think about adapting with the value of prov unbound: applicationservice: unbound provider_zone: externaldns - zones_name: - - localdns values: general.dns_resolver.unbound_default_forwards: - 9.9.9.9 @@ -58,9 +58,9 @@ unbound: - [journald](../journald/README.md) - [resolved](../resolved/README.md) -## Suppliers +## Useful for services -- [dns-external](../dns-external/README.md) - [nsd-local](../nsd-local/README.md) - -[All applications services for this dataset.](../README.md) +- [peertube](../peertube/README.md) +- [postfix-relay](../postfix-relay/README.md) +- [znc](../znc/README.md) diff --git a/seed/unbound/dictionaries/20_unbound.xml b/seed/unbound/dictionaries/20_unbound.xml index 342789ac..1a55d3e2 100644 --- a/seed/unbound/dictionaries/20_unbound.xml +++ b/seed/unbound/dictionaries/20_unbound.xml @@ -17,7 +17,7 @@ - + udp:53 diff --git a/seed/vaultwarden/README.md b/seed/vaultwarden/README.md index 025b197f..a3c6de3e 100644 --- a/seed/vaultwarden/README.md +++ b/seed/vaultwarden/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # vaultwarden ## Synopsis -Vaultwarden, a password manager. -[Software's website.](https://github.com/dani-garcia/vaultwarden) +[Vaultwarden, a password manager.](https://github.com/dani-garcia/vaultwarden) ## Basic variables @@ -50,11 +51,16 @@ Vaultwarden, a password manager. ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **ReverseProxy** -- **Postgresql** +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) +- SMTP: [postfix-relay](../postfix-relay/README.md) +- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) +- Postgresql: [postgresql](../postgresql/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -67,9 +73,9 @@ vaultwarden: applicationservice: vaultwarden zones_name: - localdns + - postgresql - reverseproxy - smtp - - postgresql values: general.vaultwarden.vaultwarden_domainname: vault.example.net general.vaultwarden.vaultwarden_admin_email: admin@example.net @@ -89,5 +95,3 @@ vaultwarden: - [postgresql-client](../postgresql-client/README.md) - [relay-mail-client](../relay-mail-client/README.md) - [reverse-proxy-client](../reverse-proxy-client/README.md) - -[All applications services for this dataset.](../README.md) diff --git a/seed/vector/README.md b/seed/vector/README.md index 46d46c54..e92bdc3b 100644 --- a/seed/vector/README.md +++ b/seed/vector/README.md @@ -3,19 +3,25 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # vector ## Synopsis -Vector, a lightweight, ultra-fast tool for building observability pipelines. -[Software's website.](https://vector.dev/) +[Vector, a lightweight, ultra-fast tool for building observability pipelines.](https://vector.dev/) ## Requirements services -- **LocalDNS** -- Journald -- **Loki** +### Mandatories + +- LocalDNS: [nsd-local](../nsd-local/README.md) +- Loki: [loki](../loki/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -26,7 +32,7 @@ Zone names are provided as examples. Think about adapting with the value of prov ``` vector: applicationservice: vector - provider_zone: journald + provider_zone: vector zones_name: - localdns - loki @@ -45,12 +51,33 @@ vector: - [resolved](../resolved/README.md) - [journald_remote](../journald_remote/README.md) -## Supplier +## Useful for services -[host-systemd-machined](../host-systemd-machined/README.md) - -## Provider - -[loki](../loki/README.md) - -[All applications services for this dataset.](../README.md) +- [dovecot](../dovecot/README.md) +- [forgejo](../forgejo/README.md) +- [gitea](../gitea/README.md) +- [grafana](../grafana/README.md) +- [host-systemd-machined](../host-systemd-machined/README.md) +- [lemonldap](../lemonldap/README.md) +- [loki](../loki/README.md) +- [mailman](../mailman/README.md) +- [mariadb](../mariadb/README.md) +- [nextcloud](../nextcloud/README.md) +- [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) +- [nginx-static](../nginx-static/README.md) +- [nsd](../nsd/README.md) +- [nsd-local](../nsd-local/README.md) +- [odoo](../odoo/README.md) +- [openldap](../openldap/README.md) +- [peertube](../peertube/README.md) +- [piwigo](../piwigo/README.md) +- [postfix-relay](../postfix-relay/README.md) +- [postgresql](../postgresql/README.md) +- [prometheus](../prometheus/README.md) +- [redis](../redis/README.md) +- [roundcube](../roundcube/README.md) +- [speedtest-rs](../speedtest-rs/README.md) +- [unbound](../unbound/README.md) +- [vaultwarden](../vaultwarden/README.md) +- [vector](../vector/README.md) +- [znc](../znc/README.md) diff --git a/seed/znc/README.md b/seed/znc/README.md index 71fced75..e262445d 100644 --- a/seed/znc/README.md +++ b/seed/znc/README.md @@ -3,13 +3,14 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # znc ## Synopsis -ZNC, a bouncer IRC. -[Software's website.](https://wiki.znc.in/) +[ZNC, a bouncer IRC.](https://wiki.znc.in/) ## Basic variables @@ -17,12 +18,13 @@ ZNC, a bouncer IRC. #### IRC Bouncer ZNC -| Parameter | Comments | -|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------| -| **[general.znc.external_domain_name](dictionaries/40_znc.xml)**
mandatory
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de domaine externe de ZNC.
**Example:** irc.example.net | -| **[general.znc.user_name](dictionaries/40_znc.xml)**
mandatory
**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Utilisateur IRC et ZNC.
**Example:** jdoe | -| **[general.znc.user_password](dictionaries/40_znc.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 l'utilisateur ZNC.
**Example:** JD0eP@ss | -| **[general.znc.real_name](dictionaries/40_znc.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 réel.
**Example:** John Doe | +| Parameter | Comments | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **[general.znc.external_domain_name](dictionaries/40_znc.xml)**
mandatory
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de domaine externe de ZNC.
**Example:** irc.example.net | +| **[general.znc.znc_crt_provider](dictionaries/40_znc.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 le certificat du domaine extérieur.
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` | +| **[general.znc.user_name](dictionaries/40_znc.xml)**
mandatory
**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Utilisateur IRC et ZNC.
**Example:** jdoe | +| **[general.znc.user_password](dictionaries/40_znc.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 l'utilisateur ZNC.
**Example:** JD0eP@ss | +| **[general.znc.real_name](dictionaries/40_znc.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 réel.
**Example:** John Doe | ##### Serveurs IRC @@ -34,23 +36,17 @@ This family is a leadership. | **[general.znc.servers.password](dictionaries/40_znc.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 l'utilisateur sur le serveur IRC.
**Example:** p@ssw0rd | | **[general.znc.servers.channels](dictionaries/40_znc.xml)**
mandatory, multiple
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom des salons du serveur IRC.
**Example:** example | -## Variables - -### Général - -#### IRC Bouncer ZNC - -| Parameter | Comments | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| -| **[general.znc.znc_crt_provider](dictionaries/40_znc.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 le certificat du domaine extérieur.
**Choices:**
- `self-signed` ← default
- `letsencrypt` | - - ## Requirements services -- **ExternalDNS** -- Journald +### Mandatories + +- ExternalDNS: [unbound](../unbound/README.md) + +### Optionals + +- Journald: [vector](../vector/README.md) **bold**: provider is mandatory @@ -62,7 +58,7 @@ Zone names are provided as examples. Think about adapting with the value of prov znc: applicationservice: znc zones_name: - - localdns + - externaldns values: general.znc.external_domain_name: irc.example.net general.znc.user_name: jdoe @@ -89,5 +85,3 @@ znc: - [journald](../journald/README.md) - [resolved](../resolved/README.md) - [dns-external](../dns-external/README.md) - -[All applications services for this dataset.](../README.md)