diff --git a/seed/README.ExternalDNS.md b/seed/README.ExternalDNS.md new file mode 100644 index 0000000..eb9b0a9 --- /dev/null +++ b/seed/README.ExternalDNS.md @@ -0,0 +1,30 @@ +--- +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 + +| Name | Comment | +|-------------------------------------|----------------------------------------------------------| +| ExternalDNS:authority_zones | Local DNS server can export own authority zones. | +| ExternalDNS:reverse_authority_zones | Local DNS server can export own authority reverse 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..f0a4db2 --- /dev/null +++ b/seed/README.IMAP.md @@ -0,0 +1,25 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# IMAP + +## Synopsis + +IMAP client address. + +## Variables + +| Name | Comment | +|--------|-----------| + +## 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..ecea27f --- /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 + +Remote journald. + +## Variables + +| Name | Comment | +|-------------------|-------------------------------------------------------------------------------------------| +| Journald:service | Log from this service to exclude for *suffix value*. | +| Journald:function | Function use to compare message (if not defined, exlude same message) for *suffix value*. | +| Journald:message | Message to exclude for *suffix value*. | + +## 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..e4c1870 --- /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 + +Automaticly create account and connexion to a LDAP server. + +## Variables + +| Name | Comment | +|---------------|-------------------------------------| +| LDAP:family | *suffix value*. | +| LDAP:dn | LDAP account DN for *suffix value*. | +| LDAP:password | LDAP passowrd for *suffix value*. | +| LDAP:base_dn | LDAP base DN for *suffix value*. | + +## 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..9703a56 --- /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 + +| Name | Comment | +|---------------|---------------------------------------------------------------------| +| LMTP:criteria | Domain name allowes to send email with LMTP protocol*suffix value*. | + +## 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..6632f41 --- /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 + +| Name | Comment | +|--------------------|-------------------------| +| LocalDNS:DNSSEC_DS | 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..3273c19 --- /dev/null +++ b/seed/README.Loki.md @@ -0,0 +1,25 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# Loki + +## Synopsis + +Remote loki client. + +## Variables + +| Name | Comment | +|--------|-----------| + +## 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..22f3b29 --- /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 + +Automaticly create account and connexion to a MariaDB server. + +## Variables + +| Name | Comment | +|------------------|-------------------------------------------| +| MariaDB:database | MariaDB database name for *suffix value*. | +| MariaDB:username | MariaDB user name for *suffix value*. | +| MariaDB:password | MariaDB password for *suffix value*. | + +## 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..5653815 --- /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 + +| Name | Comment | +|-----------------------------|---------------------------------------------------------------------------------------------------| +| OAuth2:external_domain | OAuth2 server domain name. | +| OAuth2:client_id | Remote client id for *suffix value*. | +| OAuth2:secret | Remote secret for *suffix value*. | +| OAuth2:name | Remote name for *suffix value*. | +| OAuth2:description | Remote description for *suffix value*. | +| OAuth2:category | Remode category for *suffix value*. | +| OAuth2:login | Remote URL to login for *suffix value*. | +| OAuth2:external | Remote external for *suffix value*. | +| OAuth2:family | Remote family for *suffix value*. | +| OAuth2:logo | Logo for *suffix value*. | +| OAuth2:token_signature_algo | OAuth2 token signature algorithm for *suffix value*.
**Choices:**
- `HS512`
- `RS256` | + +## 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..a6d8aff --- /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 + +Automaticly create account and connexion to a PostgreSQL server. + +## Variables + +| Name | Comment | +|---------------------|----------------------------------------------| +| Postgresql:database | Postgresql database name for *suffix value*. | +| Postgresql:username | Postgresql username for *suffix value*. | +| Postgresql:password | Postgresql password for *suffix value*. | + +## 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..477fc1d --- /dev/null +++ b/seed/README.Prometheus.md @@ -0,0 +1,21 @@ +--- +gitea: none +include_toc: true +--- + + +[Return to the list of application services.](README.md) +# Prometheus + +## Synopsis + +Automaticly configure Prometheus exporter. + +## Variables + +| Name | Comment | +|--------|-----------| + +## 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..369cc1d --- /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 + +Automaticly create account and connexion to a Redis server. + +## Variables + +| Name | Comment | +|----------------|----------------------------------------------------------------------------------------------------------------------| +| Redis:index | Redis database index.
Only index 0 is allowed, Redis project discourage to use the server with several database. | +| Redis:username | Redis user name for *suffix value*. | +| Redis:password | Redis password for *suffix value*. | + +## 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..59085dd --- /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 + +Automaticly register to service to a reverse proxy server. + +## Variables + +| Name | Comment | +|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ReverseProxy:external | External domain name for *suffix value*. | +| ReverseProxy:location | URI to redirect for *suffix value*.
URL relative (sans le nom de domaine) redirigée pour l'adresse définie dans la variable ci-dessus (exemple "/mail"). | +| ReverseProxy:url | Internal URL for *suffix value*. | +| ReverseProxy:websocket | The entry point is a websocket for *suffix value*.
**Default:** [True] | +| ReverseProxy:max_body_size | Body size max for *suffix value*. | +| ReverseProxy:http | The website is in HTTP for *suffix value*.
**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..5b461ad --- /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 + +Automaticly 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 + +| Name | Comment | +|---------------|------------------------------------------------| +| SMTP:username | User account to send email for *suffix value*. | +| SMTP:password | Password to send email for *suffix value*. | + +## 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..3001f1d --- /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 + +| Name | Comment | +|----------------|---------------| +| Vector:address | IP addresses. | + +## 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..1ac0bd6 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 client address. +- [Journald](README.Journald.md): Remote journald. +- [LDAP](README.LDAP.md): Automaticly 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): Remote loki client. +- [MariaDB](README.MariaDB.md): Automaticly create account and connexion to a MariaDB server. +- [OAuth2](README.OAuth2.md): Remote clients needing to verify OAuth2 account. +- [Postgresql](README.Postgresql.md): Automaticly create account and connexion to a PostgreSQL server. +- [Prometheus](README.Prometheus.md): Automaticly configure Prometheus exporter. +- [Redis](README.Redis.md): Automaticly create account and connexion to a Redis server. +- [ReverseProxy](README.ReverseProxy.md): Automaticly register to service to a reverse proxy server. +- [SMTP](README.SMTP.md): Automaticly 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..d14fa21 100644 --- a/seed/dovecot/README.md +++ b/seed/dovecot/README.md @@ -3,73 +3,67 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # dovecot ## Synopsis -Postfix and Dovecot as mail servers (Submission and IMAP). -[Software's website.](https://www.dovecot.org/) +[Postfix and Dovecot as mail servers (IMAP and submission).](https://www.dovecot.org/) + +This application service provides email server. Two servers are used: Dovecot as IMAP server and Postfix as submission server. In addition, an auto-detection file of the email configuration is set up. ## Basic variables -### Général +### General #### Mail configuration +Configure IMAP servers and submission to access email accounts and send emails. + ##### Mail domain This family is a leadership. -| Parameter | Comments | -|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------| -| **[general.mail.domain.mail_domains](dictionaries/31_dovecot.xml)**
mandatory, multiple
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Domaine de courriel géré localement.
**Example:** example.net | -| **[general.mail.domain.imap_domainname](dictionaries/31_dovecot.xml)**
mandatory
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Domaine exterieur d'accès au serveur IMAP.
**Example:** imap.example.net | -| **[general.mail.domain.submission_domainname](dictionaries/31_dovecot.xml)**
mandatory
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Domaine exterieur d'accès au serveur submission.
**Example:** submission.example.net | +| Parameter | Comments | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **[general.mail.domain.mail_domains](dictionaries/31_dovecot.xml)**
mandatory, multiple
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Final destination email address.
These domain names are the domain names for emails (user@*example.net*) and for auto configuration of email clients (https://*example.net*/.well-known/autoconfig/mail/config-v1.1.xml).
**Example:** example.net | +| **[general.mail.domain.imap_domainname](dictionaries/31_dovecot.xml)**
mandatory
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | External IMAP server address.
Matches TLS connection’s SNI name, if it’s sent by the client. For some email clients, use in DNS configuration a line like "_submissions._tcp IN SRV 1 587 *imap.example.net*.".
**Example:** imap.example.net | +| **[general.mail.domain.submission_domainname](dictionaries/31_dovecot.xml)**
mandatory
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | External submission server address.
Matches TLS connection’s SNI name, if it’s sent by the client. For some email clients, add in DNS configuration a line like "_imaps._tcp IN SRV 0 1 993 *submission.example.net*.".
**Example:** submission.example.net | -## Variables +| Parameter | Comments | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **[general.mail.mail_crt_provider](dictionaries/31_dovecot.xml)**
mandatory
**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Type of certificate autority signing external IMAP and submission domain certificates.
The certificate can be self-signed (therefore invalid by default for the client) or obtained via the Let's Encrypt service (generally valid for the client).
**Choices:**
- `self-signed` ← default
- `letsencrypt` | -### Général - -#### Mail configuration - -##### Mail domain - -This family is a leadership. - -| Parameter | Comments | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| -| **[general.mail.mail_crt_provider](dictionaries/31_dovecot.xml)**
mandatory
**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Autorité de certification signant les certificats des domaines extérieurs.
**Choices:**
- `self-signed` ← default
- `letsencrypt` | ## Variables for expert -### Général +### General -#### Annuaire OpenLDAP +#### OpenLDAP directory ##### Client -| Parameter | Comments | -|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------| -| **[general.ldap.client.ldapclient_family](dictionaries/31_dovecot.xml)**
mandatory
**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de la famille LDAP.
**Default:** all | -| **[general.ldap.client.ldapclient_base_dn](dictionaries/21_ldap-client.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Base DN de l'annuaire.
**Default:** *calculated* | -| **[general.ldap.client.ldapclient_search_dn](dictionaries/21_ldap-client.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Base DN de l'annuaire des utilisateurs.
**Default:** *calculated* | -| **[general.ldap.client.ldapclient_group_dn](dictionaries/21_ldap-client.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Base DN de l'annuaire des groupes.
**Default:** *calculated* | -| **[general.ldap.client.ldapclient_user_dn](dictionaries/21_ldap-client.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Base DN de l'annuaire des utilisateurs n'appartenant à une famille.
**Default:** *calculated* | +| Parameter | Comments | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| +| **[general.ldap.client.ldapclient_family](dictionaries/31_dovecot.xml)**
mandatory
**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Restrict service configuration for a LDAP family.
"all" for all families.
**Default:** all | ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **LDAP** -- **ReverseProxy** -- **LMTP** -- **OAuth2** +### Mandatories -**bold**: provider is mandatory +- [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name. +- [SMTP](../README.SMTP.md): Automaticly create a SMTP relay account and authorize sending email. +- [LDAP](../README.LDAP.md): Automaticly create account and connexion to a LDAP server. +- [ReverseProxy](../README.ReverseProxy.md): Automaticly register to service to a reverse proxy server. +- [OAuth2](../README.OAuth2.md): Remote clients needing to verify OAuth2 account. + +### Optionals + +- [Journald](../README.Journald.md): Remote journald. ## Example @@ -82,10 +76,9 @@ dovecot: zones_name: - ldap - localdns + - oauth2 - reverseproxy - smtp - - lmtp - - oauth2 values: general.mail.domain.mail_domains: - example.net @@ -97,25 +90,23 @@ dovecot: ## 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..0884b6c 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..121f24e 100644 --- a/seed/forgejo/README.md +++ b/seed/forgejo/README.md @@ -3,28 +3,29 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # forgejo ## Synopsis -Forgejo, a community managed lightweight code hosting solution. -[Software's website.](https://forgejo.org/) +[Forgejo, a community managed lightweight code hosting solution.](https://forgejo.org/) ## Basic variables -### Général +### General #### Reverse proxy -##### Point d'entrée des clients +##### Clients configuration This family is a leadership. -| Parameter | Comments | -|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| -| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**
mandatory, multiple
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de domaine exterieur du serveur.
**Example:** service.example.net | -| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**
mandatory
**Type:** [`filename`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de l'arborescence racine du site. | +| Parameter | Comments | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------| +| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**
mandatory, multiple
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Service external domain name.
**Example:** service.example.net | +| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**
mandatory
**Type:** [`filename`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | URI to route request to the correct service.
**Default:** / | #### Forgejo @@ -38,32 +39,17 @@ Git forge Forgejo. ## Variables for expert -### Général +### General #### Reverse proxy -##### Point d'entrée des clients +##### Clients configuration This family is a leadership. -| Parameter | Comments | -|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| -| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximum du corps. | - -#### PostgreSQL - -| Parameter | Comments | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------| -| **[general.postgresql.pg_client_username](dictionaries/23_postgresql.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client username.
**Default:** *calculated* | -| **[general.postgresql.pg_client_password](dictionaries/23_postgresql.xml)**
mandatory
**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client password.
**Default:** *calculated* | -| **[general.postgresql.pg_client_database](dictionaries/23_postgresql.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client database.
**Default:** *calculated* | - -#### Redis - -| Parameter | Comments | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------| -| **[general.redis.redis_client_username](dictionaries/23_redis.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom d'utilisateur.
**Default:** *calculated* | -| **[general.redis.redis_client_password](dictionaries/23_redis.xml)**
mandatory
**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Mot de passe de connexion.
**Default:** *calculated* | +| Parameter | Comments | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The maximum allowed size of the client request body. | #### OAuth2 client @@ -89,15 +75,18 @@ This family is a leadership. ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **ReverseProxy** -- **Postgresql** -- **Redis** -- **OAuth2** +### Mandatories -**bold**: provider is mandatory +- [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name. +- [SMTP](../README.SMTP.md): Automaticly create a SMTP relay account and authorize sending email. +- [ReverseProxy](../README.ReverseProxy.md): Automaticly register to service to a reverse proxy server. +- [Postgresql](../README.Postgresql.md): Automaticly create account and connexion to a PostgreSQL server. +- [OAuth2](../README.OAuth2.md): Remote clients needing to verify OAuth2 account. +- [Redis](../README.Redis.md): Automaticly create account and connexion to a Redis server. + +### Optionals + +- [Journald](../README.Journald.md): Remote journald. ## Example @@ -108,11 +97,11 @@ forgejo: applicationservice: forgejo zones_name: - localdns - - reverseproxy - - smtp - - redis - oauth2 - postgresql + - redis + - reverseproxy + - smtp values: general.revprox.revprox_client.revprox_client_external_domainnames: - service.example.net @@ -121,24 +110,22 @@ forgejo: ## 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..959628e 100644 --- a/seed/gitea/README.md +++ b/seed/gitea/README.md @@ -3,6 +3,8 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # gitea ## Synopsis @@ -11,18 +13,18 @@ Transitional package for Gitea to Forgejo. ## Basic variables -### Général +### General #### Reverse proxy -##### Point d'entrée des clients +##### Clients configuration This family is a leadership. -| Parameter | Comments | -|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| -| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**
mandatory, multiple
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de domaine exterieur du serveur.
**Example:** service.example.net | -| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**
mandatory
**Type:** [`filename`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de l'arborescence racine du site. | +| Parameter | Comments | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------| +| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**
mandatory, multiple
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Service external domain name.
**Example:** service.example.net | +| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**
mandatory
**Type:** [`filename`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | URI to route request to the correct service.
**Default:** / | #### Forgejo @@ -36,7 +38,7 @@ Git forge Forgejo. ## Variables -### Général +### General #### Forgejo @@ -54,32 +56,17 @@ Git forge Forgejo. ## Variables for expert -### Général +### General #### Reverse proxy -##### Point d'entrée des clients +##### Clients configuration This family is a leadership. -| Parameter | Comments | -|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| -| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximum du corps. | - -#### PostgreSQL - -| Parameter | Comments | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------| -| **[general.postgresql.pg_client_username](dictionaries/23_postgresql.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client username.
**Default:** *calculated* | -| **[general.postgresql.pg_client_password](dictionaries/23_postgresql.xml)**
mandatory
**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client password.
**Default:** *calculated* | -| **[general.postgresql.pg_client_database](dictionaries/23_postgresql.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client database.
**Default:** *calculated* | - -#### Redis - -| Parameter | Comments | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------| -| **[general.redis.redis_client_username](dictionaries/23_redis.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom d'utilisateur.
**Default:** *calculated* | -| **[general.redis.redis_client_password](dictionaries/23_redis.xml)**
mandatory
**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Mot de passe de connexion.
**Default:** *calculated* | +| Parameter | Comments | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The maximum allowed size of the client request body. | #### OAuth2 client @@ -105,15 +92,18 @@ This family is a leadership. ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **ReverseProxy** -- **Postgresql** -- **Redis** -- **OAuth2** +### Mandatories -**bold**: provider is mandatory +- [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name. +- [SMTP](../README.SMTP.md): Automaticly create a SMTP relay account and authorize sending email. +- [ReverseProxy](../README.ReverseProxy.md): Automaticly register to service to a reverse proxy server. +- [Postgresql](../README.Postgresql.md): Automaticly create account and connexion to a PostgreSQL server. +- [OAuth2](../README.OAuth2.md): Remote clients needing to verify OAuth2 account. +- [Redis](../README.Redis.md): Automaticly create account and connexion to a Redis server. + +### Optionals + +- [Journald](../README.Journald.md): Remote journald. ## Example @@ -124,11 +114,11 @@ gitea: applicationservice: gitea zones_name: - localdns - - reverseproxy - - smtp - - redis - oauth2 - postgresql + - redis + - reverseproxy + - smtp values: general.revprox.revprox_client.revprox_client_external_domainnames: - service.example.net @@ -136,21 +126,19 @@ gitea: ## 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..74d5f73 100644 --- a/seed/grafana/README.md +++ b/seed/grafana/README.md @@ -3,28 +3,29 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # grafana ## Synopsis -Grafana is an analytics and interactive visualization web application. -[Software's website.](https://grafana.com/) +[Grafana is an analytics and interactive visualization web application.](https://grafana.com/) ## Basic variables -### Général +### General #### Reverse proxy -##### Point d'entrée des clients +##### Clients configuration This family is a leadership. -| Parameter | Comments | -|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| -| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**
mandatory, multiple
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de domaine exterieur du serveur.
**Example:** service.example.net | -| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**
mandatory
**Type:** [`filename`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de l'arborescence racine du site. | +| Parameter | Comments | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------| +| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**
mandatory, multiple
**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Service external domain name.
**Example:** service.example.net | +| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**
mandatory
**Type:** [`filename`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | URI to route request to the correct service.
**Default:** / | #### OAuth2 client @@ -37,25 +38,17 @@ This family is a leadership. ## Variables for expert -### Général +### General #### Reverse proxy -##### Point d'entrée des clients +##### Clients configuration This family is a leadership. -| Parameter | Comments | -|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| -| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximum du corps. | - -#### PostgreSQL - -| Parameter | Comments | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------| -| **[general.postgresql.pg_client_username](dictionaries/23_postgresql.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client username.
**Default:** *calculated* | -| **[general.postgresql.pg_client_password](dictionaries/23_postgresql.xml)**
mandatory
**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client password.
**Default:** *calculated* | -| **[general.postgresql.pg_client_database](dictionaries/23_postgresql.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client database.
**Default:** *calculated* | +| Parameter | Comments | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The maximum allowed size of the client request body. | #### OAuth2 client @@ -79,14 +72,17 @@ This family is a leadership. ## Requirements services -- **LocalDNS** -- Journald -- **SMTP** -- **ReverseProxy** -- **Postgresql** -- **OAuth2** +### Mandatories -**bold**: provider is mandatory +- [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name. +- [SMTP](../README.SMTP.md): Automaticly create a SMTP relay account and authorize sending email. +- [ReverseProxy](../README.ReverseProxy.md): Automaticly register to service to a reverse proxy server. +- [Postgresql](../README.Postgresql.md): Automaticly create account and connexion to a PostgreSQL server. +- [OAuth2](../README.OAuth2.md): Remote clients needing to verify OAuth2 account. + +### Optionals + +- [Journald](../README.Journald.md): Remote journald. ## Example @@ -97,10 +93,10 @@ grafana: applicationservice: grafana zones_name: - localdns - - reverseproxy - - smtp - oauth2 - postgresql + - reverseproxy + - smtp values: general.revprox.revprox_client.revprox_client_external_domainnames: - service.example.net @@ -109,18 +105,16 @@ grafana: ## 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..a48d2c2 100644 --- a/seed/host-systemd-machined/README.md +++ b/seed/host-systemd-machined/README.md @@ -3,17 +3,18 @@ gitea: none include_toc: true --- + +[Return to the list of application services.](../README.md) # host-systemd-machined ## Synopsis -Host with machine started in Systemd Machined environment. -[Software's website.](https://www.freedesktop.org/wiki/Software/systemd/machined/) +[Host with machine started in Systemd Machined environment.](https://www.freedesktop.org/wiki/Software/systemd/machined/) ## Basic variables -### Général +### General #### network @@ -34,7 +35,7 @@ This family is a leadership. ## Variables -### Général +### General | Parameter | Comments | |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------| @@ -46,22 +47,22 @@ This family is a leadership. This family is a leadership. -| Parameter | Comments | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| -| **[general.network.interfaces.interface_type](dictionaries/21_machined.xml)**
mandatory
**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Type de la carte.
**Choices:**
- `dhcp`
- `ipv4` | +| Parameter | Comments | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------| +| **[general.network.interfaces.interface_type](dictionaries/21_machined.xml)**
mandatory
**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Type de la carte.
**Choices:**
- `dhcp` ← default
- `ipv4` | + +## Variables for expert + +### General + +#### base + +| Parameter | Comments | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| **[general.base.time_zone](dictionaries/21_machined.xml)**
mandatory
**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Time zone.
**Default:** Europe/Paris | + ## Dependances -- [base](../base/README.md) - -## Supplier - -[provider-systemd-machined](../provider-systemd-machined/README.md) - -## Providers - -- [prometheus](../prometheus/README.md) -- [vector](../vector/README.md) - -[All applications services for this dataset.](../README.md) +- [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 @@ - +