gnunux/dataset
1
0
Fork 0
forked from stove/dataset
Code Issues Pull requests Projects Releases Wiki Activity

update doc

Browse source
This commit is contained in:
egarette@silique.fr 2023-08-11 09:38:05 +02:00
parent 772283e0a6
commit c9162a5042
126 changed files with 2612 additions and 2360 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
seed/README.ExternalDNS.md Normal file
View file

@ -0,0 +1,29 @@
---
gitea: none
include_toc: true
---
[Return to the list of application services.](README.md)
# ExternalDNS
## Synopsis
DNS forwarder for all DNS zones.<br/>This provider is able to answer query for external and internal domain name.
## Variables
| Parameter | Comment |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|
| **ExternalDNS:authority_zones**<br/>multiple<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Local DNS server can export own authority zones. |
## Provider
[unbound](unbound/README.md): Unbound, a validating, recursive, caching DNS resolver.
## Suppliers
- [postfix-relay](postfix-relay/README.md): Postfix, the mail server, as relay.
- [peertube](peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform.
- [znc](znc/README.md): ZNC, a bouncer IRC.
- [nsd-local](nsd-local/README.md): NSD, an authoritative DNS name server for local resolution.

23
seed/README.IMAP.md Normal file
View file

@ -0,0 +1,23 @@
---
gitea: none
include_toc: true
---
[Return to the list of application services.](README.md)
# IMAP
## Synopsis
IMAP server connexion.
## Variables
## Provider
[dovecot](dovecot/README.md): Postfix and Dovecot as mail servers (IMAP and submission).
## Supplier
[roundcube](roundcube/README.md): Roundcube, a webmail.

54
seed/README.Journald.md Normal file
View file

@ -0,0 +1,54 @@
---
gitea: none
include_toc: true
---
[Return to the list of application services.](README.md)
# Journald
## Synopsis
Concentrate journal messages on one host.
## Variables
| Parameter | Comment |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|
| **Journald:message**<br/>mandatory, multiple<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Message to exclude for *supplier name*. |
| **Journald:service**<br/>mandatory, multiple<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Log from this service to exclude for *supplier name*. |
| **Journald:function**<br/>multiple<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Function use to compare message (if not defined, exlude same message) for *supplier name*. |
## Provider
[vector](vector/README.md): Vector, a lightweight, ultra-fast tool for building observability pipelines.
## Suppliers
- [odoo](odoo/README.md): Odoo, an ERP and CRM.
- [nginx-static](nginx-static/README.md): Nginx as static web site.
- [grafana](grafana/README.md): Grafana is an analytics and interactive visualization web application.
- [postgresql](postgresql/README.md): Postgresql, a database.
- [postfix-relay](postfix-relay/README.md): Postfix, the mail server, as relay.
- [mailman](mailman/README.md): GNU Mailman, managing electronic mail discussion and e-newsletter lists.
- [peertube](peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform.
- [piwigo](piwigo/README.md): Piwigo, a photo management software.
- [vector](vector/README.md): Vector, a lightweight, ultra-fast tool for building observability pipelines.
- [dovecot](dovecot/README.md): Postfix and Dovecot as mail servers (IMAP and submission).
- [unbound](unbound/README.md): Unbound, a validating, recursive, caching DNS resolver.
- [redis](redis/README.md): Redis, an in-memory data structure store.
- [loki](loki/README.md): Loki, a log aggregation platform.
- [forgejo](forgejo/README.md): Forgejo, a community managed lightweight code hosting solution.
- [nsd](nsd/README.md): NSD, an authoritative DNS name server.
- [speedtest-rs](speedtest-rs/README.md): Speedtest-rs, a very lightweight Speedtest.
- [nginx-reverse-proxy](nginx-reverse-proxy/README.md): Nginx as reverse proxy.
- [roundcube](roundcube/README.md): Roundcube, a webmail.
- [znc](znc/README.md): ZNC, a bouncer IRC.
- [vaultwarden](vaultwarden/README.md): Vaultwarden, a password manager.
- [prometheus](prometheus/README.md): Prometheus, an event monitoring.
- [mariadb](mariadb/README.md): MariaDB, a relational database.
- [nsd-local](nsd-local/README.md): NSD, an authoritative DNS name server for local resolution.
- [nextcloud](nextcloud/README.md): Nextcloud, Online collaboration platform.
- [lemonldap](lemonldap/README.md): LemonLDAP, a Web Single Sign On and Access Management.
- [openldap](openldap/README.md): OpenLDAP, the LDAP server.
- [gitea](gitea/README.md): Transitional package for Gitea to Forgejo.

34
seed/README.LDAP.md Normal file
View file

@ -0,0 +1,34 @@
---
gitea: none
include_toc: true
---
[Return to the list of application services.](README.md)
# LDAP
## Synopsis
Create account and connexion to a LDAP server.
## Variables
| Parameter | Comment |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|
| **LDAP:family**<br/>**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | LDAP family name for *supplier name*. |
| **LDAP:dn**<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | LDAP account DN for *supplier name*. |
| **LDAP:password**<br/>mandatory<br/>**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | LDAP passowrd for *supplier name*. |
| **LDAP:base_dn**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | LDAP base DN for *supplier name*. |
## Provider
[openldap](openldap/README.md): OpenLDAP, the LDAP server.
## Suppliers
- [odoo](odoo/README.md): Odoo, an ERP and CRM.
- [piwigo](piwigo/README.md): Piwigo, a photo management software.
- [dovecot](dovecot/README.md): Postfix and Dovecot as mail servers (IMAP and submission).
- [roundcube](roundcube/README.md): Roundcube, a webmail.
- [nextcloud](nextcloud/README.md): Nextcloud, Online collaboration platform.
- [lemonldap](lemonldap/README.md): LemonLDAP, a Web Single Sign On and Access Management.

27
seed/README.LMTP.md Normal file
View file

@ -0,0 +1,27 @@
---
gitea: none
include_toc: true
---
[Return to the list of application services.](README.md)
# LMTP
## Synopsis
LMTP remote server.<br/>A service needs send email with LMTP protocol.
## Variables
| Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------|
| **LMTP:criteria**<br/>mandatory, multiple<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Domain name allowes to send email with LMTP protocol for *supplier name*. |
## Provider
[postfix-relay](postfix-relay/README.md): Postfix, the mail server, as relay.
## Suppliers
- [mailman](mailman/README.md): GNU Mailman, managing electronic mail discussion and e-newsletter lists.
- [dovecot](dovecot/README.md): Postfix and Dovecot as mail servers (IMAP and submission).

48
seed/README.LocalDNS.md Normal file
View file

@ -0,0 +1,48 @@
---
gitea: none
include_toc: true
---
[Return to the list of application services.](README.md)
# LocalDNS
## Synopsis
DNS forwarder for local domain name.
## Variables
| Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|
| **LocalDNS:DNSSEC_DS**<br/>multiple<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | DNSSEC DS informations. |
## Provider
[nsd-local](nsd-local/README.md): NSD, an authoritative DNS name server for local resolution.
## Suppliers
- [odoo](odoo/README.md): Odoo, an ERP and CRM.
- [nginx-static](nginx-static/README.md): Nginx as static web site.
- [grafana](grafana/README.md): Grafana is an analytics and interactive visualization web application.
- [postgresql](postgresql/README.md): Postgresql, a database.
- [mailman](mailman/README.md): GNU Mailman, managing electronic mail discussion and e-newsletter lists.
- [piwigo](piwigo/README.md): Piwigo, a photo management software.
- [vector](vector/README.md): Vector, a lightweight, ultra-fast tool for building observability pipelines.
- [dovecot](dovecot/README.md): Postfix and Dovecot as mail servers (IMAP and submission).
- [redis](redis/README.md): Redis, an in-memory data structure store.
- [loki](loki/README.md): Loki, a log aggregation platform.
- [forgejo](forgejo/README.md): Forgejo, a community managed lightweight code hosting solution.
- [nsd](nsd/README.md): NSD, an authoritative DNS name server.
- [speedtest-rs](speedtest-rs/README.md): Speedtest-rs, a very lightweight Speedtest.
- [nginx-reverse-proxy](nginx-reverse-proxy/README.md): Nginx as reverse proxy.
- [roundcube](roundcube/README.md): Roundcube, a webmail.
- [vaultwarden](vaultwarden/README.md): Vaultwarden, a password manager.
- [prometheus](prometheus/README.md): Prometheus, an event monitoring.
- [mariadb](mariadb/README.md): MariaDB, a relational database.
- [nsd-local](nsd-local/README.md): NSD, an authoritative DNS name server for local resolution.
- [nextcloud](nextcloud/README.md): Nextcloud, Online collaboration platform.
- [lemonldap](lemonldap/README.md): LemonLDAP, a Web Single Sign On and Access Management.
- [openldap](openldap/README.md): OpenLDAP, the LDAP server.
- [gitea](gitea/README.md): Transitional package for Gitea to Forgejo.

23
seed/README.Loki.md Normal file
View file

@ -0,0 +1,23 @@
---
gitea: none
include_toc: true
---
[Return to the list of application services.](README.md)
# Loki
## Synopsis
Concentrate log messages.
## Variables
## Provider
[loki](loki/README.md): Loki, a log aggregation platform.
## Supplier
[vector](vector/README.md): Vector, a lightweight, ultra-fast tool for building observability pipelines.

28
seed/README.MariaDB.md Normal file
View file

@ -0,0 +1,28 @@
---
gitea: none
include_toc: true
---
[Return to the list of application services.](README.md)
# MariaDB
## Synopsis
Create account and connexion to a MariaDB server.
## Variables
| Parameter | Comment |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|
| **MariaDB:username**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | MariaDB user name for *supplier name*. |
| **MariaDB:password**<br/>mandatory<br/>**Type:** [`secret`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | MariaDB password for *supplier name*. |
| **MariaDB:database**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | MariaDB database name for *supplier name*. |
## Provider
[mariadb](mariadb/README.md): MariaDB, a relational database.
## Supplier
[piwigo](piwigo/README.md): Piwigo, a photo management software.

45
seed/README.OAuth2.md Normal file
View file

@ -0,0 +1,45 @@
---
gitea: none
include_toc: true
---
[Return to the list of application services.](README.md)
# OAuth2
## Synopsis
Remote clients needing to verify OAuth2 account.
## Variables
| Parameter | Comment |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
| **OAuth2:name**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Remote name for *supplier name*. |
| **OAuth2:description**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Remote description for *supplier name*. |
| **OAuth2:login**<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Remote URL to login for *supplier name*. |
| **OAuth2:external**<br/>mandatory, multiple<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Remote external for *supplier name*. |
| **OAuth2:family**<br/>mandatory, multiple<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Remote family for *supplier name*. |
| **OAuth2:category**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Remode category for *supplier name*. |
| **OAuth2:logo**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Logo for *supplier name*. |
| **OAuth2:client_id**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Remote client id for *supplier name*. |
| **OAuth2:secret**<br/>mandatory<br/>**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Remote secret for *supplier name*. |
| **OAuth2:token_signature_algo**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 token signature algorithm for *supplier name*.<br/>**Choices:**<br/>- `HS512`<br/>- `RS256` |
| **OAuth2:external_domain**<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 server domain name. |
## Provider
[lemonldap](lemonldap/README.md): LemonLDAP, a Web Single Sign On and Access Management.
## Suppliers
- [odoo](odoo/README.md): Odoo, an ERP and CRM.
- [grafana](grafana/README.md): Grafana is an analytics and interactive visualization web application.
- [mailman](mailman/README.md): GNU Mailman, managing electronic mail discussion and e-newsletter lists.
- [peertube](peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform.
- [piwigo](piwigo/README.md): Piwigo, a photo management software.
- [dovecot](dovecot/README.md): Postfix and Dovecot as mail servers (IMAP and submission).
- [forgejo](forgejo/README.md): Forgejo, a community managed lightweight code hosting solution.
- [roundcube](roundcube/README.md): Roundcube, a webmail.
- [nextcloud](nextcloud/README.md): Nextcloud, Online collaboration platform.
- [gitea](gitea/README.md): Transitional package for Gitea to Forgejo.

36
seed/README.Postgresql.md Normal file
View file

@ -0,0 +1,36 @@
---
gitea: none
include_toc: true
---
[Return to the list of application services.](README.md)
# Postgresql
## Synopsis
Create account and connexion to a PostgreSQL server.
## Variables
| Parameter | Comment |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|
| **Postgresql:username**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Postgresql username for *supplier name*. |
| **Postgresql:password**<br/>mandatory<br/>**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Postgresql password for *supplier name*. |
| **Postgresql:database**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Postgresql database name for *supplier name*. |
## Provider
[postgresql](postgresql/README.md): Postgresql, a database.
## Suppliers
- [odoo](odoo/README.md): Odoo, an ERP and CRM.
- [grafana](grafana/README.md): Grafana is an analytics and interactive visualization web application.
- [mailman](mailman/README.md): GNU Mailman, managing electronic mail discussion and e-newsletter lists.
- [peertube](peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform.
- [forgejo](forgejo/README.md): Forgejo, a community managed lightweight code hosting solution.
- [roundcube](roundcube/README.md): Roundcube, a webmail.
- [vaultwarden](vaultwarden/README.md): Vaultwarden, a password manager.
- [nextcloud](nextcloud/README.md): Nextcloud, Online collaboration platform.
- [gitea](gitea/README.md): Transitional package for Gitea to Forgejo.

19
seed/README.Prometheus.md Normal file
View file

@ -0,0 +1,19 @@
---
gitea: none
include_toc: true
---
[Return to the list of application services.](README.md)
# Prometheus
## Synopsis
Configure Prometheus exporter.
## Variables
## Provider
[prometheus](prometheus/README.md): Prometheus, an event monitoring.

33
seed/README.Redis.md Normal file
View file

@ -0,0 +1,33 @@
---
gitea: none
include_toc: true
---
[Return to the list of application services.](README.md)
# Redis
## Synopsis
Create account and connexion to a Redis server.
## Variables
| Parameter | Comment |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|
| **Redis:username**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Redis user name for *supplier name*. |
| **Redis:password**<br/>mandatory<br/>**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Redis password for *supplier name*. |
| **Redis:index**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Redis database index.<br/>Only index 0 is allowed, Redis project discourage to use the server with several database. |
## Provider
[redis](redis/README.md): Redis, an in-memory data structure store.
## Suppliers
- [peertube](peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform.
- [piwigo](piwigo/README.md): Piwigo, a photo management software.
- [forgejo](forgejo/README.md): Forgejo, a community managed lightweight code hosting solution.
- [roundcube](roundcube/README.md): Roundcube, a webmail.
- [nextcloud](nextcloud/README.md): Nextcloud, Online collaboration platform.
- [gitea](gitea/README.md): Transitional package for Gitea to Forgejo.

44
seed/README.ReverseProxy.md Normal file
View file

@ -0,0 +1,44 @@
---
gitea: none
include_toc: true
---
[Return to the list of application services.](README.md)
# ReverseProxy
## Synopsis
Register to service to a reverse proxy server.
## Variables
| Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|
| **ReverseProxy:external**<br/>mandatory, multiple<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | External domain name for *supplier name*. |
| **ReverseProxy:location**<br/>mandatory<br/>**Type:** [`filename`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | URI to redirect for *supplier name*.<br/>Relative redirected URI (without domaine name).<br/>**Example:** /mail |
| **ReverseProxy:max_body_size**<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Body size max for *supplier name*. |
| **ReverseProxy:websocket**<br/>mandatory<br/>**Type:** [`boolean`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The entry point is a websocket for *supplier name*.<br/>**Default:** [True] |
| **ReverseProxy:url**<br/>mandatory<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Internal URL for *supplier name*. |
| **ReverseProxy:http**<br/>mandatory<br/>**Type:** [`boolean`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The website is in HTTP for *supplier name*.<br/>**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.

37
seed/README.SMTP.md Normal file
View file

@ -0,0 +1,37 @@
---
gitea: none
include_toc: true
---
[Return to the list of application services.](README.md)
# SMTP
## Synopsis
Create a SMTP relay account and authorize sending email.<br/>A service needs send email with SMTP protocol, so an account is created and SMTP relay accept sending mail by this account.
## Variables
| Parameter | Comment |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|
| **SMTP:username**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | User account to send email for *supplier name*. |
| **SMTP:password**<br/>mandatory<br/>**Type:** [`secret`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Password to send email for *supplier name*. |
## Provider
[postfix-relay](postfix-relay/README.md): Postfix, the mail server, as relay.
## Suppliers
- [odoo](odoo/README.md): Odoo, an ERP and CRM.
- [grafana](grafana/README.md): Grafana is an analytics and interactive visualization web application.
- [mailman](mailman/README.md): GNU Mailman, managing electronic mail discussion and e-newsletter lists.
- [peertube](peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform.
- [piwigo](piwigo/README.md): Piwigo, a photo management software.
- [dovecot](dovecot/README.md): Postfix and Dovecot as mail servers (IMAP and submission).
- [forgejo](forgejo/README.md): Forgejo, a community managed lightweight code hosting solution.
- [vaultwarden](vaultwarden/README.md): Vaultwarden, a password manager.
- [nextcloud](nextcloud/README.md): Nextcloud, Online collaboration platform.
- [lemonldap](lemonldap/README.md): LemonLDAP, a Web Single Sign On and Access Management.
- [gitea](gitea/README.md): Transitional package for Gitea to Forgejo.

22
seed/README.Vector.md Normal file
View file

@ -0,0 +1,22 @@
---
gitea: none
include_toc: true
---
[Return to the list of application services.](README.md)
# Vector
## Synopsis
Collect observability data from another Vector instance.
## Variables
| Parameter | Comment |
|-------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
| **Vector:address**<br/>**Type:** [`ip`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Send Journal on this IP address.<br/>Vector must listen on this address, clients are configured to use this destination IP. |
## Provider
[vector](vector/README.md): Vector, a lightweight, ultra-fast tool for building observability pipelines.

69
seed/README.md
View file

@ -1,6 +1,6 @@
# Application services # 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 - [forgejo](forgejo/README.md): Forgejo, a community managed lightweight code hosting solution
- [gitea](gitea/README.md): Transitional package for Gitea to Forgejo - [gitea](gitea/README.md): Transitional package for Gitea to Forgejo
- [grafana](grafana/README.md): Grafana is an analytics and interactive visualization web application - [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 - [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 - [systemd](systemd/README.md): Systemd, a system and service manager
# Providers and suppliers # Providers
- ExternalDNS: - [ExternalDNS](README.ExternalDNS.md): DNS forwarder for all DNS zones.
- Provider: [unbound](unbound/README.md) - [IMAP](README.IMAP.md): IMAP server connexion.
- Suppliers: - [Journald](README.Journald.md): Concentrate journal messages on one host.
- [dns-external](dns-external/README.md) - [LDAP](README.LDAP.md): Create account and connexion to a LDAP server.
- [nsd-local](nsd-local/README.md) - [LMTP](README.LMTP.md): LMTP remote server.
- Host: - [LocalDNS](README.LocalDNS.md): DNS forwarder for local domain name.
- Provider: [host-systemd-machined](host-systemd-machined/README.md) - [Loki](README.Loki.md): Concentrate log messages.
- Supplier: [provider-systemd-machined](provider-systemd-machined/README.md) - [MariaDB](README.MariaDB.md): Create account and connexion to a MariaDB server.
- IMAP: - [OAuth2](README.OAuth2.md): Remote clients needing to verify OAuth2 account.
- Provider: [dovecot](dovecot/README.md) - [Postgresql](README.Postgresql.md): Create account and connexion to a PostgreSQL server.
- Supplier: [imap-client](imap-client/README.md) - [Prometheus](README.Prometheus.md): Configure Prometheus exporter.
- Journald: - [Redis](README.Redis.md): Create account and connexion to a Redis server.
- Provider: [journald_remote](journald_remote/README.md) - [ReverseProxy](README.ReverseProxy.md): Register to service to a reverse proxy server.
- Supplier: [journald](journald/README.md) - [SMTP](README.SMTP.md): Create a SMTP relay account and authorize sending email.
- LDAP: - [Vector](README.Vector.md): Collect observability data from another Vector instance.
- 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)

21
seed/apache/README.md
View file

@ -3,35 +3,34 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# apache # apache
## Synopsis ## Synopsis
Apache as web server.
[Software's website.](https://httpd.apache.org/) [Apache as web server.](https://httpd.apache.org/)
## Variables for expert ## Variables for expert
### Général ### General
#### Apache #### Apache
Paramètrage avancé du serveur web Apache. Advance Apache web server settings.
| Parameter | Comments | | Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
| **[general.apache.apache_timeout](dictionaries/20_web.xml)**<br/>mandatory<br/>**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é.<br/>Temps en secondes.<br/>**Default:** 300 | | **[general.apache.apache_timeout](dictionaries/20_web.xml)**<br/>mandatory<br/>**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.<br/>Time in seconds.<br/>**Default:** 300 |
| **[general.apache.apache_keepalive](dictionaries/20_web.xml)**<br/>mandatory<br/>**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.<br/>**Default:** True | | **[general.apache.apache_keepalive](dictionaries/20_web.xml)**<br/>mandatory<br/>**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.<br/>**Default:** True |
## Dependances ## 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 ## Used by
[nextcloud](../nextcloud/README.md) [nextcloud](../nextcloud/README.md)
[All applications services for this dataset.](../README.md)

6
seed/apache/dictionaries/20_web.xml
View file

@ -15,11 +15,11 @@
<value>apache</value> <value>apache</value>
</variable> </variable>
</family> </family>
<family name="apache" description="Apache" help="Paramètrage avancé du serveur web Apache"> <family name="apache" description="Apache" help="Advance Apache web server settings" mode="expert">
<variable name="apache_timeout" type="number" description="Temps d'attente des entrées/sorties avant de considérer qu'une requête a échoué" help="Temps en secondes" mode="expert"> <variable name="apache_timeout" type="number" description="Amount of time the server will wait for certain events before failing a request" help="Time in seconds">
<value>300</value> <value>300</value>
</variable> </variable>
<variable name="apache_keepalive" type="boolean" description="Autoriser les connexions persistantes" mode="expert"/> <variable name="apache_keepalive" type="boolean" description="Enables HTTP persistent connections" mode="expert"/>
</family> </family>
</variables> </variables>
</rougail> </rougail>

23
seed/base-debian-bullseye/README.md
View file

@ -3,29 +3,28 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# base-debian-bullseye # base-debian-bullseye
## Synopsis ## 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 ## Dependances
- [base-debian](../base-debian/README.md) - [base-debian](../base-debian/README.md): Base information of a Debian server.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
## Used by ## Used by
- [odoo](../odoo/README.md) - [odoo](../odoo/README.md)
- [mailman](../mailman/README.md) - [mailman](../mailman/README.md)
- [lemonldap](../lemonldap/README.md) - [lemonldap](../lemonldap/README.md)
[All applications services for this dataset.](../README.md)

21
seed/base-debian/README.md
View file

@ -3,26 +3,25 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# base-debian # base-debian
## Synopsis ## 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 ## Dependances
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
## Used by ## Used by
[base-debian-bullseye](../base-debian-bullseye/README.md) [base-debian-bullseye](../base-debian-bullseye/README.md)
[All applications services for this dataset.](../README.md)

23
seed/base-fedora-35/README.md
View file

@ -3,27 +3,26 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# base-fedora-35 # base-fedora-35
## Synopsis ## Synopsis
Base information of a Fedora 35.
[Software's website.](https://getfedora.org/) [Base information of a Fedora 35.](https://getfedora.org/)
## Dependances ## Dependances
- [base-fedora](../base-fedora/README.md) - [base-fedora](../base-fedora/README.md): Base information of a Fedora.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
## Used by ## Used by
[postfix-relay](../postfix-relay/README.md) [postfix-relay](../postfix-relay/README.md)
[All applications services for this dataset.](../README.md)

23
seed/base-fedora-36/README.md
View file

@ -3,24 +3,25 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# base-fedora-36 # base-fedora-36
## Synopsis ## Synopsis
Base information of a Fedora 36.
[Software's website.](https://getfedora.org/) [Base information of a Fedora 36.](https://getfedora.org/)
## Dependances ## Dependances
- [base-fedora](../base-fedora/README.md) - [base-fedora](../base-fedora/README.md): Base information of a Fedora.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
## Used by ## Used by
@ -32,5 +33,3 @@ Base information of a Fedora 36.
- [vaultwarden](../vaultwarden/README.md) - [vaultwarden](../vaultwarden/README.md)
- [mariadb](../mariadb/README.md) - [mariadb](../mariadb/README.md)
- [nextcloud](../nextcloud/README.md) - [nextcloud](../nextcloud/README.md)
[All applications services for this dataset.](../README.md)

23
seed/base-fedora-37/README.md
View file

@ -3,24 +3,25 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# base-fedora-37 # base-fedora-37
## Synopsis ## Synopsis
Base information of a Fedora 37.
[Software's website.](https://getfedora.org/) [Base information of a Fedora 37.](https://getfedora.org/)
## Dependances ## Dependances
- [base-fedora](../base-fedora/README.md) - [base-fedora](../base-fedora/README.md): Base information of a Fedora.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
## Used by ## Used by
@ -30,5 +31,3 @@ Base information of a Fedora 37.
- [nsd](../nsd/README.md) - [nsd](../nsd/README.md)
- [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) - [nginx-reverse-proxy](../nginx-reverse-proxy/README.md)
- [openldap](../openldap/README.md) - [openldap](../openldap/README.md)
[All applications services for this dataset.](../README.md)

23
seed/base-fedora-38/README.md
View file

@ -3,24 +3,25 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# base-fedora-38 # base-fedora-38
## Synopsis ## Synopsis
Base information of a Fedora 38.
[Software's website.](https://getfedora.org/) [Base information of a Fedora 38.](https://getfedora.org/)
## Dependances ## Dependances
- [base-fedora](../base-fedora/README.md) - [base-fedora](../base-fedora/README.md): Base information of a Fedora.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
## Used by ## Used by
@ -31,5 +32,3 @@ Base information of a Fedora 38.
- [loki](../loki/README.md) - [loki](../loki/README.md)
- [forgejo](../forgejo/README.md) - [forgejo](../forgejo/README.md)
- [prometheus](../prometheus/README.md) - [prometheus](../prometheus/README.md)
[All applications services for this dataset.](../README.md)

21
seed/base-fedora/README.md
View file

@ -3,23 +3,24 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# base-fedora # base-fedora
## Synopsis ## Synopsis
Base information of a Fedora.
[Software's website.](https://getfedora.org/) [Base information of a Fedora.](https://getfedora.org/)
## Dependances ## Dependances
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
## Used by ## Used by
@ -27,5 +28,3 @@ Base information of a Fedora.
- [base-fedora-35](../base-fedora-35/README.md) - [base-fedora-35](../base-fedora-35/README.md)
- [base-fedora-38](../base-fedora-38/README.md) - [base-fedora-38](../base-fedora-38/README.md)
- [base-fedora-37](../base-fedora-37/README.md) - [base-fedora-37](../base-fedora-37/README.md)
[All applications services for this dataset.](../README.md)

10
seed/base-machine/README.md
View file

@ -3,6 +3,8 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# base-machine # base-machine
## Synopsis ## Synopsis
@ -21,12 +23,10 @@ Base information for a machine.
## Dependances ## Dependances
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
## Used by ## Used by
[systemd](../systemd/README.md) [systemd](../systemd/README.md)
[All applications services for this dataset.](../README.md)

4
seed/base/README.md
View file

@ -3,6 +3,8 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# base # base
## Synopsis ## Synopsis
@ -13,5 +15,3 @@ Base of all application services.
- [host-systemd-machined](../host-systemd-machined/README.md) - [host-systemd-machined](../host-systemd-machined/README.md)
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md)
[All applications services for this dataset.](../README.md)

4
seed/base/dictionaries/00_base.xml
View file

@ -1,8 +1,10 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<rougail version="0.10"> <rougail version="0.10">
<variables> <variables>
<!--variable name="providers" hidden="True"/-->
<variable name="copy_tests" type="boolean" mandatory="True" hidden="True"/> <variable name="copy_tests" type="boolean" mandatory="True" hidden="True"/>
<family name="base">
<variable name="time_zone" supplier="Host:time_zone" hidden="True"/>
</family>
</variables> </variables>
<constraints> <constraints>
<fill name="calc_value"> <fill name="calc_value">

20
seed/dns-external/README.md
View file

@ -3,33 +3,17 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# dns-external # dns-external
## Synopsis ## Synopsis
DNS client with resolution on all zones (especially outside). 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)**<br/>mandatory<br/>**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 ## Used by
- [postfix-relay](../postfix-relay/README.md) - [postfix-relay](../postfix-relay/README.md)
- [peertube](../peertube/README.md) - [peertube](../peertube/README.md)
- [unbound](../unbound/README.md) - [unbound](../unbound/README.md)
- [znc](../znc/README.md) - [znc](../znc/README.md)
## Provider
[unbound](../unbound/README.md)
[All applications services for this dataset.](../README.md)

4
seed/dns-external/dictionaries/14_dns-external.xml
View file

@ -2,10 +2,10 @@
<rougail version="0.10"> <rougail version="0.10">
<variables> <variables>
<family name="network"> <family name="network">
<variable name="dns_is_only_local" redefine="True"> <variable name="dns_is_only_local" redefine="True" hidden="True">
<value>False</value> <value>False</value>
</variable> </variable>
<variable name="dns_client_address" redefine="True" supplier="ExternalDNS"/> <variable name="dns_client_address" redefine="True" supplier="ExternalDNS" hidden="True"/>
</family> </family>
</variables> </variables>
</rougail> </rougail>

8
seed/dns-local/README.md
View file

@ -3,6 +3,8 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# dns-local # dns-local
## Synopsis ## Synopsis
@ -12,9 +14,3 @@ DNS client with access to local zones.
## Used by ## Used by
[base-machine](../base-machine/README.md) [base-machine](../base-machine/README.md)
## Provider
[nsd-local](../nsd-local/README.md)
[All applications services for this dataset.](../README.md)

157
seed/dovecot/README.md
View file

@ -3,73 +3,16 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# dovecot # dovecot
## Synopsis ## Synopsis
Postfix and Dovecot as mail servers (Submission and IMAP).
[Software's website.](https://www.dovecot.org/) [Postfix and Dovecot as mail servers (IMAP and submission).](https://www.dovecot.org/)
## Basic variables 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.
### Général
#### Mail configuration
##### Mail domain
This family is a leadership.
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
| **[general.mail.domain.mail_domains](dictionaries/31_dovecot.xml)**<br/>mandatory, multiple<br/>**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.<br/>**Example:** example.net |
| **[general.mail.domain.imap_domainname](dictionaries/31_dovecot.xml)**<br/>mandatory<br/>**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.<br/>**Example:** imap.example.net |
| **[general.mail.domain.submission_domainname](dictionaries/31_dovecot.xml)**<br/>mandatory<br/>**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.<br/>**Example:** submission.example.net |
## Variables
### Général
#### Mail configuration
##### Mail domain
This family is a leadership.
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.mail.mail_crt_provider](dictionaries/31_dovecot.xml)**<br/>mandatory<br/>**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.<br/>**Choices:**<br/>- `self-signed` ← default<br/>- `letsencrypt` |
## Variables for expert
### Général
#### Annuaire OpenLDAP
##### Client
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
| **[general.ldap.client.ldapclient_family](dictionaries/31_dovecot.xml)**<br/>mandatory<br/>**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.<br/>**Default:** all |
| **[general.ldap.client.ldapclient_base_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
| **[general.ldap.client.ldapclient_search_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
| **[general.ldap.client.ldapclient_group_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
| **[general.ldap.client.ldapclient_user_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
## Requirements services
- **LocalDNS**
- Journald
- **SMTP**
- **LDAP**
- **ReverseProxy**
- **LMTP**
- **OAuth2**
**bold**: provider is mandatory
## Example ## Example
@ -82,10 +25,9 @@ dovecot:
zones_name: zones_name:
- ldap - ldap
- localdns - localdns
- oauth2
- reverseproxy - reverseproxy
- smtp - smtp
- lmtp
- oauth2
values: values:
general.mail.domain.mail_domains: general.mail.domain.mail_domains:
- example.net - example.net
@ -95,27 +37,76 @@ dovecot:
'0': submission.example.net '0': submission.example.net
``` ```
## Basic variables
### General
#### Mail configuration
Configure IMAP servers and submission to access email accounts and send emails.
##### Mail domain
This family is a leadership.
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.mail.domain.mail_domains](dictionaries/31_dovecot.xml)**<br/>mandatory, multiple<br/>**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.<br/>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).<br/>**Example:** example.net |
| **[general.mail.domain.imap_domainname](dictionaries/31_dovecot.xml)**<br/>mandatory<br/>**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.<br/>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*.".<br/>**Example:** imap.example.net |
| **[general.mail.domain.submission_domainname](dictionaries/31_dovecot.xml)**<br/>mandatory<br/>**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.<br/>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*.".<br/>**Example:** submission.example.net |
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.mail.mail_crt_provider](dictionaries/31_dovecot.xml)**<br/>mandatory<br/>**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.<br/>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).<br/>**Choices:**<br/>- `self-signed` ← default<br/>- `letsencrypt` |
## Variables
### General
#### OpenLDAP directory
##### Client
| Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
| **[general.ldap.client.ldapclient_family](dictionaries/31_dovecot.xml)**<br/>mandatory<br/>**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.<br/>"all" for all families.<br/>**Default:** all |
## Requirements services
### Mandatories
- [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name.
- [SMTP](../README.SMTP.md): Create a SMTP relay account and authorize sending email.
- [LDAP](../README.LDAP.md): Create account and connexion to a LDAP server.
- [ReverseProxy](../README.ReverseProxy.md): Register to service to a reverse proxy server.
- [OAuth2](../README.OAuth2.md): Remote clients needing to verify OAuth2 account.
### Optionals
- [Journald](../README.Journald.md): Concentrate journal messages on one host.
## Dependances ## Dependances
- [base-fedora-36](../base-fedora-36/README.md) - [base-fedora-36](../base-fedora-36/README.md): Base information of a Fedora 36.
- [base-fedora](../base-fedora/README.md) - [base-fedora](../base-fedora/README.md): Base information of a Fedora.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
- [relay-lmtp-client](../relay-lmtp-client/README.md) - [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) - [relay-mail-client](../relay-mail-client/README.md): Client SMTP.
- [ldap-client](../ldap-client/README.md) - [ldap-client](../ldap-client/README.md): Application service needs interact with a LDAP server.
- [oauth2-client](../oauth2-client/README.md) - [oauth2-client](../oauth2-client/README.md): Application service needs interact with a Oauth2 server.
- [nginx-https](../nginx-https/README.md) - [nginx-https](../nginx-https/README.md): Nginx as HTTPS web site.
- [nginx-common](../nginx-common/README.md) - [nginx-common](../nginx-common/README.md): Nginx common configuration.
- [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.
## Supplier ## Useful for service
[imap-client](../imap-client/README.md) [roundcube](../roundcube/README.md): Roundcube, a webmail.
[All applications services for this dataset.](../README.md)

3
seed/dovecot/applicationservice.yml
View file

@ -1,5 +1,6 @@
format: '0.1' 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/ website: https://www.dovecot.org/
depends: depends:
- base-fedora-36 - base-fedora-36

12
seed/dovecot/dictionaries/31_dovecot.xml
View file

@ -63,21 +63,21 @@
</variable> </variable>
</family> </family>
</family> </family>
<family name="mail" description="Mail configuration"> <family name="mail" description="Mail configuration" help="Configure IMAP servers and submission to access email accounts and send emails">
<family name="domain" description="Mail domain" leadership="True"> <family name="domain" description="Mail domain" leadership="True">
<variable name="mail_domains" type="domainname" description="Domaine de courriel géré localement" mandatory="True" multi="True" supplier="LMTP:criteria" test="example.net"/> <variable name="mail_domains" type="domainname" description="Final destination email address" mandatory="True" multi="True" supplier="LMTP:criteria" test="example.net" help="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)"/>
<variable name="mail_domains_calc" type="domainname" hidden="True"/> <variable name="mail_domains_calc" type="domainname" hidden="True"/>
<variable name="imap_domainname" type="domainname" description="Domaine exterieur d'accès au serveur IMAP" mandatory="True" test="imap.example.net"/> <variable name="imap_domainname" type="domainname" description="External IMAP server address" mandatory="True" test="imap.example.net" help='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*."'/>
<variable name="submission_domainname" type="domainname" description="Domaine exterieur d'accès au serveur submission" mandatory="True" test="submission.example.net"/> <variable name="submission_domainname" type="domainname" description="External submission server address" mandatory="True" test="submission.example.net" help='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*."'/>
</family> </family>
<variable name="mail_crt_provider" type="choice" description="Autorité de certification signant les certificats des domaines extérieurs" mandatory="True"> <variable name="mail_crt_provider" type="choice" description="Type of certificate autority signing external IMAP and submission domain certificates" mandatory="True" mode="basic" help="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)">
<value>self-signed</value> <value>self-signed</value>
<choice>self-signed</choice> <choice>self-signed</choice>
<choice>letsencrypt</choice> <choice>letsencrypt</choice>
</variable> </variable>
</family> </family>
<family name="dovecot" description="IMAP mail server"> <family name="dovecot" description="IMAP mail server">
<variable name="imap_internal_addresses" type="domainname" description="IMAP client address" mandatory="True" provider="IMAP" multi="True"/> <variable name="imap_internal_addresses" type="domainname" description="IMAP server connexion" mandatory="True" provider="IMAP" multi="True" hidden="True"/>
<variable name="well_known_filenames" type="filename" hidden='True' multi="True"/> <variable name="well_known_filenames" type="filename" hidden='True' multi="True"/>
</family> </family>
<family name="revprox"> <family name="revprox">

2
seed/dovecot/templates/config-v1.1.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0"?> <?xml version="1.0"?>
# GNUNUX: from https://wiki.mozilla.org/Thunderbird:Autoconfiguration:ConfigFileFormat --> <!-- GNUNUX: from https://wiki.mozilla.org/Thunderbird:Autoconfiguration:ConfigFileFormat -->
{%set domain = rougail_variable %} {%set domain = rougail_variable %}
{%set leader = general.mail.domain.mail_domains[mail_domains.index(domain)] %} {%set leader = general.mail.domain.mail_domains[mail_domains.index(domain)] %}
{%set imap_domain = leader.imap_domainname %} {%set imap_domain = leader.imap_domainname %}

137
seed/forgejo/README.md
View file

@ -3,28 +3,49 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# forgejo # forgejo
## Synopsis ## Synopsis
Forgejo, a community managed lightweight code hosting solution.
[Software's website.](https://forgejo.org/) [Forgejo, a community managed lightweight code hosting solution.](https://forgejo.org/)
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
```
forgejo:
applicationservice: forgejo
zones_name:
- localdns
- oauth2
- postgresql
- redis
- reverseproxy
- smtp
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
general.forgejo.forgejo_mail_sender: admin@example.net
```
## Basic variables ## Basic variables
### Général ### General
#### Reverse proxy #### Reverse proxy
##### Point d'entrée des clients ##### Clients configuration
This family is a leadership. This family is a leadership.
| Parameter | Comments | | Parameter | Comment |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**<br/>mandatory, multiple<br/>**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.<br/>**Example:** service.example.net | | **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**<br/>mandatory, multiple<br/>**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.<br/>**Example:** service.example.net |
| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**<br/>mandatory<br/>**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. | | **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** / |
#### Forgejo #### Forgejo
@ -35,39 +56,23 @@ Git forge Forgejo.
| **[general.forgejo.forgejo_title](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Titre de la forge.<br/>**Default:** Forgejo : Au-delà du développement. Nous forgeons. | | **[general.forgejo.forgejo_title](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Titre de la forge.<br/>**Default:** Forgejo : Au-delà du développement. Nous forgeons. |
| **[general.forgejo.forgejo_mail_sender](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Les courriels sont envoyés à partir de cet adresse.<br/>**Example:** admin@example.net | | **[general.forgejo.forgejo_mail_sender](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Les courriels sont envoyés à partir de cet adresse.<br/>**Example:** admin@example.net |
## Variables
## Variables for expert ### General
### Général
#### Reverse proxy #### Reverse proxy
##### Point d'entrée des clients ##### Clients configuration
This family is a leadership. This family is a leadership.
| Parameter | Comments | | Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**<br/>**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. | | **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**<br/>**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. |
#### PostgreSQL
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|
| **[general.postgresql.pg_client_username](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client username.<br/>**Default:** *calculated* |
| **[general.postgresql.pg_client_password](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client password.<br/>**Default:** *calculated* |
| **[general.postgresql.pg_client_database](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client database.<br/>**Default:** *calculated* |
#### Redis
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|
| **[general.redis.redis_client_username](dictionaries/23_redis.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom d'utilisateur.<br/>**Default:** *calculated* |
| **[general.redis.redis_client_password](dictionaries/23_redis.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
#### OAuth2 client #### OAuth2 client
| Parameter | Comments | | Parameter | Comment |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------| |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| **[general.oauth2_client.oauth2_client_name](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.<br/>**Default:** Forge<br/>**Example:** example | | **[general.oauth2_client.oauth2_client_name](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.<br/>**Default:** Forge<br/>**Example:** example |
| **[general.oauth2_client.oauth2_client_description](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.<br/>**Default:** Forge logiciel Forgejo<br/>**Example:** Example description | | **[general.oauth2_client.oauth2_client_description](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.<br/>**Default:** Forge logiciel Forgejo<br/>**Example:** Example description |
@ -80,65 +85,47 @@ This family is a leadership.
| **[general.oauth2_client.external.oauth2_client_external](dictionaries/31_forgejo.xml)**<br/>mandatory, multiple<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client external.<br/>**Default:** *calculated* | | **[general.oauth2_client.external.oauth2_client_external](dictionaries/31_forgejo.xml)**<br/>mandatory, multiple<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client external.<br/>**Default:** *calculated* |
| **[general.oauth2_client.external.oauth2_client_family](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 family.<br/>**Default:** users | | **[general.oauth2_client.external.oauth2_client_family](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 family.<br/>**Default:** users |
| Parameter | Comments | | Parameter | Comment |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|
| **[general.oauth2_client.oauth2_client_category](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.<br/>**Default:** Développement | | **[general.oauth2_client.oauth2_client_category](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.<br/>**Default:** Développement |
| **[general.oauth2_client.oauth2_client_logo](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.<br/>**Default:** silique_note.png | | **[general.oauth2_client.oauth2_client_logo](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.<br/>**Default:** silique_note.png |
## Requirements services ## Requirements services
- **LocalDNS** ### Mandatories
- Journald
- **SMTP**
- **ReverseProxy**
- **Postgresql**
- **Redis**
- **OAuth2**
**bold**: provider is mandatory - [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name.
- [SMTP](../README.SMTP.md): Create a SMTP relay account and authorize sending email.
- [ReverseProxy](../README.ReverseProxy.md): Register to service to a reverse proxy server.
- [Postgresql](../README.Postgresql.md): Create account and connexion to a PostgreSQL server.
- [OAuth2](../README.OAuth2.md): Remote clients needing to verify OAuth2 account.
- [Redis](../README.Redis.md): Create account and connexion to a Redis server.
## Example ### Optionals
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. - [Journald](../README.Journald.md): Concentrate journal messages on one host.
```
forgejo:
applicationservice: forgejo
zones_name:
- localdns
- reverseproxy
- smtp
- redis
- oauth2
- postgresql
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
general.forgejo.forgejo_mail_sender: admin@example.net
```
## Dependances ## Dependances
- [base-fedora-38](../base-fedora-38/README.md) - [base-fedora-38](../base-fedora-38/README.md): Base information of a Fedora 38.
- [base-fedora](../base-fedora/README.md) - [base-fedora](../base-fedora/README.md): Base information of a Fedora.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
- [postgresql-client](../postgresql-client/README.md) - [postgresql-client](../postgresql-client/README.md): Application service needs interact with a Postgresql server.
- [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.
- [relay-mail-client](../relay-mail-client/README.md) - [relay-mail-client](../relay-mail-client/README.md): Client SMTP.
- [redis-client](../redis-client/README.md) - [redis-client](../redis-client/README.md): Application service needs interact with a Redis server.
- [redis-common](../redis-common/README.md) - [redis-common](../redis-common/README.md): Redis, an in-memory data structure store.
- [oauth2-client](../oauth2-client/README.md) - [oauth2-client](../oauth2-client/README.md): Application service needs interact with a Oauth2 server.
## Used by ## Used by
[gitea](../gitea/README.md) [gitea](../gitea/README.md)
[All applications services for this dataset.](../README.md)

163
seed/gitea/README.md
View file

@ -3,32 +3,53 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# gitea # gitea
## Synopsis ## Synopsis
Transitional package for Gitea to Forgejo. Transitional package for Gitea to Forgejo.
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
```
gitea:
applicationservice: gitea
zones_name:
- localdns
- oauth2
- postgresql
- redis
- reverseproxy
- smtp
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
```
## Basic variables ## Basic variables
### Général ### General
#### Reverse proxy #### Reverse proxy
##### Point d'entrée des clients ##### Clients configuration
This family is a leadership. This family is a leadership.
| Parameter | Comments | | Parameter | Comment |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**<br/>mandatory, multiple<br/>**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.<br/>**Example:** service.example.net | | **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**<br/>mandatory, multiple<br/>**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.<br/>**Example:** service.example.net |
| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**<br/>mandatory<br/>**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. | | **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** / |
#### Forgejo #### Forgejo
Git forge Forgejo. Git forge Forgejo.
| Parameter | Comments | | Parameter | Comment |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------| |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|
| **[general.forgejo.forgejo_title](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Titre de la forge.<br/>**Default:** Forgejo : Au-delà du développement. Nous forgeons. | | **[general.forgejo.forgejo_title](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Titre de la forge.<br/>**Default:** Forgejo : Au-delà du développement. Nous forgeons. |
@ -36,54 +57,21 @@ Git forge Forgejo.
## Variables ## Variables
### Général ### General
#### Forgejo
Git forge Forgejo.
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|
| **[general.forgejo.forgejo_mail_sender](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Les courriels sont envoyés à partir de cet adresse.<br/>**Default:** *calculated*<br/>**Example:** admin@example.net |
#### Transitional family
| Parameter | Comments |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------|
| **[general.gitea.gitea_mail_sender](dictionaries/32_gitea.xml)**<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Transitional variable, please do not use it. |
## Variables for expert
### Général
#### Reverse proxy #### Reverse proxy
##### Point d'entrée des clients ##### Clients configuration
This family is a leadership. This family is a leadership.
| Parameter | Comments | | Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**<br/>**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. | | **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**<br/>**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. |
#### PostgreSQL
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|
| **[general.postgresql.pg_client_username](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client username.<br/>**Default:** *calculated* |
| **[general.postgresql.pg_client_password](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client password.<br/>**Default:** *calculated* |
| **[general.postgresql.pg_client_database](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client database.<br/>**Default:** *calculated* |
#### Redis
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|
| **[general.redis.redis_client_username](dictionaries/23_redis.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom d'utilisateur.<br/>**Default:** *calculated* |
| **[general.redis.redis_client_password](dictionaries/23_redis.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
#### OAuth2 client #### OAuth2 client
| Parameter | Comments | | Parameter | Comment |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------| |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| **[general.oauth2_client.oauth2_client_name](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.<br/>**Default:** Forge<br/>**Example:** example | | **[general.oauth2_client.oauth2_client_name](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.<br/>**Default:** Forge<br/>**Example:** example |
| **[general.oauth2_client.oauth2_client_description](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.<br/>**Default:** Forge logiciel Forgejo<br/>**Example:** Example description | | **[general.oauth2_client.oauth2_client_description](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.<br/>**Default:** Forge logiciel Forgejo<br/>**Example:** Example description |
@ -96,61 +84,56 @@ This family is a leadership.
| **[general.oauth2_client.external.oauth2_client_external](dictionaries/31_forgejo.xml)**<br/>mandatory, multiple<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client external.<br/>**Default:** *calculated* | | **[general.oauth2_client.external.oauth2_client_external](dictionaries/31_forgejo.xml)**<br/>mandatory, multiple<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client external.<br/>**Default:** *calculated* |
| **[general.oauth2_client.external.oauth2_client_family](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 family.<br/>**Default:** users | | **[general.oauth2_client.external.oauth2_client_family](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 family.<br/>**Default:** users |
| Parameter | Comments | | Parameter | Comment |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|
| **[general.oauth2_client.oauth2_client_category](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.<br/>**Default:** Développement | | **[general.oauth2_client.oauth2_client_category](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.<br/>**Default:** Développement |
| **[general.oauth2_client.oauth2_client_logo](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.<br/>**Default:** silique_note.png | | **[general.oauth2_client.oauth2_client_logo](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.<br/>**Default:** silique_note.png |
#### Forgejo
Git forge Forgejo.
| Parameter | Comment |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|
| **[general.forgejo.forgejo_mail_sender](dictionaries/31_forgejo.xml)**<br/>mandatory<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Les courriels sont envoyés à partir de cet adresse.<br/>**Default:** *calculated*<br/>**Example:** admin@example.net |
#### Transitional family
| Parameter | Comments |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------|
| **[general.gitea.gitea_mail_sender](dictionaries/32_gitea.xml)**<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Transitional variable, please do not use it. |
## Requirements services ## Requirements services
- **LocalDNS** ### Mandatories
- Journald
- **SMTP**
- **ReverseProxy**
- **Postgresql**
- **Redis**
- **OAuth2**
**bold**: provider is mandatory - [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name.
- [SMTP](../README.SMTP.md): Create a SMTP relay account and authorize sending email.
- [ReverseProxy](../README.ReverseProxy.md): Register to service to a reverse proxy server.
- [Postgresql](../README.Postgresql.md): Create account and connexion to a PostgreSQL server.
- [OAuth2](../README.OAuth2.md): Remote clients needing to verify OAuth2 account.
- [Redis](../README.Redis.md): Create account and connexion to a Redis server.
## Example ### Optionals
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. - [Journald](../README.Journald.md): Concentrate journal messages on one host.
```
gitea:
applicationservice: gitea
zones_name:
- localdns
- reverseproxy
- smtp
- redis
- oauth2
- postgresql
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
```
## Dependances ## Dependances
- [forgejo](../forgejo/README.md) - [forgejo](../forgejo/README.md): Forgejo, a community managed lightweight code hosting solution.
- [base-fedora-38](../base-fedora-38/README.md) - [base-fedora-38](../base-fedora-38/README.md): Base information of a Fedora 38.
- [base-fedora](../base-fedora/README.md) - [base-fedora](../base-fedora/README.md): Base information of a Fedora.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
- [postgresql-client](../postgresql-client/README.md) - [postgresql-client](../postgresql-client/README.md): Application service needs interact with a Postgresql server.
- [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.
- [relay-mail-client](../relay-mail-client/README.md) - [relay-mail-client](../relay-mail-client/README.md): Client SMTP.
- [redis-client](../redis-client/README.md) - [redis-client](../redis-client/README.md): Application service needs interact with a Redis server.
- [redis-common](../redis-common/README.md) - [redis-common](../redis-common/README.md): Redis, an in-memory data structure store.
- [oauth2-client](../oauth2-client/README.md) - [oauth2-client](../oauth2-client/README.md): Application service needs interact with a Oauth2 server.
[All applications services for this dataset.](../README.md)

120
seed/grafana/README.md
View file

@ -3,28 +3,48 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# grafana # grafana
## Synopsis ## Synopsis
Grafana is an analytics and interactive visualization web application.
[Software's website.](https://grafana.com/) [Grafana is an analytics and interactive visualization web application.](https://grafana.com/)
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
```
grafana:
applicationservice: grafana
zones_name:
- localdns
- oauth2
- postgresql
- reverseproxy
- smtp
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
general.oauth2_client.oauth2_email_domain: example.net
```
## Basic variables ## Basic variables
### Général ### General
#### Reverse proxy #### Reverse proxy
##### Point d'entrée des clients ##### Clients configuration
This family is a leadership. This family is a leadership.
| Parameter | Comments | | Parameter | Comment |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**<br/>mandatory, multiple<br/>**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.<br/>**Example:** service.example.net | | **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**<br/>mandatory, multiple<br/>**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.<br/>**Example:** service.example.net |
| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**<br/>mandatory<br/>**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. | | **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** / |
#### OAuth2 client #### OAuth2 client
@ -34,32 +54,23 @@ This family is a leadership.
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------| |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| **[general.oauth2_client.oauth2_email_domain](dictionaries/31_grafana.xml)**<br/>mandatory<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Domain name allowed to log on Grafana.<br/>**Example:** example.net | | **[general.oauth2_client.oauth2_email_domain](dictionaries/31_grafana.xml)**<br/>mandatory<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Domain name allowed to log on Grafana.<br/>**Example:** example.net |
## Variables
## Variables for expert ### General
### Général
#### Reverse proxy #### Reverse proxy
##### Point d'entrée des clients ##### Clients configuration
This family is a leadership. This family is a leadership.
| Parameter | Comments | | Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**<br/>**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. | | **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**<br/>**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. |
#### PostgreSQL
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|
| **[general.postgresql.pg_client_username](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client username.<br/>**Default:** *calculated* |
| **[general.postgresql.pg_client_password](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client password.<br/>**Default:** *calculated* |
| **[general.postgresql.pg_client_database](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client database.<br/>**Default:** *calculated* |
#### OAuth2 client #### OAuth2 client
| Parameter | Comments | | Parameter | Comment |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------| |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|
| **[general.oauth2_client.oauth2_client_name](dictionaries/31_grafana.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.<br/>**Default:** Grafana<br/>**Example:** example | | **[general.oauth2_client.oauth2_client_name](dictionaries/31_grafana.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.<br/>**Default:** Grafana<br/>**Example:** example |
| **[general.oauth2_client.oauth2_client_description](dictionaries/31_grafana.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.<br/>**Default:** Visualisation de données<br/>**Example:** Example description | | **[general.oauth2_client.oauth2_client_description](dictionaries/31_grafana.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.<br/>**Default:** Visualisation de données<br/>**Example:** Example description |
@ -77,50 +88,33 @@ This family is a leadership.
| **[general.oauth2_client.oauth2_client_category](dictionaries/31_grafana.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.<br/>**Default:** Administration | | **[general.oauth2_client.oauth2_client_category](dictionaries/31_grafana.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.<br/>**Default:** Administration |
| **[general.oauth2_client.oauth2_client_logo](dictionaries/31_grafana.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.<br/>**Default:** silique_note.png | | **[general.oauth2_client.oauth2_client_logo](dictionaries/31_grafana.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.<br/>**Default:** silique_note.png |
## Requirements services ## Requirements services
- **LocalDNS** ### Mandatories
- Journald
- **SMTP**
- **ReverseProxy**
- **Postgresql**
- **OAuth2**
**bold**: provider is mandatory - [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name.
- [SMTP](../README.SMTP.md): Create a SMTP relay account and authorize sending email.
- [ReverseProxy](../README.ReverseProxy.md): Register to service to a reverse proxy server.
- [Postgresql](../README.Postgresql.md): Create account and connexion to a PostgreSQL server.
- [OAuth2](../README.OAuth2.md): Remote clients needing to verify OAuth2 account.
## Example ### Optionals
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. - [Journald](../README.Journald.md): Concentrate journal messages on one host.
```
grafana:
applicationservice: grafana
zones_name:
- localdns
- reverseproxy
- smtp
- oauth2
- postgresql
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
general.oauth2_client.oauth2_email_domain: example.net
```
## Dependances ## Dependances
- [base-fedora-38](../base-fedora-38/README.md) - [base-fedora-38](../base-fedora-38/README.md): Base information of a Fedora 38.
- [base-fedora](../base-fedora/README.md) - [base-fedora](../base-fedora/README.md): Base information of a Fedora.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
- [postgresql-client](../postgresql-client/README.md) - [postgresql-client](../postgresql-client/README.md): Application service needs interact with a Postgresql server.
- [oauth2-client](../oauth2-client/README.md) - [oauth2-client](../oauth2-client/README.md): Application service needs interact with a Oauth2 server.
- [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.
- [relay-mail-client](../relay-mail-client/README.md) - [relay-mail-client](../relay-mail-client/README.md): Client SMTP.
[All applications services for this dataset.](../README.md)

38
seed/host-systemd-machined/README.md
View file

@ -3,21 +3,22 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# host-systemd-machined # host-systemd-machined
## Synopsis ## 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 ## Basic variables
### Général ### General
#### network #### network
| Parameter | Comments | | Parameter | Comment |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|
| **[general.network.output_interface](dictionaries/21_machined.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de l'interface de sortie. | | **[general.network.output_interface](dictionaries/21_machined.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de l'interface de sortie. |
@ -34,34 +35,29 @@ This family is a leadership.
## Variables ## Variables
### Général ### General
| Parameter | Comments | | Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------| |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|
| **[general.vm_swappiness](dictionaries/21_machined.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Ajustement de la mémoire virtuelle.<br/>**Default:** 60 | | **[general.vm_swappiness](dictionaries/21_machined.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Ajustement de la mémoire virtuelle.<br/>**Default:** 60 |
#### base
| Parameter | Comment |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|
| **[general.base.time_zone](dictionaries/21_machined.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Time zone.<br/>**Default:** Europe/Paris |
#### network #### network
##### interfaces ##### interfaces
This family is a leadership. This family is a leadership.
| Parameter | Comments | | Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------|
| **[general.network.interfaces.interface_type](dictionaries/21_machined.xml)**<br/>mandatory<br/>**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.<br/>**Choices:**<br/>- `dhcp`<br/>- `ipv4` | | **[general.network.interfaces.interface_type](dictionaries/21_machined.xml)**<br/>mandatory<br/>**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.<br/>**Choices:**<br/>- `dhcp` ← default<br/>- `ipv4` |
## Dependances ## Dependances
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
## 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)

9
seed/host-systemd-machined/dictionaries/21_machined.xml
View file

@ -33,10 +33,10 @@
</service> </service>
</services> </services>
<variables> <variables>
<variable name="host_install_dir" type="filename" description="Nom du répertoire comprenant les descriptions d'installation" mandatory="True" provider="global:host_install_dir"/> <variable name="host_install_dir" type="filename" mandatory="True" provider="global:host_install_dir" hidden="True"/>
<variable name="host_name" type="domainname" hidden="True" provider="global:server_name" mandatory="True"/> <variable name="host_name" type="domainname" hidden="True" provider="global:server_name" mandatory="True"/>
<variable name="module_name" type="string" hidden="True" provider="global:module_name" mandatory="True"/> <variable name="module_name" type="string" hidden="True" provider="global:module_name" mandatory="True"/>
<variable name="tls_server" type="domainname" description="tls domaine name" mandatory="True" provider="global:tls_server"/> <variable name="tls_server" type="domainname" mandatory="True" provider="global:tls_server" hidden="True"/>
<variable name="systemd_zone_filename" type="filename" hidden="True" multi="True"/> <variable name="systemd_zone_filename" type="filename" hidden="True" multi="True"/>
<variable name="systemd_netzone_filename" type="filename" hidden="True" multi="True"/> <variable name="systemd_netzone_filename" type="filename" hidden="True" multi="True"/>
<variable name="vm_swappiness" type="number" description="Ajustement de la mémoire virtuelle" mandatory="True"> <variable name="vm_swappiness" type="number" description="Ajustement de la mémoire virtuelle" mandatory="True">
@ -73,6 +73,11 @@
<variable name="host_removed_packages" multi="True" hidden="True"> <variable name="host_removed_packages" multi="True" hidden="True">
<value>resolvconf</value> <value>resolvconf</value>
</variable> </variable>
<family name="base">
<variable name="time_zone" type="string" description="Time zone" provider="Host:time_zone">
<value>Europe/Paris</value>
</variable>
</family>
<family name="network"> <family name="network">
<variable name="output_interface" description="Nom de l'interface de sortie" mandatory="True"/> <variable name="output_interface" description="Nom de l'interface de sortie" mandatory="True"/>
<family name="interfaces" leadership="True"> <family name="interfaces" leadership="True">

2
seed/host-systemd-machined/extras/machined/00_machined.xml
View file

@ -9,7 +9,7 @@
</service> </service>
</services> </services>
<variables> <variables>
<variable name="machines" description="Machines started in this host" type="domainname" multi="True" provider="Host"/> <variable name="machines" description="Machines started in this host" type="domainname" multi="True" provider="Host" hidden="True"/>
<family name="machine_" description="Machine " dynamic="machined.machines"> <family name="machine_" description="Machine " dynamic="machined.machines">
<variable name="incoming_ports_" description="Incomming external ports for " hidden="True" type="port" multi="True" provider="Host:incoming_ports"/> <variable name="incoming_ports_" description="Incomming external ports for " hidden="True" type="port" multi="True" provider="Host:incoming_ports"/>
<variable name="outgoing_ports_" description="Outcoming external ports for " hidden="True" type="port" multi="True" provider="Host:outgoing_ports"/> <variable name="outgoing_ports_" description="Outcoming external ports for " hidden="True" type="port" multi="True" provider="Host:outgoing_ports"/>

8
seed/imap-client/README.md
View file

@ -3,6 +3,8 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# imap-client # imap-client
## Synopsis ## Synopsis
@ -12,9 +14,3 @@ Application service needs interact with an IMAP server.
## Used by ## Used by
[roundcube](../roundcube/README.md) [roundcube](../roundcube/README.md)
## Provider
[dovecot](../dovecot/README.md)
[All applications services for this dataset.](../README.md)

2
seed/imap-client/dictionaries/21_imap_client.xml
View file

@ -7,7 +7,7 @@
</services> </services>
<variables> <variables>
<family name="imap" description="Client SMTP"> <family name="imap" description="Client SMTP">
<variable name="imap_address" type="domainname" description="Nom de domaine du serveur IMAP" mandatory="True" supplier="IMAP"/> <variable name="imap_address" type="domainname" mandatory="True" supplier="IMAP" hidden="True"/>
<variable name="imap_cert_owner" type="unix_user" mandatory="True" hidden="True"> <variable name="imap_cert_owner" type="unix_user" mandatory="True" hidden="True">
<value>root</value> <value>root</value>
</variable> </variable>

11
seed/journald/README.md
View file

@ -3,20 +3,15 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# journald # journald
## Synopsis ## Synopsis
Journald.
[Software's website.](https://systemd.io/) [Journald.](https://systemd.io/)
## Used by ## Used by
[systemd](../systemd/README.md) [systemd](../systemd/README.md)
## Provider
[journald_remote](../journald_remote/README.md)
[All applications services for this dataset.](../README.md)

7
seed/journald/dictionaries/20_journald.xml
View file

@ -9,8 +9,7 @@
</services> </services>
<variables> <variables>
<family name="journald" description="systemd-journald"> <family name="journald" description="systemd-journald">
<variable name="journal_client_server_domainname" type="domainname" supplier="Journald"/> <variable name="journal_client_server_domainname" type="domainname" supplier="Journald" hidden="True"/>
<variable name="journal_host_name" type="domainname" supplier="Journald:host" hidden="True"/>
</family> </family>
</variables> </variables>
<constraints> <constraints>
@ -18,9 +17,5 @@
<param type="nil"/> <param type="nil"/>
<target type="servicelist">journald</target> <target type="servicelist">journald</target>
</condition> </condition>
<fill name="calc_value">
<param type="variable">domain_name_eth0</param>
<target>journal_host_name</target>
</fill>
</constraints> </constraints>
</rougail> </rougail>

11
seed/journald_remote/README.md
View file

@ -3,20 +3,15 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# journald_remote # journald_remote
## Synopsis ## Synopsis
Journald remote.
[Software's website.](https://systemd.io/) [Journald remote.](https://systemd.io/)
## Used by ## Used by
[vector](../vector/README.md) [vector](../vector/README.md)
## Supplier
[journald](../journald/README.md)
[All applications services for this dataset.](../README.md)

11
seed/journald_remote/extras/accounts/00_accounts.xml
View file

@ -1,12 +1,11 @@
<?xml version='1.0' encoding='UTF-8'?> <?xml version='1.0' encoding='UTF-8'?>
<rougail version="0.10"> <rougail version="0.10">
<variables> <variables>
<variable name="remotes" description="Remote journald" type="domainname" provider="Journald" mandatory="True" multi="True"/> <variable name="remotes" description="Concentrate journal messages on one host" type="domainname" provider="Journald" mandatory="True" multi="True" hidden="True"/>
<family name="remote_" description="Account for " dynamic="accounts.remotes"> <family name="remote_" description="Account for " dynamic="accounts.remotes" hidden="True">
<variable name="host_" description="Remote host" type="domainname" mandatory="True" provider="Journald:host"/> <variable name="services_" description="Log from this service to exclude for " multi="True" provider="Journald:service" unique="False"/>
<variable name="messages_" multi="True" provider="Journald:message" unique="False"/> <variable name="functions_" description="Function use to compare message (if not defined, exlude same message) for " multi="True" provider="Journald:function" mandatory="False" unique="False"/>
<variable name="services_" multi="True" provider="Journald:service" unique="False"/> <variable name="messages_" description="Message to exclude for " multi="True" provider="Journald:message" unique="False"/>
<variable name="functions_" multi="True" provider="Journald:function" mandatory="False" unique="False"/>
</family> </family>
<variable name="vector_conditions" hidden="True"/> <variable name="vector_conditions" hidden="True"/>
</variables> </variables>

26
seed/ldap-client/README.md
View file

@ -3,6 +3,8 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# ldap-client # ldap-client
## Synopsis ## Synopsis
@ -10,22 +12,18 @@ include_toc: true
Application service needs interact with a LDAP server. Application service needs interact with a LDAP server.
## Variables
## Variables for expert ### General
### Général #### OpenLDAP directory
#### Annuaire OpenLDAP
##### Client ##### Client
| Parameter | Comments | | Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------| |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|
| **[general.ldap.client.ldapclient_family](dictionaries/21_ldap-client.xml)**<br/>**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. | | **[general.ldap.client.ldapclient_family](dictionaries/21_ldap-client.xml)**<br/>**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.<br/>"all" for all families. |
| **[general.ldap.client.ldapclient_base_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
| **[general.ldap.client.ldapclient_search_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
| **[general.ldap.client.ldapclient_group_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
| **[general.ldap.client.ldapclient_user_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
## Used by ## Used by
@ -35,9 +33,3 @@ Application service needs interact with a LDAP server.
- [roundcube](../roundcube/README.md) - [roundcube](../roundcube/README.md)
- [nextcloud](../nextcloud/README.md) - [nextcloud](../nextcloud/README.md)
- [lemonldap](../lemonldap/README.md) - [lemonldap](../lemonldap/README.md)
## Provider
[openldap](../openldap/README.md)
[All applications services for this dataset.](../README.md)

26
seed/ldap-client/dictionaries/21_ldap-client.xml
View file

@ -7,28 +7,28 @@
</service> </service>
</services> </services>
<variables> <variables>
<family name="ldap" description="Annuaire OpenLDAP"> <family name="ldap" description="OpenLDAP directory">
<family name="server" description="Serveur"> <family name="server" description="Server">
<variable name='ldap_server_address' type='domainname' description="Nom DNS du serveur LDAP" mandatory='True' supplier="LDAP"/> <variable name='ldap_server_address' type='domainname' hidden="True" mandatory='True' supplier="LDAP"/>
<variable name="ldap_server_ip" type="ip" hidden="True"/> <variable name="ldap_server_ip" type="ip" hidden="True"/>
<variable name='ldap_port' type='port' description='Port du serveur LDAP' hidden="True"> <variable name='ldap_port' type='port' hidden="True">
<value>636</value> <value>636</value>
</variable> </variable>
<variable name='prefix_domain_name' hidden="True" mandatory="True" provider="global:prefix_domain_name"/> <variable name='prefix_domain_name' hidden="True" mandatory="True" provider="global:prefix_domain_name"/>
</family> </family>
<family name="client" description="Client"> <family name="client" description="Client">
<variable name='ldapclient_family' type='unix_user' description="Nom de la famille LDAP" supplier="LDAP:family"/> <variable name='ldapclient_family' type='unix_user' description="Restrict service configuration for a LDAP family" help='"all" for all families.' supplier="LDAP:family"/>
<variable name='ldapclient_user' type='string' description="DN de l'utilisateur LDAP" mandatory='False' hidden="True" supplier="LDAP:dn"/> <variable name='ldapclient_user' type='string' mandatory='False' hidden="True" supplier="LDAP:dn"/>
<variable name='ldapclient_address' hidden="True"/> <variable name='ldapclient_address' hidden="True"/>
<variable name='ldapclient_user_password' type='password' description="Mot de passe de l'utilisateur LDAP" mandatory='True' hidden="True" supplier="LDAP:password"/> <variable name='ldapclient_user_password' type='password' mandatory='True' hidden="True" supplier="LDAP:password"/>
<variable name='ldapclient_base_dn' type='string' description="Base DN de l'annuaire" mandatory="True" supplier="LDAP:base_dn" mode="expert"/> <variable name='ldapclient_base_dn' type='string' mandatory="True" supplier="LDAP:base_dn" hidden="True"/>
<variable name='ldapclient_search_dn' type='string' description="Base DN de l'annuaire des utilisateurs" mandatory="True" mode="expert"/> <variable name='ldapclient_search_dn' type='string' mandatory="True" hidden="True"/>
<variable name='ldapclient_group_dn' type='string' description="Base DN de l'annuaire des groupes" mandatory="True" mode="expert"/> <variable name='ldapclient_group_dn' type='string' mandatory="True" hidden="True"/>
<variable name='ldapclient_user_dn' type='string' description="Base DN de l'annuaire des utilisateurs n'appartenant à une famille" mandatory="True" mode="expert"/> <variable name='ldapclient_user_dn' type='string' mandatory="True" hidden="True"/>
<variable name="ldap_key_file_owner" type="unix_user" description="Propriétaire du fichier de la clef privée LDAP" hidden="True"> <variable name="ldap_key_file_owner" type="unix_user" hidden="True">
<value>root</value> <value>root</value>
</variable> </variable>
<variable name="ldap_client_file" type="filename" description="Nom du fichier du client LDAP" hidden="True"/> <variable name="ldap_client_file" type="filename" hidden="True"/>
</family> </family>
</family> </family>
</variables> </variables>

204
seed/lemonldap/README.md
View file

@ -3,90 +3,14 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# lemonldap # lemonldap
## Synopsis ## 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
### Général
#### Reverse proxy
##### Point d'entrée des clients
This family is a leadership.
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**<br/>mandatory, multiple<br/>**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.<br/>**Example:** service.example.net |
| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**<br/>mandatory<br/>**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. |
#### LemonLDAP
Configuration de la solution d'authentification unique LemonLDAP::NG.
| Parameter | Comments |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------|
| **[general.lemonldap.lemon_mail_admin](dictionaries/70_lemonldap_ng.xml)**<br/>mandatory<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Courriel de l'administrateur.<br/>**Example:** admin@example.net |
## Variables for expert
### Général
#### Annuaire OpenLDAP
##### Client
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
| **[general.ldap.client.ldapclient_family](dictionaries/70_lemonldap_ng.xml)**<br/>mandatory<br/>**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.<br/>**Default:** all |
| **[general.ldap.client.ldapclient_base_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
| **[general.ldap.client.ldapclient_search_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
| **[general.ldap.client.ldapclient_group_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
| **[general.ldap.client.ldapclient_user_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
#### NGINX
Paramétrage global de NGINX.
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Longueur maximum pour un nom de domaine.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximale des données reçues par la méthode POST (en Mo).<br/>**Default:** 32 |
#### Reverse proxy
##### Point d'entrée des clients
This family is a leadership.
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|
| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**<br/>**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. |
#### LemonLDAP
Configuration de la solution d'authentification unique LemonLDAP::NG.
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|
| **[general.lemonldap.lemon_proc](dictionaries/70_lemonldap_ng.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nombre de processus dédié à LemonLdap (équivalent au nombre de processeurs).<br/>**Default:** 1 |
## Requirements services
- **LocalDNS**
- Journald
- **SMTP**
- **LDAP**
- **ReverseProxy**
**bold**: provider is mandatory
## Example ## Example
@ -107,25 +31,111 @@ lemonldap:
general.lemonldap.lemon_mail_admin: admin@example.net general.lemonldap.lemon_mail_admin: admin@example.net
``` ```
## Basic variables
### General
#### Reverse proxy
##### Clients configuration
This family is a leadership.
| Parameter | Comment |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**<br/>mandatory, multiple<br/>**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.<br/>**Example:** service.example.net |
| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** / |
#### LemonLDAP
Configuration de la solution d'authentification unique LemonLDAP::NG.
| Parameter | Comments |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------|
| **[general.lemonldap.lemon_mail_admin](dictionaries/70_lemonldap_ng.xml)**<br/>mandatory<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Courriel de l'administrateur.<br/>**Example:** admin@example.net |
## Variables
### General
#### OpenLDAP directory
##### Client
| Parameter | Comment |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
| **[general.ldap.client.ldapclient_family](dictionaries/70_lemonldap_ng.xml)**<br/>mandatory<br/>**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.<br/>"all" for all families.<br/>**Default:** all |
#### Reverse proxy
##### Clients configuration
This family is a leadership.
| Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**<br/>**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. |
## Variables for expert
### General
#### NGINX
| Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The bucket size for the server names hash tables.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](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.<br/>This value is in Mb.<br/>**Default:** 32 |
#### LemonLDAP
Configuration de la solution d'authentification unique LemonLDAP::NG.
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|
| **[general.lemonldap.lemon_proc](dictionaries/70_lemonldap_ng.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nombre de processus dédié à LemonLdap (équivalent au nombre de processeurs).<br/>**Default:** 1 |
## Requirements services
### Mandatories
- [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name.
- [SMTP](../README.SMTP.md): Create a SMTP relay account and authorize sending email.
- [LDAP](../README.LDAP.md): Create account and connexion to a LDAP server.
- [ReverseProxy](../README.ReverseProxy.md): Register to service to a reverse proxy server.
### Optionals
- [Journald](../README.Journald.md): Concentrate journal messages on one host.
## Dependances ## Dependances
- [ldap-client](../ldap-client/README.md) - [ldap-client](../ldap-client/README.md): Application service needs interact with a LDAP server.
- [relay-mail-client](../relay-mail-client/README.md) - [relay-mail-client](../relay-mail-client/README.md): Client SMTP.
- [nginx-https](../nginx-https/README.md) - [nginx-https](../nginx-https/README.md): Nginx as HTTPS web site.
- [nginx-common](../nginx-common/README.md) - [nginx-common](../nginx-common/README.md): Nginx common configuration.
- [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.
- [base-debian-bullseye](../base-debian-bullseye/README.md) - [base-debian-bullseye](../base-debian-bullseye/README.md): Base information of a Debian Bulleye server.
- [base-debian](../base-debian/README.md) - [base-debian](../base-debian/README.md): Base information of a Debian server.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
## Supplier ## Useful for services
[oauth2-client](../oauth2-client/README.md) - [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.
[All applications services for this dataset.](../README.md) - [gitea](../gitea/README.md): Transitional package for Gitea to Forgejo.
- [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.
- [nextcloud](../nextcloud/README.md): Nextcloud, Online collaboration platform.
- [odoo](../odoo/README.md): Odoo, an ERP and CRM.
- [peertube](../peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform.
- [piwigo](../piwigo/README.md): Piwigo, a photo management software.
- [roundcube](../roundcube/README.md): Roundcube, a webmail.

16
seed/lemonldap/extras/oauth2/00_oauth2.xml
View file

@ -1,24 +1,24 @@
<?xml version='1.0' encoding='UTF-8'?> <?xml version='1.0' encoding='UTF-8'?>
<rougail version="0.10"> <rougail version="0.10">
<variables> <variables>
<variable name="remotes" description="Remote clients needing to verify OAuth2 account" type="domainname" multi="True" provider="OAuth2"/> <variable name="remotes" description="Remote clients needing to verify OAuth2 account" type="domainname" multi="True" provider="OAuth2" hidden="True"/>
<family name="oauth2_" description="OAuth2 for " dynamic="oauth2.remotes"> <family name="oauth2_" description="OAuth2 for " dynamic="oauth2.remotes">
<variable name="client_id_" description="Remote client id for " mandatory="True" hidden="True" provider="OAuth2:client_id"/> <variable name="client_id_" description="Remote client id for " mandatory="True" hidden="True" provider="OAuth2:client_id"/>
<variable name="secret_" description="Remote secret for " type="password" mandatory="True" hidden="True" provider="OAuth2:secret"/> <variable name="secret_" description="Remote secret for " type="password" mandatory="True" hidden="True" provider="OAuth2:secret"/>
<variable name="name_" description="Remote name for " hidden="True" provider="OAuth2:name"/> <variable name="name_" description="Remote name for " hidden="True" provider="OAuth2:name"/>
<variable name="description_" description="Remote description for " hidden="True" provider="OAuth2:description"/> <variable name="description_" description="Remote description for " hidden="True" provider="OAuth2:description"/>
<variable name="category_" hidden="True" provider="OAuth2:category"/> <variable name="category_" description="Remode category for " hidden="True" provider="OAuth2:category"/>
<variable name="login_" description="Remote URL to login" hidden="True" provider="OAuth2:login"/> <variable name="login_" description="Remote URL to login for " hidden="True" provider="OAuth2:login"/>
<family name="external_" leadership="True"> <family name="external_" leadership="True">
<variable name="hosts_" description="Remote external for " provider="OAuth2:external" multi="True"/> <variable name="hosts_" description="Remote external for " provider="OAuth2:external" multi="True" hidden="True"/>
<variable name="family_" hidden="True" provider="OAuth2:family"/> <variable name="family_" description="Remote family for " provider="OAuth2:family"/>
</family> </family>
<variable name="logo_" hidden="True" provider="OAuth2:logo"/> <variable name="logo_" description="Logo for " hidden="True" provider="OAuth2:logo"/>
<variable name="token_signature_algo_" type="choice" description="OAuth2 token signature algorithm" mandatory='True' hidden="True" provider="OAuth2:token_signature_algo"> <variable name="token_signature_algo_" type="choice" description="OAuth2 token signature algorithm for " mandatory='True' hidden="True" provider="OAuth2:token_signature_algo">
<choice>HS512</choice> <choice>HS512</choice>
<choice>RS256</choice> <choice>RS256</choice>
</variable> </variable>
<variable name="oauth2_client_external_domain_" type="domainname" hidden="True" supplier="OAuth2:external_domain"/> <variable name="oauth2_client_external_domain_" description="External domain for " type="domainname" hidden="True" supplier="OAuth2:external_domain"/>
</family> </family>
</variables> </variables>
<constraints> <constraints>

46
seed/loki/README.md
View file

@ -3,20 +3,14 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# loki # loki
## Synopsis ## Synopsis
Loki, a log aggregation platform.
[Software's website.](https://grafana.com/) [Loki, a log aggregation platform.](https://grafana.com/)
## Requirements services
- **LocalDNS**
- Journald
**bold**: provider is mandatory
## Example ## Example
@ -30,20 +24,28 @@ loki:
- localdns - localdns
``` ```
## Requirements services
### Mandatories
- [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name.
### Optionals
- [Journald](../README.Journald.md): Concentrate journal messages on one host.
## Dependances ## Dependances
- [base-fedora-38](../base-fedora-38/README.md) - [base-fedora-38](../base-fedora-38/README.md): Base information of a Fedora 38.
- [base-fedora](../base-fedora/README.md) - [base-fedora](../base-fedora/README.md): Base information of a Fedora.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
## Supplier ## Useful for service
[vector](../vector/README.md) [vector](../vector/README.md): Vector, a lightweight, ultra-fast tool for building observability pipelines.
[All applications services for this dataset.](../README.md)

4
seed/loki/dictionaries/20_loki.xml
View file

@ -8,8 +8,8 @@
</service> </service>
</services> </services>
<variables> <variables>
<family name="loki" description="loki"> <family name="loki" description="Loki">
<variable name="remotes" description="Remote loki client" type="domainname" provider="Loki" mandatory="True" multi="True"/> <variable name="remotes" description="Concentrate log messages" type="domainname" provider="Loki" mandatory="True" multi="True" hidden="True"/>
</family> </family>
</variables> </variables>
</rougail> </rougail>

165
seed/mailman/README.md
View file

@ -3,32 +3,54 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# mailman # mailman
## Synopsis ## 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)
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
```
mailman:
applicationservice: mailman
zones_name:
- localdns
- oauth2
- postgresql
- reverseproxy
- smtp
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
general.mailman.mailman_mail_owner: admin@example.net
general.mailman.mailman_domains:
- list.example.net
```
## Basic variables ## Basic variables
### Général ### General
#### Reverse proxy #### Reverse proxy
##### Point d'entrée des clients ##### Clients configuration
This family is a leadership. This family is a leadership.
| Parameter | Comments | | Parameter | Comment |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**<br/>mandatory, multiple<br/>**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.<br/>**Example:** service.example.net | | **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**<br/>mandatory, multiple<br/>**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.<br/>**Example:** service.example.net |
| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**<br/>mandatory<br/>**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. | | **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** / |
#### Gestionnaire de liste #### Gestionnaire de liste
| Parameter | Comments | | Parameter | Comment |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------| |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|
| **[general.mailman.mailman_mail_owner](dictionaries/31_mailman.xml)**<br/>mandatory<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Courriel du gestionnaire de liste du site.<br/>**Example:** admin@example.net | | **[general.mailman.mailman_mail_owner](dictionaries/31_mailman.xml)**<br/>mandatory<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Courriel du gestionnaire de liste du site.<br/>**Example:** admin@example.net |
| **[general.mailman.mailman_domains](dictionaries/31_mailman.xml)**<br/>mandatory, multiple<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de domaine des listes.<br/>**Example:** list.example.net | | **[general.mailman.mailman_domains](dictionaries/31_mailman.xml)**<br/>mandatory, multiple<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de domaine des listes.<br/>**Example:** list.example.net |
@ -39,45 +61,27 @@ This family is a leadership.
This a dynamic family generated from the variable "general.mailman.mailman_domains". This a dynamic family generated from the variable "general.mailman.mailman_domains".
| Parameter | Comments | | Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|
| **[mailman.list_*suffix value*.name_*suffix value*](extras/mailman/20_mailman.xml)**<br/>mandatory, multiple<br/>**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom des listes . | | **[mailman.list_*suffix value*.name_*suffix value*](extras/mailman/20_mailman.xml)**<br/>mandatory, multiple<br/>**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom des listes *suffix value*. |
## Variables
## Variables for expert ### General
### Général
#### NGINX
Paramétrage global de NGINX.
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Longueur maximum pour un nom de domaine.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximale des données reçues par la méthode POST (en Mo).<br/>**Default:** 32 |
#### Reverse proxy #### Reverse proxy
##### Point d'entrée des clients ##### Clients configuration
This family is a leadership. This family is a leadership.
| Parameter | Comments | | Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**<br/>**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. | | **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**<br/>**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. |
#### PostgreSQL
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|
| **[general.postgresql.pg_client_username](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client username.<br/>**Default:** *calculated* |
| **[general.postgresql.pg_client_password](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client password.<br/>**Default:** *calculated* |
| **[general.postgresql.pg_client_database](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client database.<br/>**Default:** *calculated* |
#### OAuth2 client #### OAuth2 client
| Parameter | Comments | | Parameter | Comment |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| **[general.oauth2_client.oauth2_client_name](dictionaries/31_mailman.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.<br/>**Default:** Liste de distribution<br/>**Example:** example | | **[general.oauth2_client.oauth2_client_name](dictionaries/31_mailman.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.<br/>**Default:** Liste de distribution<br/>**Example:** example |
| **[general.oauth2_client.oauth2_client_description](dictionaries/31_mailman.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.<br/>**Default:** Liste de distribution Mailman<br/>**Example:** Example description | | **[general.oauth2_client.oauth2_client_description](dictionaries/31_mailman.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.<br/>**Default:** Liste de distribution Mailman<br/>**Example:** Example description |
@ -90,65 +94,56 @@ This family is a leadership.
| **[general.oauth2_client.external.oauth2_client_external](dictionaries/31_mailman.xml)**<br/>mandatory, multiple<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client external.<br/>**Default:** *calculated* | | **[general.oauth2_client.external.oauth2_client_external](dictionaries/31_mailman.xml)**<br/>mandatory, multiple<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client external.<br/>**Default:** *calculated* |
| **[general.oauth2_client.external.oauth2_client_family](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 family.<br/>**Default:** users | | **[general.oauth2_client.external.oauth2_client_family](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 family.<br/>**Default:** users |
| Parameter | Comments | | Parameter | Comment |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|
| **[general.oauth2_client.oauth2_client_category](dictionaries/31_mailman.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.<br/>**Default:** Développement | | **[general.oauth2_client.oauth2_client_category](dictionaries/31_mailman.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.<br/>**Default:** Développement |
| **[general.oauth2_client.oauth2_client_logo](dictionaries/31_mailman.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.<br/>**Default:** silique_email.png | | **[general.oauth2_client.oauth2_client_logo](dictionaries/31_mailman.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.<br/>**Default:** silique_email.png |
## Variables for expert
### General
#### NGINX
| Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The bucket size for the server names hash tables.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](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.<br/>This value is in Mb.<br/>**Default:** 32 |
## Requirements services ## Requirements services
- **LocalDNS** ### Mandatories
- Journald
- **SMTP**
- **ReverseProxy**
- **Postgresql**
- **LMTP**
- **OAuth2**
**bold**: provider is mandatory - [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name.
- [SMTP](../README.SMTP.md): Create a SMTP relay account and authorize sending email.
- [ReverseProxy](../README.ReverseProxy.md): Register to service to a reverse proxy server.
- [Postgresql](../README.Postgresql.md): Create account and connexion to a PostgreSQL server.
- [OAuth2](../README.OAuth2.md): Remote clients needing to verify OAuth2 account.
## Example ### Optionals
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. - [Journald](../README.Journald.md): Concentrate journal messages on one host.
```
mailman:
applicationservice: mailman
zones_name:
- localdns
- reverseproxy
- smtp
- lmtp
- oauth2
- postgresql
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
general.mailman.mailman_mail_owner: admin@example.net
general.mailman.mailman_domains:
- list.example.net
```
## Dependances ## Dependances
- [base-debian-bullseye](../base-debian-bullseye/README.md) - [base-debian-bullseye](../base-debian-bullseye/README.md): Base information of a Debian Bulleye server.
- [base-debian](../base-debian/README.md) - [base-debian](../base-debian/README.md): Base information of a Debian server.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
- [postgresql-client](../postgresql-client/README.md) - [postgresql-client](../postgresql-client/README.md): Application service needs interact with a Postgresql server.
- [relay-lmtp-client](../relay-lmtp-client/README.md) - [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) - [relay-mail-client](../relay-mail-client/README.md): Client SMTP.
- [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.
- [nginx-https](../nginx-https/README.md) - [nginx-https](../nginx-https/README.md): Nginx as HTTPS web site.
- [nginx-common](../nginx-common/README.md) - [nginx-common](../nginx-common/README.md): Nginx common configuration.
- [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.
- [oauth2-client](../oauth2-client/README.md) - [oauth2-client](../oauth2-client/README.md): Application service needs interact with a Oauth2 server.
[All applications services for this dataset.](../README.md)

11
seed/mariadb-client/README.md
View file

@ -3,20 +3,15 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# mariadb-client # mariadb-client
## Synopsis ## 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 ## Used by
[piwigo](../piwigo/README.md) [piwigo](../piwigo/README.md)
## Provider
[mariadb](../mariadb/README.md)
[All applications services for this dataset.](../README.md)

4
seed/mariadb-client/dictionaries/20_mariadb.xml
View file

@ -5,9 +5,9 @@
</services> </services>
<variables> <variables>
<family name="mariadb" description="MariaDB"> <family name="mariadb" description="MariaDB">
<variable name="mariadb_client_server_domainname" type="domainname" description="Nom de domaine du serveur MariaDB" mandatory="True" supplier="MariaDB"/> <variable name="mariadb_client_server_domainname" type="domainname" mandatory="True" supplier="MariaDB" hidden="True"/>
<variable name="mariadb_client_server_ip" type="ip" hidden="True"/> <variable name="mariadb_client_server_ip" type="ip" hidden="True"/>
<variable name="mariadb_client_username" description="Database username" mandatory="True" hidden="True" supplier="MariaDB:username"/> <variable name="mariadb_client_username" description="Database username" mandatory="True" supplier="MariaDB:username" hidden="True"/>
<variable name="mariadb_client_password" type="secret" description="Database password" mandatory="True" hidden="True" supplier="MariaDB:password"/> <variable name="mariadb_client_password" type="secret" description="Database password" mandatory="True" hidden="True" supplier="MariaDB:password"/>
<variable name="mariadb_client_database" description="Database name" mandatory="True" hidden="True" supplier="MariaDB:database"/> <variable name="mariadb_client_database" description="Database name" mandatory="True" hidden="True" supplier="MariaDB:database"/>
<variable name='mariadb_client_address' hidden="True"/> <variable name='mariadb_client_address' hidden="True"/>

46
seed/mariadb/README.md
View file

@ -3,20 +3,14 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# mariadb # mariadb
## Synopsis ## Synopsis
MariaDB, a relational database.
[Software's website.](https://mariadb.org/) [MariaDB, a relational database.](https://mariadb.org/)
## Requirements services
- **LocalDNS**
- Journald
**bold**: provider is mandatory
## Example ## Example
@ -30,20 +24,28 @@ mariadb:
- localdns - localdns
``` ```
## Requirements services
### Mandatories
- [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name.
### Optionals
- [Journald](../README.Journald.md): Concentrate journal messages on one host.
## Dependances ## Dependances
- [base-fedora-36](../base-fedora-36/README.md) - [base-fedora-36](../base-fedora-36/README.md): Base information of a Fedora 36.
- [base-fedora](../base-fedora/README.md) - [base-fedora](../base-fedora/README.md): Base information of a Fedora.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
## Supplier ## Useful for service
[mariadb-client](../mariadb-client/README.md) [piwigo](../piwigo/README.md): Piwigo, a photo management software.
[All applications services for this dataset.](../README.md)

10
seed/mariadb/extras/accounts/00_accounts.xml
View file

@ -1,11 +1,11 @@
<?xml version='1.0' encoding='UTF-8'?> <?xml version='1.0' encoding='UTF-8'?>
<rougail version="0.10"> <rougail version="0.10">
<variables> <variables>
<variable name="remotes" description="Remote clients needing an account" type="domainname" multi="True" provider="MariaDB"/> <variable name="remotes" description="Create account and connexion to a MariaDB server." type="domainname" multi="True" provider="MariaDB" hidden="True"/>
<family name="remote_" description="Account for " dynamic="accounts.remotes"> <family name="remote_" description="Account for " dynamic="accounts.remotes" hidden="True">
<variable name="database_" description="Remote database " auto_save="False" hidden="True" mandatory="True" provider="MariaDB:database"/> <variable name="database_" description="MariaDB database name for " mandatory="True" provider="MariaDB:database"/>
<variable name="username_" description="Remote username " auto_save="False" hidden="True" mandatory="True" provider="MariaDB:username"/> <variable name="username_" description="MariaDB user name for " mandatory="True" provider="MariaDB:username"/>
<variable name="password_" description="Remote password" auto_save="False" hidden="True" type="password" mandatory="True" provider="MariaDB:password"/> <variable name="password_" description="MariaDB password for " type="password" mandatory="True" provider="MariaDB:password"/>
</family> </family>
</variables> </variables>
</rougail> </rougail>

221
seed/nextcloud/README.md
View file

@ -3,107 +3,82 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# nextcloud # nextcloud
## Synopsis ## Synopsis
Nextcloud, Online collaboration platform.
[Software's website.](https://nextcloud.com/) [Nextcloud, Online collaboration platform.](https://nextcloud.com/)
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
```
nextcloud:
applicationservice: nextcloud
zones_name:
- ldap
- localdns
- oauth2
- postgresql
- redis
- reverseproxy
- smtp
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
general.nextcloud.nextcloud_mail_admin: admin@example.net
```
## Basic variables ## Basic variables
### Général ### General
#### Reverse proxy #### Reverse proxy
##### Point d'entrée des clients ##### Clients configuration
This family is a leadership. This family is a leadership.
| Parameter | Comments | | Parameter | Comment |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**<br/>mandatory, multiple<br/>**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.<br/>**Example:** service.example.net | | **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**<br/>mandatory, multiple<br/>**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.<br/>**Example:** service.example.net |
| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**<br/>mandatory<br/>**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. | | **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** / |
#### Nextcloud #### Nextcloud
| Parameter | Comments | | Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
| **[general.nextcloud.nextcloud_mail_admin](dictionaries/31_nextcloud.xml)**<br/>mandatory<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | **Example:** admin@example.net | | **[general.nextcloud.nextcloud_mail_admin](dictionaries/31_nextcloud.xml)**<br/>mandatory<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The administrator email.<br/>**Example:** admin@example.net |
## Variables
## Variables for expert ### General
### Général #### OpenLDAP directory
#### PHP
Paramètrage avancé de PHP.
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.php.php_post_max_size](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximale des données reçues par la méthode POST.<br/>Valeur en Mo.<br/>**Default:** 32 |
| **[general.php.php_upload_max_filesize](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximale d'un fichier à charger.<br/>Valeur en Mo.<br/>**Default:** 16 |
| **[general.php.php_max_execution_time](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Temps maximal d'exécution d'un script.<br/>Valeur en secondes.<br/>**Default:** 30 |
| **[general.php.php_max_input_time](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Durée maximale pour analyser les données d'entrée.<br/>Valeur en secondes.<br/>**Default:** 60 |
| **[general.php.php_memory_limit](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille mémoire maximale qu'un script est autorisé à allouer.<br/>Valeur en Mo.<br/>**Default:** 512 |
| **[general.php.php_display_errors](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`boolean`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Affichage des erreurs à l'écran.<br/>**Default:** False |
| **[general.php.php_session_gc_maxlifetime](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Durée de vie des données sur le serveur.<br/>Valeur en secondes.<br/>**Default:** 3600 |
| **[general.php.php_browscap](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`boolean`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Activer la directive de configuration browscap.<br/>La directive de configuration browscap permet d'obtenir plus d'information sur les capacités du navigateur client grâce à la fonction get_browser().<br/>**Default:** False |
| **[general.php.time_zone](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Fuseau horaire.<br/>**Default:** Europe/Paris |
| **[general.php.php_enable_output_buffering](dictionaries/31_nextcloud.xml)**<br/>mandatory<br/>**Type:** [`boolean`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Activer les tampons de sortie.<br/>**Default:** False |
| **[general.php.php_disable_pcntl](dictionaries/31_nextcloud.xml)**<br/>mandatory<br/>**Type:** [`boolean`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Désactiver PCNTL.<br/>**Default:** False |
#### Apache
Paramètrage avancé du serveur web Apache.
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
| **[general.apache.apache_timeout](dictionaries/20_web.xml)**<br/>mandatory<br/>**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é.<br/>Temps en secondes.<br/>**Default:** 300 |
| **[general.apache.apache_keepalive](dictionaries/20_web.xml)**<br/>mandatory<br/>**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.<br/>**Default:** True |
#### Annuaire OpenLDAP
##### Client ##### Client
| Parameter | Comments | | Parameter | Comment |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------| |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|
| **[general.ldap.client.ldapclient_family](dictionaries/21_ldap-client.xml)**<br/>**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. | | **[general.ldap.client.ldapclient_family](dictionaries/21_ldap-client.xml)**<br/>**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.<br/>"all" for all families. |
| **[general.ldap.client.ldapclient_base_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
| **[general.ldap.client.ldapclient_search_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
| **[general.ldap.client.ldapclient_group_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
| **[general.ldap.client.ldapclient_user_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
#### Reverse proxy #### Reverse proxy
##### Point d'entrée des clients ##### Clients configuration
This family is a leadership. This family is a leadership.
| Parameter | Comments | | Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**<br/>**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. | | **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**<br/>**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. |
#### PostgreSQL
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|
| **[general.postgresql.pg_client_username](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client username.<br/>**Default:** *calculated* |
| **[general.postgresql.pg_client_password](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client password.<br/>**Default:** *calculated* |
| **[general.postgresql.pg_client_database](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client database.<br/>**Default:** *calculated* |
#### Redis
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|
| **[general.redis.redis_client_username](dictionaries/23_redis.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom d'utilisateur.<br/>**Default:** *calculated* |
| **[general.redis.redis_client_password](dictionaries/23_redis.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
#### OAuth2 client #### OAuth2 client
| Parameter | Comments | | Parameter | Comment |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| **[general.oauth2_client.oauth2_client_name](dictionaries/31_nextcloud.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.<br/>**Default:** Collaboration<br/>**Example:** example | | **[general.oauth2_client.oauth2_client_name](dictionaries/31_nextcloud.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.<br/>**Default:** Collaboration<br/>**Example:** example |
| **[general.oauth2_client.oauth2_client_description](dictionaries/31_nextcloud.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.<br/>**Default:** Plateforme de collaboration Nextcloud<br/>**Example:** Example description | | **[general.oauth2_client.oauth2_client_description](dictionaries/31_nextcloud.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.<br/>**Default:** Plateforme de collaboration Nextcloud<br/>**Example:** Example description |
@ -116,67 +91,75 @@ This family is a leadership.
| **[general.oauth2_client.external.oauth2_client_external](dictionaries/30_oauth2_client.xml)**<br/>mandatory, multiple<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client external.<br/>**Default:** *calculated* | | **[general.oauth2_client.external.oauth2_client_external](dictionaries/30_oauth2_client.xml)**<br/>mandatory, multiple<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client external.<br/>**Default:** *calculated* |
| **[general.oauth2_client.external.oauth2_client_family](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 family.<br/>**Default:** users | | **[general.oauth2_client.external.oauth2_client_family](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 family.<br/>**Default:** users |
| Parameter | Comments | | Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------| |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|
| **[general.oauth2_client.oauth2_client_category](dictionaries/31_nextcloud.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.<br/>**Default:** Diffusion | | **[general.oauth2_client.oauth2_client_category](dictionaries/31_nextcloud.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.<br/>**Default:** Diffusion |
| **[general.oauth2_client.oauth2_client_logo](dictionaries/31_nextcloud.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.<br/>**Default:** silique_folder.png | | **[general.oauth2_client.oauth2_client_logo](dictionaries/31_nextcloud.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.<br/>**Default:** silique_folder.png |
## Variables for expert
### General
#### PHP
Paramètrage avancé de PHP.
| Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|
| **[general.php.php_post_max_size](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Maximum size of POST data that PHP will accept.<br/>Value in Mb.<br/>**Default:** 32 |
| **[general.php.php_upload_max_filesize](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Maximum allowed size for uploaded files.<br/>Value in Mb.<br/>**Default:** 16 |
| **[general.php.php_max_execution_time](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Maximum amount of time each script may spend parsing request data.<br/>Value in seconds.<br/>**Default:** 30 |
| **[general.php.php_max_input_time](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Maximum amount of time each script may spend parsing request data.<br/>Value in seconds.<br/>**Default:** 60 |
| **[general.php.php_memory_limit](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Maximum amount of memory a script may consume.<br/>Value in Mb.<br/>**Default:** 512 |
| **[general.php.php_session_gc_maxlifetime](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Data will be seen as 'garbage' and potentially cleaned up after this delay.<br/>Value in seconds.<br/>**Default:** 3600 |
#### Apache
Advance Apache web server settings.
| Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
| **[general.apache.apache_timeout](dictionaries/20_web.xml)**<br/>mandatory<br/>**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.<br/>Time in seconds.<br/>**Default:** 300 |
| **[general.apache.apache_keepalive](dictionaries/20_web.xml)**<br/>mandatory<br/>**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.<br/>**Default:** True |
## Requirements services ## Requirements services
- **LocalDNS** ### Mandatories
- Journald
- **SMTP**
- **LDAP**
- **ReverseProxy**
- **Postgresql**
- **Redis**
- **OAuth2**
**bold**: provider is mandatory - [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name.
- [SMTP](../README.SMTP.md): Create a SMTP relay account and authorize sending email.
- [LDAP](../README.LDAP.md): Create account and connexion to a LDAP server.
- [ReverseProxy](../README.ReverseProxy.md): Register to service to a reverse proxy server.
- [Postgresql](../README.Postgresql.md): Create account and connexion to a PostgreSQL server.
- [OAuth2](../README.OAuth2.md): Remote clients needing to verify OAuth2 account.
- [Redis](../README.Redis.md): Create account and connexion to a Redis server.
## Example ### Optionals
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. - [Journald](../README.Journald.md): Concentrate journal messages on one host.
```
nextcloud:
applicationservice: nextcloud
zones_name:
- ldap
- localdns
- reverseproxy
- smtp
- redis
- oauth2
- postgresql
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
general.nextcloud.nextcloud_mail_admin: admin@example.net
```
## Dependances ## Dependances
- [base-fedora-36](../base-fedora-36/README.md) - [base-fedora-36](../base-fedora-36/README.md): Base information of a Fedora 36.
- [base-fedora](../base-fedora/README.md) - [base-fedora](../base-fedora/README.md): Base information of a Fedora.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
- [postgresql-client](../postgresql-client/README.md) - [postgresql-client](../postgresql-client/README.md): Application service needs interact with a Postgresql server.
- [ldap-client](../ldap-client/README.md) - [ldap-client](../ldap-client/README.md): Application service needs interact with a LDAP server.
- [redis-client](../redis-client/README.md) - [redis-client](../redis-client/README.md): Application service needs interact with a Redis server.
- [redis-common](../redis-common/README.md) - [redis-common](../redis-common/README.md): Redis, an in-memory data structure store.
- [oauth2-client](../oauth2-client/README.md) - [oauth2-client](../oauth2-client/README.md): Application service needs interact with a Oauth2 server.
- [relay-mail-client](../relay-mail-client/README.md) - [relay-mail-client](../relay-mail-client/README.md): Client SMTP.
- [apache](../apache/README.md) - [apache](../apache/README.md): Apache as web server.
- [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.
- [php-fpm](../php-fpm/README.md) - [php-fpm](../php-fpm/README.md): PHP FPM.
- [php](../php/README.md) - [php](../php/README.md): PHP, a popular general-purpose scripting language.
[All applications services for this dataset.](../README.md)

2
seed/nextcloud/dictionaries/31_nextcloud.xml
View file

@ -15,7 +15,7 @@
<variables> <variables>
<family name="nextcloud" description="Nextcloud"> <family name="nextcloud" description="Nextcloud">
<variable name="nextcloud_admin_password" type="password" auto_save="False" hidden="True"/> <variable name="nextcloud_admin_password" type="password" auto_save="False" hidden="True"/>
<variable name="nextcloud_mail_admin" type="mail" mandatory="True" test="admin@example.net"/> <variable name="nextcloud_mail_admin" type="mail" description="The administrator email" mandatory="True" test="admin@example.net"/>
<variable name="nextcloud_instance_id" type="password" auto_save="False" hidden="True"/> <variable name="nextcloud_instance_id" type="password" auto_save="False" hidden="True"/>
</family> </family>
<family name="oauth2_client"> <family name="oauth2_client">

19
seed/nginx-common/README.md
View file

@ -3,32 +3,29 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# nginx-common # nginx-common
## Synopsis ## Synopsis
Nginx common configuration.
[Software's website.](https://nginx.org/) [Nginx common configuration.](https://nginx.org/)
## Variables for expert ## Variables for expert
### Général ### General
#### NGINX #### NGINX
Paramétrage global de NGINX. | Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| Parameter | Comments | | **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The bucket size for the server names hash tables.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------| | **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](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.<br/>This value is in Mb.<br/>**Default:** 32 |
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Longueur maximum pour un nom de domaine.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximale des données reçues par la méthode POST (en Mo).<br/>**Default:** 32 |
## Used by ## Used by
- [nginx-reverse-proxy](../nginx-reverse-proxy/README.md) - [nginx-reverse-proxy](../nginx-reverse-proxy/README.md)
- [nginx-https](../nginx-https/README.md) - [nginx-https](../nginx-https/README.md)
[All applications services for this dataset.](../README.md)

12
seed/nginx-common/dictionaries/21_nginx.xml
View file

@ -12,24 +12,24 @@
</service> </service>
</services> </services>
<variables> <variables>
<family name="nginx" description="NGINX" help="Paramétrage global de NGINX"> <family name="nginx" description="NGINX">
<variable name="nginx_default_http" type="boolean" description="Activer la gestion du répertoire default.d en HTTP sur le serveur" mandatory='True' hidden="True"> <variable name="nginx_default_http" type="boolean" mandatory='True' hidden="True">
<value>False</value> <value>False</value>
</variable> </variable>
<variable name="nginx_default_https" type="boolean" description="Activer la gestion du répertoire default.d en HTTPS sur le serveur" mandatory='True' hidden="True"> <variable name="nginx_default_https" type="boolean" description="Support the default.d directory for HTTPS connexion" mandatory='True' hidden="True">
<value>False</value> <value>False</value>
</variable> </variable>
<variable name="nginx_default" type="domainname" description="Nom de domaine du serveur mandataire inverse par défaut" help="Si un client accède au serveur avec un nom de domaine non déclaré, le flux est redirigé vers ce domaine" mandatory='False' hidden="True"/> <variable name="nginx_default" type="domainname" mandatory='False' hidden="True"/>
<variable name="nginx_root" type="filename" mandatory='False' hidden="True"> <variable name="nginx_root" type="filename" mandatory='False' hidden="True">
<value>/usr/share/nginx/html</value> <value>/usr/share/nginx/html</value>
</variable> </variable>
<variable name="nginx_hash_bucket_size" description="Longueur maximum pour un nom de domaine" mode="expert" type="choice"> <variable name="nginx_hash_bucket_size" description="The bucket size for the server names hash tables" mode="expert" type="choice">
<value>128</value> <value>128</value>
<choice type="string">128</choice> <choice type="string">128</choice>
<choice type="string">64</choice> <choice type="string">64</choice>
<choice type="string">32</choice> <choice type="string">32</choice>
</variable> </variable>
<variable name="nginx_post_max_size" type="number" description="Taille maximale des données reçues par la méthode POST (en Mo)" mode="expert" mandatory="True"> <variable name="nginx_post_max_size" type="number" description="The maximum allowed size of the client request body" help="This value is in Mb" mode="expert" mandatory="True">
<value>32</value> <value>32</value>
</variable> </variable>
<variable name="nginx_owner" type="unix_user" description="Nginx process owner" mandatory="True" hidden="True"/> <variable name="nginx_owner" type="unix_user" description="Nginx process owner" mandatory="True" hidden="True"/>

11
seed/nginx-https/README.md
View file

@ -3,18 +3,19 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# nginx-https # nginx-https
## Synopsis ## Synopsis
Nginx as HTTPS web site.
[Software's website.](https://nginx.org/) [Nginx as HTTPS web site.](https://nginx.org/)
## Dependances ## Dependances
- [nginx-common](../nginx-common/README.md) - [nginx-common](../nginx-common/README.md): Nginx common configuration.
- [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 ## Used by
@ -26,5 +27,3 @@ Nginx as HTTPS web site.
- [dovecot](../dovecot/README.md) - [dovecot](../dovecot/README.md)
- [roundcube](../roundcube/README.md) - [roundcube](../roundcube/README.md)
- [lemonldap](../lemonldap/README.md) - [lemonldap](../lemonldap/README.md)
[All applications services for this dataset.](../README.md)

112
seed/nginx-reverse-proxy/README.md
View file

@ -3,47 +3,17 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# nginx-reverse-proxy # nginx-reverse-proxy
## Synopsis ## Synopsis
Nginx as reverse proxy.
[Software's website.](https://nginx.org/) [Nginx as reverse proxy.](https://nginx.org/)
The reverse proxy provides access to internal services.
## Variables These internal services are integrated automatically.
### Général
#### NGINX
Paramétrage global de NGINX.
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_default](dictionaries/25_nginx.xml)**<br/>mandatory<br/>**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.<br/>Si un client accède au serveur avec un nom de domaine non déclaré, le flux est redirigé vers ce domaine.<br/>**Default:** *calculated* |
| **[general.nginx.nginx_certificates_provider](dictionaries/25_nginx.xml)**<br/>mandatory<br/>**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.<br/>**Choices:**<br/>- `self-signed` ← default<br/>- `letsencrypt` |
## Variables for expert
### Général
#### NGINX
Paramétrage global de NGINX.
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Longueur maximum pour un nom de domaine.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximale des données reçues par la méthode POST (en Mo).<br/>**Default:** 32 |
## Requirements services
- **LocalDNS**
- Journald
**bold**: provider is mandatory
## Example ## Example
@ -57,21 +27,65 @@ nginx-reverse-proxy:
- localdns - localdns
``` ```
## Basic variables
### General
#### NGINX
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_default](dictionaries/25_nginx.xml)**<br/>mandatory<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Default reverse proxy domaine name.<br/>If a client access to reverse proxy with an unknown domain name, the connexion is redirect to this domain name. By default this variable is the first associated service to this reverse proxy.<br/>**Default:** *calculated* |
| **[general.nginx.nginx_certificates_provider](dictionaries/25_nginx.xml)**<br/>mandatory<br/>**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 certificates.<br/>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).<br/>**Choices:**<br/>- `self-signed` ← default<br/>- `letsencrypt` |
## Variables for expert
### General
#### NGINX
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The bucket size for the server names hash tables.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](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.<br/>This value is in Mb.<br/>**Default:** 32 |
## Requirements services
### Mandatories
- [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name.
### Optionals
- [Journald](../README.Journald.md): Concentrate journal messages on one host.
## Dependances ## Dependances
- [nginx-common](../nginx-common/README.md) - [nginx-common](../nginx-common/README.md): Nginx common configuration.
- [base-fedora-37](../base-fedora-37/README.md) - [base-fedora-37](../base-fedora-37/README.md): Base information of a Fedora 37.
- [base-fedora](../base-fedora/README.md) - [base-fedora](../base-fedora/README.md): Base information of a Fedora.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
## Supplier ## Useful for services
[reverse-proxy-client](../reverse-proxy-client/README.md) - [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.
[All applications services for this dataset.](../README.md) - [gitea](../gitea/README.md): Transitional package for Gitea to Forgejo.
- [grafana](../grafana/README.md): Grafana is an analytics and interactive visualization web application.
- [lemonldap](../lemonldap/README.md): LemonLDAP, a Web Single Sign On and Access Management.
- [mailman](../mailman/README.md): GNU Mailman, managing electronic mail discussion and e-newsletter lists.
- [nextcloud](../nextcloud/README.md): Nextcloud, Online collaboration platform.
- [nginx-static](../nginx-static/README.md): Nginx as static web site.
- [odoo](../odoo/README.md): Odoo, an ERP and CRM.
- [peertube](../peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform.
- [piwigo](../piwigo/README.md): Piwigo, a photo management software.
- [roundcube](../roundcube/README.md): Roundcube, a webmail.
- [speedtest-rs](../speedtest-rs/README.md): Speedtest-rs, a very lightweight Speedtest.
- [vaultwarden](../vaultwarden/README.md): Vaultwarden, a password manager.

3
seed/nginx-reverse-proxy/applicationservice.yml
View file

@ -1,5 +1,8 @@
format: '0.1' format: '0.1'
description: Nginx as reverse proxy description: Nginx as reverse proxy
help: |
The reverse proxy provides access to internal services.
These internal services are integrated automatically.
website: https://nginx.org/ website: https://nginx.org/
depends: depends:
- nginx-common - nginx-common

14
seed/nginx-reverse-proxy/dictionaries/25_nginx.xml
View file

@ -19,19 +19,19 @@
<value>443</value> <value>443</value>
</variable> </variable>
</family> </family>
<family name="nginx" description="NGINX" help="Paramétrage global de NGINX"> <family name="nginx" description="NGINX">
<variable name="nginx_certificates_provider" type="choice" description="Autorité de certification signant le certificat des domaines extérieurs" mandatory="True"> <variable name="nginx_default" redefine="True" mandatory="True" hidden="False" description="Default reverse proxy domaine name" help="If a client access to reverse proxy with an unknown domain name, the connexion is redirect to this domain name. By default this variable is the first associated service to this reverse proxy" mode="basic"/>
<value>self-signed</value>
<choice>self-signed</choice>
<choice>letsencrypt</choice>
</variable>
<variable name="nginx_default" redefine="True" mandatory="True" hidden="False"/>
<variable name="nginx_default_http" redefine="True"> <variable name="nginx_default_http" redefine="True">
<value>False</value> <value>False</value>
</variable> </variable>
<variable name="nginx_default_https" redefine="True"> <variable name="nginx_default_https" redefine="True">
<value>False</value> <value>False</value>
</variable> </variable>
<variable name="nginx_certificates_provider" type="choice" description="Type of certificate autority signing external certificates" mandatory="True" mode="basic" help="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)">
<value>self-signed</value>
<choice>self-signed</choice>
<choice>letsencrypt</choice>
</variable>
</family> </family>
</variables> </variables>
</rougail> </rougail>

14
seed/nginx-reverse-proxy/extras/nginx/00_nginx.xml
View file

@ -1,15 +1,15 @@
<?xml version='1.0' encoding='UTF-8'?> <?xml version='1.0' encoding='UTF-8'?>
<rougail version="0.10"> <rougail version="0.10">
<variables> <variables>
<variable name="remotes" type="domainname" description="Nom des domaines dans le serveur mandataire inverse" multi="True" provider="ReverseProxy"/> <variable name="remotes" description="Register to service to a reverse proxy server" type="domainname" multi="True" provider="ReverseProxy" hidden="True"/>
<family name="reverse_proxy_for_" description="Serveur mandataire inverse pour " dynamic="nginx.remotes"> <family name="reverse_proxy_for_" description="Serveur mandataire inverse pour " dynamic="nginx.remotes">
<family name="reverse_proxy_" description="Reverse proxy " help="Paramètrage du proxy inverse" leadership="True"> <family name="reverse_proxy_" description="Reverse proxy " help="Paramètrage du proxy inverse" leadership="True">
<variable name="revprox_domainnames_" type="domainname" description="Nom des domaines auto-configurés dans le serveur mandataire inverse " multi="True" provider="ReverseProxy:external" hidden="True" mandatory="False"/> <variable name="revprox_domainnames_" type="domainname" description="External domain name for " multi="True" provider="ReverseProxy:external" hidden="True" mandatory="False"/>
<variable name="revprox_location_" type="filename" description="Répertoire ou nom de la page à rediriger pour " help="URL relative (sans le nom de domaine) redirigée pour l'adresse définie dans la variable ci-dessus (exemple &quot;/mail&quot;)" mandatory="True" multi="True" unique="False" provider="ReverseProxy:location"/> <variable name="revprox_location_" type="filename" description="URI to redirect for " help="Relative redirected URI (without domaine name)" mandatory="True" multi="True" unique="False" provider="ReverseProxy:location" test="/mail"/>
<variable name="revprox_url_" type="web_address" description="Domaine de destination ou URI complète pour " mandatory="True" unique="False" help="Nom de domaine ou IP de destination, par exemple &quot;http://domainelocal&quot; ou URI, par exemple &quot;http://domainelocal/dir/&quot;" provider="ReverseProxy:url"/> <variable name="revprox_url_" type="web_address" description="Internal URL for " mandatory="True" unique="False" provider="ReverseProxy:url"/>
<variable name="revprox_is_websocket_" type="boolean" description="Le point d'entrée est de types websocket pour " mandatory="True" multi="True" unique="False" provider="ReverseProxy:websocket"/> <variable name="revprox_is_websocket_" type="boolean" description="The entry point is a websocket for " mandatory="True" multi="True" unique="False" provider="ReverseProxy:websocket"/>
<variable name="revprox_max_body_size_" description="Taille maximum du corps pour " provider="ReverseProxy:max_body_size" unique="False"/> <variable name="revprox_max_body_size_" description="Body size max for " provider="ReverseProxy:max_body_size" unique="False"/>
<variable name="revprox_http_" type="boolean" description="Le site est en HTTP pour " provider="ReverseProxy:http" unique="False"/> <variable name="revprox_http_" type="boolean" description="The website is in HTTP for " provider="ReverseProxy:http" unique="False"/>
</family> </family>
</family> </family>
<variable name="revprox_domainnames" type="domainname" description="Nom des domaines auto-configurés dans le serveur mandataire inverse" multi="True" hidden="True" mandatory="False"/> <variable name="revprox_domainnames" type="domainname" description="Nom des domaines auto-configurés dans le serveur mandataire inverse" multi="True" hidden="True" mandatory="False"/>

150
seed/nginx-static/README.md
View file

@ -3,73 +3,14 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# nginx-static # nginx-static
## Synopsis ## Synopsis
Nginx as static web site.
[Software's website.](https://nginx.org/) [Nginx as static web site.](https://nginx.org/)
## Basic variables
### Général
#### Reverse proxy
##### Point d'entrée des clients
This family is a leadership.
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**<br/>mandatory, multiple<br/>**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.<br/>**Example:** service.example.net |
| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**<br/>mandatory<br/>**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. |
## Variables
### Général
#### NGINX
Paramétrage global de NGINX.
| Parameter | Comments |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|
| **[general.nginx.nginx_root](dictionaries/22_nginx_static.xml)**<br/>mandatory<br/>**Type:** [`filename`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Adresse racine du site web.<br/>**Default:** /srv/static |
## Variables for expert
### Général
#### NGINX
Paramétrage global de NGINX.
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Longueur maximum pour un nom de domaine.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximale des données reçues par la méthode POST (en Mo).<br/>**Default:** 32 |
#### Reverse proxy
##### Point d'entrée des clients
This family is a leadership.
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|
| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**<br/>**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. |
## Requirements services
- **LocalDNS**
- Journald
- **ReverseProxy**
**bold**: provider is mandatory
## Example ## Example
@ -86,19 +27,76 @@ nginx-static:
- service.example.net - service.example.net
``` ```
## Basic variables
### General
#### Reverse proxy
##### Clients configuration
This family is a leadership.
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**<br/>mandatory, multiple<br/>**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.<br/>**Example:** service.example.net |
| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** / |
## Variables
### General
#### NGINX
| Parameter | Comment |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|
| **[general.nginx.nginx_root](dictionaries/22_nginx_static.xml)**<br/>mandatory<br/>**Type:** [`filename`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Adresse racine du site web.<br/>**Default:** /srv/static |
#### Reverse proxy
##### Clients configuration
This family is a leadership.
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**<br/>**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. |
## Variables for expert
### General
#### NGINX
| Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The bucket size for the server names hash tables.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](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.<br/>This value is in Mb.<br/>**Default:** 32 |
## Requirements services
### Mandatories
- [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name.
- [ReverseProxy](../README.ReverseProxy.md): Register to service to a reverse proxy server.
### Optionals
- [Journald](../README.Journald.md): Concentrate journal messages on one host.
## Dependances ## Dependances
- [nginx-https](../nginx-https/README.md) - [nginx-https](../nginx-https/README.md): Nginx as HTTPS web site.
- [nginx-common](../nginx-common/README.md) - [nginx-common](../nginx-common/README.md): Nginx common configuration.
- [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.
- [base-fedora-37](../base-fedora-37/README.md) - [base-fedora-37](../base-fedora-37/README.md): Base information of a Fedora 37.
- [base-fedora](../base-fedora/README.md) - [base-fedora](../base-fedora/README.md): Base information of a Fedora.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
[All applications services for this dataset.](../README.md)

77
seed/nsd-local/README.md
View file

@ -3,21 +3,14 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# nsd-local # nsd-local
## Synopsis ## 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
**bold**: provider is mandatory
## Example ## Example
@ -28,28 +21,56 @@ nsd-local:
applicationservice: nsd-local applicationservice: nsd-local
provider_zone: localdns provider_zone: localdns
zones_name: zones_name:
- externaldns
- localdns - localdns
``` ```
## Requirements services
### Mandatories
- [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name.
- [ExternalDNS](../README.ExternalDNS.md): DNS forwarder for all DNS zones.
### Optionals
- [Journald](../README.Journald.md): Concentrate journal messages on one host.
## Dependances ## Dependances
- [nsd](../nsd/README.md) - [nsd](../nsd/README.md): NSD, an authoritative DNS name server.
- [base-fedora-37](../base-fedora-37/README.md) - [base-fedora-37](../base-fedora-37/README.md): Base information of a Fedora 37.
- [base-fedora](../base-fedora/README.md) - [base-fedora](../base-fedora/README.md): Base information of a Fedora.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
## Supplier ## Useful for services
[dns-local](../dns-local/README.md) - [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.
## Provider - [gitea](../gitea/README.md): Transitional package for Gitea to Forgejo.
- [grafana](../grafana/README.md): Grafana is an analytics and interactive visualization web application.
[unbound](../unbound/README.md) - [lemonldap](../lemonldap/README.md): LemonLDAP, a Web Single Sign On and Access Management.
- [loki](../loki/README.md): Loki, a log aggregation platform.
[All applications services for this dataset.](../README.md) - [mailman](../mailman/README.md): GNU Mailman, managing electronic mail discussion and e-newsletter lists.
- [mariadb](../mariadb/README.md): MariaDB, a relational database.
- [nextcloud](../nextcloud/README.md): Nextcloud, Online collaboration platform.
- [nginx-reverse-proxy](../nginx-reverse-proxy/README.md): Nginx as reverse proxy.
- [nginx-static](../nginx-static/README.md): Nginx as static web site.
- [nsd](../nsd/README.md): NSD, an authoritative DNS name server.
- [nsd-local](../nsd-local/README.md): NSD, an authoritative DNS name server for local resolution.
- [odoo](../odoo/README.md): Odoo, an ERP and CRM.
- [openldap](../openldap/README.md): OpenLDAP, the LDAP server.
- [piwigo](../piwigo/README.md): Piwigo, a photo management software.
- [postgresql](../postgresql/README.md): Postgresql, a database.
- [prometheus](../prometheus/README.md): Prometheus, an event monitoring.
- [redis](../redis/README.md): Redis, an in-memory data structure store.
- [roundcube](../roundcube/README.md): Roundcube, a webmail.
- [speedtest-rs](../speedtest-rs/README.md): Speedtest-rs, a very lightweight Speedtest.
- [vaultwarden](../vaultwarden/README.md): Vaultwarden, a password manager.
- [vector](../vector/README.md): Vector, a lightweight, ultra-fast tool for building observability pipelines.

4
seed/nsd-local/dictionaries/21_nsd-local.xml
View file

@ -3,12 +3,12 @@
<variables> <variables>
<family name="dns_server" description="Serveur DNS"> <family name="dns_server" description="Serveur DNS">
<variable name="nsd_allowed_client_cidr" redefine="True" hidden="True"/> <variable name="nsd_allowed_client_cidr" redefine="True" hidden="True"/>
<variable name="nsd_allowed_clients" type="domainname" description="Clients" multi="True" hidden="True" provider="LocalDNS"/> <variable name="nsd_allowed_clients" type="domainname" description="DNS forwarder for local domain name" multi="True" hidden="True" provider="LocalDNS"/>
<family name="nsd_client_" dynamic="nsd_allowed_clients"> <family name="nsd_client_" dynamic="nsd_allowed_clients">
<variable name="nsd_dnssec_ds_" supplier="LocalDNS:DNSSEC_DS" hidden="True" multi="True"/> <variable name="nsd_dnssec_ds_" supplier="LocalDNS:DNSSEC_DS" hidden="True" multi="True"/>
</family> </family>
<variable name="nsd_allowed_client_ip" type="ip" description="Clients" multi="True" hidden="True"/> <variable name="nsd_allowed_client_ip" type="ip" description="Clients" multi="True" hidden="True"/>
<variable name="nsd_resolver" redefine="True" supplier="ExternalDNS"/> <variable name="nsd_resolver" redefine="True" supplier="ExternalDNS" hidden="True"/>
<variable name="nsd_resolve_ip" type="ip" hidden="True"/> <variable name="nsd_resolve_ip" type="ip" hidden="True"/>
</family> </family>
<family name="dns_zone"> <family name="dns_zone">

138
seed/nsd/README.md
View file

@ -3,68 +3,14 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# nsd # nsd
## Synopsis ## 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
### Général
#### Serveur DNS
| Parameter | Comments |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|
| **[general.dns_server.nsd_allowed_client_cidr](dictionaries/20_nsd.xml)**<br/>multiple<br/>**Type:** [`network_cidr`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Clients autorisés à interroger le serveur DNS. |
| **[general.dns_server.nsd_resolver](dictionaries/20_nsd.xml)**<br/>**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 résolveur DNS associé. |
#### Zone DNS
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|
| **[general.dns_zone.nsd_zones](dictionaries/20_nsd.xml)**<br/>mandatory, multiple<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Zones DNS.<br/>**Example:** subdomain.example.net |
#### Zone DNS reverse
This family is a leadership.
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|
| **[general.dns_reverses.nsd_reverse_network](dictionaries/20_nsd.xml)**<br/>multiple<br/>**Type:** [`network_cidr`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Réseau pour la résolution reverse. |
### Nsd
#### Zone *suffix value*
This a dynamic family generated from the variable "general.dns_zone.nsd_zones".
##### Nom d'hôte pour *suffix value*
This family is a leadership.
| Parameter | Comments |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
| **[nsd.nsd_zone_*suffix value*.hostname_*suffix value*.hostname_*suffix value*](extras/nsd/00_nsd.xml)**<br/>mandatory, multiple<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom d'hôte pour . |
| **[nsd.nsd_zone_*suffix value*.hostname_*suffix value*.type_*suffix value*](extras/nsd/00_nsd.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Type pour .<br/>**Choices:**<br/>- `A`<br/>- `CNAME` |
| **[nsd.nsd_zone_*suffix value*.hostname_*suffix value*.ip_*suffix value*](extras/nsd/00_nsd.xml)**<br/>mandatory<br/>**Type:** [`ip`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Adresse IP a renvoyer pour . |
| **[nsd.nsd_zone_*suffix value*.hostname_*suffix value*.cname_*suffix value*](extras/nsd/00_nsd.xml)**<br/>mandatory<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de domaine a renvoyer pour . |
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|
| **[nsd.nsd_zone_*suffix value*.ns_*suffix value*](extras/nsd/00_nsd.xml)**<br/>mandatory, multiple<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom des serveurs de nom de la zone . |
## Requirements services
- **LocalDNS**
- Journald
**bold**: provider is mandatory
## Example ## Example
@ -80,20 +26,76 @@ nsd:
- subdomain.example.net - subdomain.example.net
``` ```
## Basic variables
### General
#### Serveur DNS
| Parameter | Comment |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|
| **[general.dns_server.nsd_allowed_client_cidr](dictionaries/20_nsd.xml)**<br/>multiple<br/>**Type:** [`network_cidr`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Clients autorisés à interroger le serveur DNS. |
| **[general.dns_server.nsd_resolver](dictionaries/20_nsd.xml)**<br/>**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 résolveur DNS associé. |
#### Zone DNS
| Parameter | Comment |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|
| **[general.dns_zone.nsd_zones](dictionaries/20_nsd.xml)**<br/>mandatory, multiple<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Zones DNS.<br/>**Example:** subdomain.example.net |
#### Zone DNS reverse
This family is a leadership.
| Parameter | Comment |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|
| **[general.dns_reverses.nsd_reverse_network](dictionaries/20_nsd.xml)**<br/>multiple<br/>**Type:** [`network_cidr`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Réseau pour la résolution reverse. |
### Nsd
#### Zone *suffix value*
This a dynamic family generated from the variable "general.dns_zone.nsd_zones".
##### Nom d'hôte pour *suffix value*
This family is a leadership.
| Parameter | Comments |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------|
| **[nsd.nsd_zone_*suffix value*.hostname_*suffix value*.hostname_*suffix value*](extras/nsd/00_nsd.xml)**<br/>mandatory, multiple<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom d'hôte pour *suffix value*. |
| **[nsd.nsd_zone_*suffix value*.hostname_*suffix value*.type_*suffix value*](extras/nsd/00_nsd.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Type pour *suffix value*.<br/>**Choices:**<br/>- `A` ← default<br/>- `CNAME` |
| **[nsd.nsd_zone_*suffix value*.hostname_*suffix value*.ip_*suffix value*](extras/nsd/00_nsd.xml)**<br/>mandatory<br/>**Type:** [`ip`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Adresse IP a renvoyer pour *suffix value*. |
| **[nsd.nsd_zone_*suffix value*.hostname_*suffix value*.cname_*suffix value*](extras/nsd/00_nsd.xml)**<br/>mandatory<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de domaine a renvoyer pour *suffix value*. |
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------|
| **[nsd.nsd_zone_*suffix value*.ns_*suffix value*](extras/nsd/00_nsd.xml)**<br/>mandatory, multiple<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom des serveurs de nom de la zone *suffix value*. |
## Requirements services
### Mandatories
- [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name.
### Optionals
- [Journald](../README.Journald.md): Concentrate journal messages on one host.
## Dependances ## Dependances
- [base-fedora-37](../base-fedora-37/README.md) - [base-fedora-37](../base-fedora-37/README.md): Base information of a Fedora 37.
- [base-fedora](../base-fedora/README.md) - [base-fedora](../base-fedora/README.md): Base information of a Fedora.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
## Used by ## Used by
[nsd-local](../nsd-local/README.md) [nsd-local](../nsd-local/README.md)
[All applications services for this dataset.](../README.md)

30
seed/oauth2-client/README.md
View file

@ -3,25 +3,36 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# oauth2-client # oauth2-client
## Synopsis ## Synopsis
Application service needs interact with a Oauth2 server. Application service needs interact with a Oauth2 server.
## Basic variables
### General
## Variables for expert
### Général
#### OAuth2 client #### OAuth2 client
| Parameter | Comments | | Parameter | Comment |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------| |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| **[general.oauth2_client.oauth2_client_name](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.<br/>**Example:** example | | **[general.oauth2_client.oauth2_client_name](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.<br/>**Example:** example |
| **[general.oauth2_client.oauth2_client_description](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.<br/>**Example:** Example description | | **[general.oauth2_client.oauth2_client_description](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.<br/>**Example:** Example description |
| **[general.oauth2_client.oauth2_client_login](dictionaries/30_oauth2_client.xml)**<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 URL to valid login. |
## Variables
### General
#### OAuth2 client
| Parameter | Comment |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|
| **[general.oauth2_client.oauth2_client_login](dictionaries/30_oauth2_client.xml)**<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 URL to valid login. |
##### external ##### external
@ -35,6 +46,7 @@ Application service needs interact with a Oauth2 server.
| **[general.oauth2_client.oauth2_client_category](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.<br/>**Default:** Défaut | | **[general.oauth2_client.oauth2_client_category](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.<br/>**Default:** Défaut |
| **[general.oauth2_client.oauth2_client_logo](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.<br/>**Default:** demo.png | | **[general.oauth2_client.oauth2_client_logo](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.<br/>**Default:** demo.png |
## Used by ## Used by
- [odoo](../odoo/README.md) - [odoo](../odoo/README.md)
@ -46,9 +58,3 @@ Application service needs interact with a Oauth2 server.
- [forgejo](../forgejo/README.md) - [forgejo](../forgejo/README.md)
- [roundcube](../roundcube/README.md) - [roundcube](../roundcube/README.md)
- [nextcloud](../nextcloud/README.md) - [nextcloud](../nextcloud/README.md)
## Provider
[lemonldap](../lemonldap/README.md)
[All applications services for this dataset.](../README.md)

6
seed/oauth2-client/dictionaries/30_oauth2_client.xml
View file

@ -5,8 +5,8 @@
</services> </services>
<variables> <variables>
<family name="oauth2_client" description="OAuth2 client"> <family name="oauth2_client" description="OAuth2 client">
<variable name="oauth2_client_server_domainname" type="domainname" description="OAuth2 server domain name" mandatory='True' supplier="OAuth2"/> <variable name="oauth2_client_server_domainname" type="domainname" mandatory='True' supplier="OAuth2" hidden="True"/>
<variable name="oauth2_is_client_application" type="boolean" description="OAuth2 client is an application" mandatory='True' hidden="True"> <variable name="oauth2_is_client_application" type="boolean" mandatory='True' hidden="True">
<value>False</value> <value>False</value>
</variable> </variable>
<variable name="oauth2_client_name" description="OAuth2 client name" mandatory='True' supplier="OAuth2:name" test="example"/> <variable name="oauth2_client_name" description="OAuth2 client name" mandatory='True' supplier="OAuth2:name" test="example"/>
@ -31,7 +31,7 @@
<choice>HS512</choice> <choice>HS512</choice>
<choice>RS256</choice> <choice>RS256</choice>
</variable> </variable>
<variable name="oauth2_server_domainname" type="domainname" description="OAuth2 server external domain name" mandatory='True' provider="OAuth2:external_domain"/> <variable name="oauth2_server_domainname" description="OAuth2 server domain name" type="domainname" mandatory='True' provider="OAuth2:external_domain" hidden="True"/>
</family> </family>
</variables> </variables>
<constraints> <constraints>

187
seed/odoo/README.md
View file

@ -3,28 +3,59 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# odoo # odoo
## Synopsis ## Synopsis
Odoo, an ERP and CRM.
[Software's website.](https://www.odoo.com/fr) [Odoo, an ERP and CRM.](https://www.odoo.com/fr)
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
```
odoo:
applicationservice: odoo
zones_name:
- ldap
- localdns
- oauth2
- postgresql
- reverseproxy
- smtp
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
general.odoo.odoo_admin_email: johndoe@example.net
general.odoo.odoo_company_name: ACME
general.odoo.odoo_company_street: John Doe Street
general.odoo.odoo_company_city: Dijon
general.odoo.odoo_company_zip: '21000'
general.odoo.odoo_company_vat: FR 99999999999
general.odoo.odoo_company_registry: 999 999 999 00099
general.odoo.odoo_company_email: johndoe@example.net
general.odoo.odoo_company_website: https://example.net
general.odoo.odoo_company_logo: /home/jdoe/logo.png
general.odoo.odoo_company_footer: foot
```
## Basic variables ## Basic variables
### Général ### General
#### Reverse proxy #### Reverse proxy
##### Point d'entrée des clients ##### Clients configuration
This family is a leadership. This family is a leadership.
| Parameter | Comments | | Parameter | Comment |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**<br/>mandatory, multiple<br/>**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.<br/>**Example:** service.example.net | | **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**<br/>mandatory, multiple<br/>**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.<br/>**Example:** service.example.net |
| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**<br/>mandatory<br/>**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. | | **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** / |
#### Odoo #### Odoo
@ -45,53 +76,31 @@ This family is a leadership.
| **[general.odoo.odoo_company_footer](dictionaries/40_odoo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Pied de page des documents.<br/>**Example:** foot | | **[general.odoo.odoo_company_footer](dictionaries/40_odoo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Pied de page des documents.<br/>**Example:** foot |
| **[general.odoo.odoo_company_layout](dictionaries/40_odoo.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Agencement des documents.<br/>**Choices:**<br/>- `standard` ← default<br/>- `bold`<br/>- `boxed`<br/>- `striped` | | **[general.odoo.odoo_company_layout](dictionaries/40_odoo.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Agencement des documents.<br/>**Choices:**<br/>- `standard` ← default<br/>- `bold`<br/>- `boxed`<br/>- `striped` |
## Variables
## Variables for expert ### General
### Général #### OpenLDAP directory
#### Annuaire OpenLDAP
##### Client ##### Client
| Parameter | Comments | | Parameter | Comment |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------| |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|
| **[general.ldap.client.ldapclient_family](dictionaries/21_ldap-client.xml)**<br/>**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. | | **[general.ldap.client.ldapclient_family](dictionaries/21_ldap-client.xml)**<br/>**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.<br/>"all" for all families. |
| **[general.ldap.client.ldapclient_base_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
| **[general.ldap.client.ldapclient_search_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
| **[general.ldap.client.ldapclient_group_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
| **[general.ldap.client.ldapclient_user_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
#### NGINX
Paramétrage global de NGINX.
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Longueur maximum pour un nom de domaine.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximale des données reçues par la méthode POST (en Mo).<br/>**Default:** 32 |
#### Reverse proxy #### Reverse proxy
##### Point d'entrée des clients ##### Clients configuration
This family is a leadership. This family is a leadership.
| Parameter | Comments | | Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**<br/>**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. | | **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**<br/>**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. |
#### PostgreSQL
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|
| **[general.postgresql.pg_client_username](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client username.<br/>**Default:** *calculated* |
| **[general.postgresql.pg_client_password](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client password.<br/>**Default:** *calculated* |
| **[general.postgresql.pg_client_database](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client database.<br/>**Default:** *calculated* |
#### OAuth2 client #### OAuth2 client
| Parameter | Comments | | Parameter | Comment |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------|
| **[general.oauth2_client.oauth2_client_name](dictionaries/40_odoo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.<br/>**Default:** ERP<br/>**Example:** example | | **[general.oauth2_client.oauth2_client_name](dictionaries/40_odoo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.<br/>**Default:** ERP<br/>**Example:** example |
| **[general.oauth2_client.oauth2_client_description](dictionaries/40_odoo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.<br/>**Default:** ERP Odoo<br/>**Example:** Example description | | **[general.oauth2_client.oauth2_client_description](dictionaries/40_odoo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.<br/>**Default:** ERP Odoo<br/>**Example:** Example description |
@ -104,11 +113,24 @@ This family is a leadership.
| **[general.oauth2_client.external.oauth2_client_external](dictionaries/40_odoo.xml)**<br/>mandatory, multiple<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client external.<br/>**Default:** *calculated* | | **[general.oauth2_client.external.oauth2_client_external](dictionaries/40_odoo.xml)**<br/>mandatory, multiple<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client external.<br/>**Default:** *calculated* |
| **[general.oauth2_client.external.oauth2_client_family](dictionaries/40_odoo.xml)**<br/>mandatory, multiple<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 family.<br/>**Default:** <ul><li>users</li></ul> | | **[general.oauth2_client.external.oauth2_client_family](dictionaries/40_odoo.xml)**<br/>mandatory, multiple<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 family.<br/>**Default:** <ul><li>users</li></ul> |
| Parameter | Comments | | Parameter | Comment |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------| |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|
| **[general.oauth2_client.oauth2_client_category](dictionaries/40_odoo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.<br/>**Default:** Entreprise | | **[general.oauth2_client.oauth2_client_category](dictionaries/40_odoo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.<br/>**Default:** Entreprise |
| **[general.oauth2_client.oauth2_client_logo](dictionaries/40_odoo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.<br/>**Default:** silique_note.png | | **[general.oauth2_client.oauth2_client_logo](dictionaries/40_odoo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.<br/>**Default:** silique_note.png |
## Variables for expert
### General
#### NGINX
| Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The bucket size for the server names hash tables.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](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.<br/>This value is in Mb.<br/>**Default:** 32 |
#### Odoo #### Odoo
| Parameter | Comments | | Parameter | Comments |
@ -117,64 +139,35 @@ This family is a leadership.
## Requirements services ## Requirements services
- **LocalDNS** ### Mandatories
- Journald
- **SMTP**
- **LDAP**
- **ReverseProxy**
- **Postgresql**
- **OAuth2**
**bold**: provider is mandatory - [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name.
- [SMTP](../README.SMTP.md): Create a SMTP relay account and authorize sending email.
- [LDAP](../README.LDAP.md): Create account and connexion to a LDAP server.
- [ReverseProxy](../README.ReverseProxy.md): Register to service to a reverse proxy server.
- [Postgresql](../README.Postgresql.md): Create account and connexion to a PostgreSQL server.
- [OAuth2](../README.OAuth2.md): Remote clients needing to verify OAuth2 account.
## Example ### Optionals
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. - [Journald](../README.Journald.md): Concentrate journal messages on one host.
```
odoo:
applicationservice: odoo
zones_name:
- ldap
- localdns
- reverseproxy
- smtp
- oauth2
- postgresql
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
general.odoo.odoo_admin_email: johndoe@example.net
general.odoo.odoo_company_name: ACME
general.odoo.odoo_company_street: John Doe Street
general.odoo.odoo_company_city: Dijon
general.odoo.odoo_company_zip: '21000'
general.odoo.odoo_company_vat: FR 99999999999
general.odoo.odoo_company_registry: 999 999 999 00099
general.odoo.odoo_company_email: johndoe@example.net
general.odoo.odoo_company_website: https://example.net
general.odoo.odoo_company_logo: /home/jdoe/logo.png
general.odoo.odoo_company_footer: foot
```
## Dependances ## Dependances
- [base-debian-bullseye](../base-debian-bullseye/README.md) - [base-debian-bullseye](../base-debian-bullseye/README.md): Base information of a Debian Bulleye server.
- [base-debian](../base-debian/README.md) - [base-debian](../base-debian/README.md): Base information of a Debian server.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
- [postgresql-client](../postgresql-client/README.md) - [postgresql-client](../postgresql-client/README.md): Application service needs interact with a Postgresql server.
- [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.
- [relay-mail-client](../relay-mail-client/README.md) - [relay-mail-client](../relay-mail-client/README.md): Client SMTP.
- [ldap-client](../ldap-client/README.md) - [ldap-client](../ldap-client/README.md): Application service needs interact with a LDAP server.
- [oauth2-client](../oauth2-client/README.md) - [oauth2-client](../oauth2-client/README.md): Application service needs interact with a Oauth2 server.
- [nginx-https](../nginx-https/README.md) - [nginx-https](../nginx-https/README.md): Nginx as HTTPS web site.
- [nginx-common](../nginx-common/README.md) - [nginx-common](../nginx-common/README.md): Nginx common configuration.
- [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.
[All applications services for this dataset.](../README.md)

86
seed/openldap/README.md
View file

@ -3,13 +3,14 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# openldap # openldap
## Synopsis ## 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. This service provides a LDAP server.
@ -21,6 +22,17 @@ initial password will be generated but never updated. You can modify them.
Other services may also require automatic user creation. Other services may also require automatic user creation.
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
```
openldap:
applicationservice: openldap
provider_zone: ldap
zones_name:
- localdns
```
## Variables ## Variables
@ -39,7 +51,7 @@ Management of manually created local users. Those users are not classified. This
| **[accounts.users.ldap_user_gn](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Given name.<br/>**Example:** John | | **[accounts.users.ldap_user_gn](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Given name.<br/>**Example:** John |
| **[accounts.users.ldap_user_sn](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Surname.<br/>**Example:** Doe | | **[accounts.users.ldap_user_sn](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Surname.<br/>**Example:** Doe |
| Parameter | Comments | | Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------| |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|
| **[accounts.families](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Families to create.<br/>Users can be classified into families. This variable contains all the names of the families to be created. | | **[accounts.families](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Families to create.<br/>Users can be classified into families. This variable contains all the names of the families to be created. |
@ -51,27 +63,27 @@ This a dynamic family generated from the variable "accounts.families".
Management of manually created users. Those users are classified in a family. This family is a leadership. Management of manually created users. Those users are classified in a family. This family is a leadership.
| Parameter | Comments | | Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------| |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|
| **[accounts.family_*suffix value*.users_*suffix value*.ldap_user_mail_*suffix value*](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Email address for the family .<br/>An user is identify by his email address.<br/>**Example:** johndoe@family.net | | **[accounts.family_*suffix value*.users_*suffix value*.ldap_user_mail_*suffix value*](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Email address for the family *suffix value*.<br/>An user is identify by his email address.<br/>**Example:** johndoe@family.net |
| **[accounts.family_*suffix value*.users_*suffix value*.ldap_user_aliases_*suffix value*](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Emails aliases for the family .<br/>**Example:** jdoe@family.net | | **[accounts.family_*suffix value*.users_*suffix value*.ldap_user_aliases_*suffix value*](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Emails aliases for the family *suffix value*.<br/>**Example:** jdoe@family.net |
| **[accounts.family_*suffix value*.users_*suffix value*.ldap_user_uid_*suffix value*](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Account name for the family .<br/>**Example:** jdoe | | **[accounts.family_*suffix value*.users_*suffix value*.ldap_user_uid_*suffix value*](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Account name for the family *suffix value*.<br/>**Example:** jdoe |
| **[accounts.family_*suffix value*.users_*suffix value*.ldap_user_gn_*suffix value*](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Given name for the family .<br/>**Example:** John | | **[accounts.family_*suffix value*.users_*suffix value*.ldap_user_gn_*suffix value*](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Given name for the family *suffix value*.<br/>**Example:** John |
| **[accounts.family_*suffix value*.users_*suffix value*.ldap_user_sn_*suffix value*](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Surname for the family .<br/>**Example:** Doe | | **[accounts.family_*suffix value*.users_*suffix value*.ldap_user_sn_*suffix value*](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Surname for the family *suffix value*.<br/>**Example:** Doe |
## Variables for expert ## Variables for expert
### Général ### General
#### LDAP #### LDAP
| Parameter | Comments | | Parameter | Comment |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.ldap.ldap_schemas](dictionaries/21_openldap-server.xml)**<br/>mandatory, multiple<br/>**Type:** [`filename`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Additional LDAP schemas.<br/>**Default:** <ul><li>/etc/openldap/schema/cosine.ldif</li><li>/etc/openldap/schema/inetorgperson.ldif</li><li>/etc/openldap/schema/nis.ldif</li><li>/etc/openldap/schema/misc.ldif</li></ul> | | **[general.ldap.ldap_schemas](dictionaries/21_openldap-server.xml)**<br/>mandatory, multiple<br/>**Type:** [`filename`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Additional LDAP schemas.<br/>**Default:** <ul><li>/etc/openldap/schema/cosine.ldif</li><li>/etc/openldap/schema/inetorgperson.ldif</li><li>/etc/openldap/schema/nis.ldif</li><li>/etc/openldap/schema/misc.ldif</li></ul> |
##### Limits ##### Limits
| Parameter | Comments | | Parameter | Comment |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------| |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|
| **[general.ldap.limits.ldap_loglevel](dictionaries/21_openldap-server.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Log level.<br/>**Default:** 0 | | **[general.ldap.limits.ldap_loglevel](dictionaries/21_openldap-server.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Log level.<br/>**Default:** 0 |
| **[general.ldap.limits.ldap_sizelimit](dictionaries/21_openldap-server.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nombre maximum d'entrées à retourner lors d'une requête.<br/>**Default:** 5000 | | **[general.ldap.limits.ldap_sizelimit](dictionaries/21_openldap-server.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nombre maximum d'entrées à retourner lors d'une requête.<br/>**Default:** 5000 |
@ -79,7 +91,7 @@ Management of manually created users. Those users are classified in a family. Th
##### DB environment ##### DB environment
| Parameter | Comments | | Parameter | Comment |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------| |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
| **[general.ldap.db_environment.db_cache_size_g](dictionaries/21_openldap-server.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Quantité de Giga-octets à utiliser pour le cache HDB.<br/>**Default:** 0 | | **[general.ldap.db_environment.db_cache_size_g](dictionaries/21_openldap-server.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Quantité de Giga-octets à utiliser pour le cache HDB.<br/>**Default:** 0 |
| **[general.ldap.db_environment.db_cache_size_o](dictionaries/21_openldap-server.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Quantité d'octets à utiliser pour le cache HDB.<br/>**Default:** 268435456 | | **[general.ldap.db_environment.db_cache_size_o](dictionaries/21_openldap-server.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Quantité d'octets à utiliser pour le cache HDB.<br/>**Default:** 268435456 |
@ -96,37 +108,31 @@ Management of manually created users. Those users are classified in a family. Th
## Requirements services ## Requirements services
- **LocalDNS** ### Mandatories
- Journald
**bold**: provider is mandatory - [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name.
## Example ### Optionals
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. - [Journald](../README.Journald.md): Concentrate journal messages on one host.
```
openldap:
applicationservice: openldap
provider_zone: ldap
zones_name:
- localdns
```
## Dependances ## Dependances
- [base-fedora-37](../base-fedora-37/README.md) - [base-fedora-37](../base-fedora-37/README.md): Base information of a Fedora 37.
- [base-fedora](../base-fedora/README.md) - [base-fedora](../base-fedora/README.md): Base information of a Fedora.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
## Supplier ## Useful for services
[ldap-client](../ldap-client/README.md) - [dovecot](../dovecot/README.md): Postfix and Dovecot as mail servers (IMAP and submission).
- [lemonldap](../lemonldap/README.md): LemonLDAP, a Web Single Sign On and Access Management.
[All applications services for this dataset.](../README.md) - [nextcloud](../nextcloud/README.md): Nextcloud, Online collaboration platform.
- [odoo](../odoo/README.md): Odoo, an ERP and CRM.
- [piwigo](../piwigo/README.md): Piwigo, a photo management software.
- [roundcube](../roundcube/README.md): Roundcube, a webmail.

10
seed/openldap/extras/accounts/00_account.xml
View file

@ -1,12 +1,12 @@
<?xml version='1.0' encoding='UTF-8'?> <?xml version='1.0' encoding='UTF-8'?>
<rougail version="0.10"> <rougail version="0.10">
<variables> <variables>
<variable name="remotes" description="Remote services with an account" type="domainname" multi="True" provider="LDAP"/> <variable name="remotes" description="Create account and connexion to a LDAP server" type="domainname" multi="True" provider="LDAP" hidden="True"/>
<family name="remote_" dynamic="accounts.remotes" hidden="True"> <family name="remote_" dynamic="accounts.remotes" hidden="True">
<variable name="family_" provider="LDAP:family"/> <variable description="LDAP family name for " name="family_" provider="LDAP:family"/>
<variable name="dn_" provider="LDAP:dn"/> <variable description="LDAP account DN for " name="dn_" provider="LDAP:dn"/>
<variable name="password_" type="password" provider="LDAP:password"/> <variable description="LDAP passowrd for " name="password_" type="password" provider="LDAP:password"/>
<variable name="base_dn_" provider="LDAP:base_dn"/> <variable description="LDAP base DN for " name="base_dn_" provider="LDAP:base_dn"/>
</family> </family>
<family name="users" description="Users management" leadership="True" help="Management of manually created local users. Those users are not classified."> <family name="users" description="Users management" leadership="True" help="Management of manually created local users. Those users are not classified.">
<variable name='ldap_user_mail' type="mail" description="Email address" multi="True" test="johndoe@example.net" help="An user is identify by his email address."/> <variable name='ldap_user_mail' type="mail" description="Email address" multi="True" test="johndoe@example.net" help="An user is identify by his email address."/>

179
seed/peertube/README.md
View file

@ -3,28 +3,49 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# peertube # peertube
## Synopsis ## 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/)
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
```
peertube:
applicationservice: peertube
zones_name:
- externaldns
- oauth2
- postgresql
- redis
- reverseproxy
- smtp
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
general.peertube.peertube_admin_email: john.doe@example.net
```
## Basic variables ## Basic variables
### Général ### General
#### Reverse proxy #### Reverse proxy
##### Point d'entrée des clients ##### Clients configuration
This family is a leadership. This family is a leadership.
| Parameter | Comments | | Parameter | Comment |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**<br/>mandatory, multiple<br/>**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.<br/>**Example:** service.example.net | | **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**<br/>mandatory, multiple<br/>**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.<br/>**Example:** service.example.net |
| **[general.revprox.revprox_client.revprox_client_location](dictionaries/30_peertube.xml)**<br/>mandatory<br/>**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. | | **[general.revprox.revprox_client.revprox_client_location](dictionaries/30_peertube.xml)**<br/>mandatory<br/>**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.<br/>**Default:** / |
#### peertube #### peertube
@ -34,56 +55,21 @@ This family is a leadership.
## Variables ## Variables
### Général ### General
#### peertube
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.peertube.peertube_short_description](dictionaries/30_peertube.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Description courte de l'instance.<br/>**Default:** PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser. |
| **[general.peertube.peertube_description](dictionaries/30_peertube.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Description de l'instance.<br/>**Default:** Welcome to this PeerTube instance! |
## Variables for expert
### Général
#### NGINX
Paramétrage global de NGINX.
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Longueur maximum pour un nom de domaine.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximale des données reçues par la méthode POST (en Mo).<br/>**Default:** 32 |
#### Reverse proxy #### Reverse proxy
##### Point d'entrée des clients ##### Clients configuration
This family is a leadership. This family is a leadership.
| Parameter | Comments | | Parameter | Comment |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/30_peertube.xml)**<br/>mandatory<br/>**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. | | **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/30_peertube.xml)**<br/>mandatory<br/>**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.<br/>**Default:** 12G |
#### PostgreSQL
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|
| **[general.postgresql.pg_client_username](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client username.<br/>**Default:** *calculated* |
| **[general.postgresql.pg_client_password](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client password.<br/>**Default:** *calculated* |
| **[general.postgresql.pg_client_database](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client database.<br/>**Default:** *calculated* |
#### Redis
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|
| **[general.redis.redis_client_username](dictionaries/23_redis.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom d'utilisateur.<br/>**Default:** *calculated* |
| **[general.redis.redis_client_password](dictionaries/23_redis.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
#### OAuth2 client #### OAuth2 client
| Parameter | Comments | | Parameter | Comment |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------| |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|
| **[general.oauth2_client.oauth2_client_name](dictionaries/30_peertube.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.<br/>**Default:** Vidéo<br/>**Example:** example | | **[general.oauth2_client.oauth2_client_name](dictionaries/30_peertube.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.<br/>**Default:** Vidéo<br/>**Example:** example |
| **[general.oauth2_client.oauth2_client_description](dictionaries/30_peertube.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.<br/>**Default:** Plateforme de partage de vidéo Peertube<br/>**Example:** Example description | | **[general.oauth2_client.oauth2_client_description](dictionaries/30_peertube.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.<br/>**Default:** Plateforme de partage de vidéo Peertube<br/>**Example:** Example description |
@ -96,65 +82,64 @@ This family is a leadership.
| **[general.oauth2_client.external.oauth2_client_external](dictionaries/30_peertube.xml)**<br/>mandatory, multiple<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client external.<br/>**Default:** *calculated* | | **[general.oauth2_client.external.oauth2_client_external](dictionaries/30_peertube.xml)**<br/>mandatory, multiple<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client external.<br/>**Default:** *calculated* |
| **[general.oauth2_client.external.oauth2_client_family](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 family.<br/>**Default:** users | | **[general.oauth2_client.external.oauth2_client_family](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 family.<br/>**Default:** users |
| Parameter | Comments | | Parameter | Comment |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------| |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|
| **[general.oauth2_client.oauth2_client_category](dictionaries/30_peertube.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.<br/>**Default:** Réseaux sociaux | | **[general.oauth2_client.oauth2_client_category](dictionaries/30_peertube.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.<br/>**Default:** Réseaux sociaux |
| **[general.oauth2_client.oauth2_client_logo](dictionaries/30_peertube.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.<br/>**Default:** silique_video.png | | **[general.oauth2_client.oauth2_client_logo](dictionaries/30_peertube.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.<br/>**Default:** silique_video.png |
#### peertube
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.peertube.peertube_short_description](dictionaries/30_peertube.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Description courte de l'instance.<br/>**Default:** PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser. |
| **[general.peertube.peertube_description](dictionaries/30_peertube.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Description de l'instance.<br/>**Default:** Welcome to this PeerTube instance! |
## Variables for expert
### General
#### NGINX
| Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The bucket size for the server names hash tables.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](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.<br/>This value is in Mb.<br/>**Default:** 32 |
## Requirements services ## Requirements services
- **ExternalDNS** ### Mandatories
- Journald
- **SMTP**
- **ReverseProxy**
- **Postgresql**
- **Redis**
- **OAuth2**
**bold**: provider is mandatory - [SMTP](../README.SMTP.md): Create a SMTP relay account and authorize sending email.
- [ReverseProxy](../README.ReverseProxy.md): Register to service to a reverse proxy server.
- [Postgresql](../README.Postgresql.md): Create account and connexion to a PostgreSQL server.
- [OAuth2](../README.OAuth2.md): Remote clients needing to verify OAuth2 account.
- [ExternalDNS](../README.ExternalDNS.md): DNS forwarder for all DNS zones.
- [Redis](../README.Redis.md): Create account and connexion to a Redis server.
## Example ### Optionals
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. - [Journald](../README.Journald.md): Concentrate journal messages on one host.
```
peertube:
applicationservice: peertube
zones_name:
- localdns
- reverseproxy
- smtp
- redis
- oauth2
- postgresql
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
general.peertube.peertube_admin_email: john.doe@example.net
```
## Dependances ## Dependances
- [base-fedora-38](../base-fedora-38/README.md) - [base-fedora-38](../base-fedora-38/README.md): Base information of a Fedora 38.
- [base-fedora](../base-fedora/README.md) - [base-fedora](../base-fedora/README.md): Base information of a Fedora.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
- [dns-external](../dns-external/README.md) - [dns-external](../dns-external/README.md): DNS client with resolution on all zones (especially outside).
- [postgresql-client](../postgresql-client/README.md) - [postgresql-client](../postgresql-client/README.md): Application service needs interact with a Postgresql server.
- [relay-mail-client](../relay-mail-client/README.md) - [relay-mail-client](../relay-mail-client/README.md): Client SMTP.
- [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.
- [redis-client](../redis-client/README.md) - [redis-client](../redis-client/README.md): Application service needs interact with a Redis server.
- [redis-common](../redis-common/README.md) - [redis-common](../redis-common/README.md): Redis, an in-memory data structure store.
- [nginx-https](../nginx-https/README.md) - [nginx-https](../nginx-https/README.md): Nginx as HTTPS web site.
- [nginx-common](../nginx-common/README.md) - [nginx-common](../nginx-common/README.md): Nginx common configuration.
- [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.
- [oauth2-client](../oauth2-client/README.md) - [oauth2-client](../oauth2-client/README.md): Application service needs interact with a Oauth2 server.
[All applications services for this dataset.](../README.md)

6
seed/php-fpm/README.md
View file

@ -3,6 +3,8 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# php-fpm # php-fpm
## Synopsis ## Synopsis
@ -11,12 +13,10 @@ PHP FPM.
## Dependances ## Dependances
- [php](../php/README.md) - [php](../php/README.md): PHP, a popular general-purpose scripting language.
## Used by ## Used by
- [piwigo](../piwigo/README.md) - [piwigo](../piwigo/README.md)
- [roundcube](../roundcube/README.md) - [roundcube](../roundcube/README.md)
- [nextcloud](../nextcloud/README.md) - [nextcloud](../nextcloud/README.md)
[All applications services for this dataset.](../README.md)

30
seed/php/README.md
View file

@ -3,40 +3,34 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# php # php
## Synopsis ## 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/)
## Variables for expert ## Variables for expert
### Général ### General
#### PHP #### PHP
Paramètrage avancé de PHP. Paramètrage avancé de PHP.
| Parameter | Comments | | Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|
| **[general.php.php_post_max_size](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximale des données reçues par la méthode POST.<br/>Valeur en Mo.<br/>**Default:** 32 | | **[general.php.php_post_max_size](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Maximum size of POST data that PHP will accept.<br/>Value in Mb.<br/>**Default:** 32 |
| **[general.php.php_upload_max_filesize](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximale d'un fichier à charger.<br/>Valeur en Mo.<br/>**Default:** 16 | | **[general.php.php_upload_max_filesize](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Maximum allowed size for uploaded files.<br/>Value in Mb.<br/>**Default:** 16 |
| **[general.php.php_max_execution_time](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Temps maximal d'exécution d'un script.<br/>Valeur en secondes.<br/>**Default:** 30 | | **[general.php.php_max_execution_time](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Maximum amount of time each script may spend parsing request data.<br/>Value in seconds.<br/>**Default:** 30 |
| **[general.php.php_max_input_time](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Durée maximale pour analyser les données d'entrée.<br/>Valeur en secondes.<br/>**Default:** 60 | | **[general.php.php_max_input_time](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Maximum amount of time each script may spend parsing request data.<br/>Value in seconds.<br/>**Default:** 60 |
| **[general.php.php_memory_limit](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille mémoire maximale qu'un script est autorisé à allouer.<br/>Valeur en Mo.<br/>**Default:** 512 | | **[general.php.php_memory_limit](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Maximum amount of memory a script may consume.<br/>Value in Mb.<br/>**Default:** 512 |
| **[general.php.php_display_errors](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`boolean`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Affichage des erreurs à l'écran.<br/>**Default:** False | | **[general.php.php_session_gc_maxlifetime](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Data will be seen as 'garbage' and potentially cleaned up after this delay.<br/>Value in seconds.<br/>**Default:** 3600 |
| **[general.php.php_session_gc_maxlifetime](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Durée de vie des données sur le serveur.<br/>Valeur en secondes.<br/>**Default:** 3600 |
| **[general.php.php_browscap](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`boolean`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Activer la directive de configuration browscap.<br/>La directive de configuration browscap permet d'obtenir plus d'information sur les capacités du navigateur client grâce à la fonction get_browser().<br/>**Default:** False |
| **[general.php.time_zone](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Fuseau horaire.<br/>**Default:** Europe/Paris |
| **[general.php.php_enable_output_buffering](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`boolean`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Activer les tampons de sortie.<br/>**Default:** True |
| **[general.php.php_disable_pcntl](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`boolean`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Désactiver PCNTL.<br/>**Default:** True |
## Used by ## Used by
[php-fpm](../php-fpm/README.md) [php-fpm](../php-fpm/README.md)
[All applications services for this dataset.](../README.md)

25
seed/php/dictionaries/20_php.xml
View file

@ -7,37 +7,28 @@
</services> </services>
<variables> <variables>
<family name="php" description="PHP" mode="expert" help="Paramètrage avancé de PHP"> <family name="php" description="PHP" mode="expert" help="Paramètrage avancé de PHP">
<variable name="php_post_max_size" type="number" description="Taille maximale des données reçues par la méthode POST" help="Valeur en Mo"> <variable name="php_post_max_size" type="number" description="Maximum size of POST data that PHP will accept" help="Value in Mb">
<value>32</value> <value>32</value>
</variable> </variable>
<variable name="php_upload_max_filesize" type="number" description="Taille maximale d'un fichier à charger" help="Valeur en Mo"> <variable name="php_upload_max_filesize" type="number" description="Maximum allowed size for uploaded files" help="Value in Mb">
<value>16</value> <value>16</value>
</variable> </variable>
<variable name="php_max_execution_time" type="number" description="Temps maximal d'exécution d'un script" help="Valeur en secondes"> <variable name="php_max_execution_time" type="number" description="Maximum amount of time each script may spend parsing request data" help="Value in seconds">
<value>30</value> <value>30</value>
</variable> </variable>
<variable name="php_max_input_time" type="number" description="Durée maximale pour analyser les données d'entrée" help="Valeur en secondes"> <variable name="php_max_input_time" type="number" description="Maximum amount of time each script may spend parsing request data" help="Value in seconds">
<value>60</value> <value>60</value>
</variable> </variable>
<variable name="php_memory_limit" type="number" description="Taille mémoire maximale qu'un script est autorisé à allouer" help="Valeur en Mo"> <variable name="php_memory_limit" type="number" description="Maximum amount of memory a script may consume" help="Value in Mb">
<value>512</value> <value>512</value>
</variable> </variable>
<variable name="php_display_errors" type="boolean" description="Affichage des erreurs à l'écran"> <variable name="php_session_gc_maxlifetime" type="number" description="Data will be seen as 'garbage' and potentially cleaned up after this delay" help="Value in seconds">
<value>False</value>
</variable>
<variable name="php_session_gc_maxlifetime" type="number" description="Durée de vie des données sur le serveur" help="Valeur en secondes">
<value>3600</value> <value>3600</value>
</variable> </variable>
<variable name="php_browscap" type="boolean" description="Activer la directive de configuration browscap" help="La directive de configuration browscap permet d'obtenir plus d'information sur les capacités du navigateur client grâce à la fonction get_browser()"> <variable name="php_enable_output_buffering" type="boolean" hidden="True">
<value>False</value>
</variable>
<variable name="time_zone" type="string" description="Fuseau horaire">
<value>Europe/Paris</value>
</variable>
<variable name="php_enable_output_buffering" type="boolean" description="Activer les tampons de sortie">
<value>True</value> <value>True</value>
</variable> </variable>
<variable name="php_disable_pcntl" type="boolean" description="Désactiver PCNTL"> <variable name="php_disable_pcntl" type="boolean" hidden="True">
<value>True</value> <value>True</value>
</variable> </variable>
</family> </family>

9
seed/php/templates/php.ini
View file

@ -521,11 +521,7 @@ error_reporting = E_ALL & ~E_DEPRECATED & ~E_STRICT
; Development Value: On ; Development Value: On
; Production Value: Off ; Production Value: Off
; https://php.net/display-errors ; https://php.net/display-errors
{% if general.php.php_display_errors %}
display_errors = On
{% else %}
display_errors = Off display_errors = Off
{% endif %}
; The display of errors which occur during PHP's startup sequence are handled ; The display of errors which occur during PHP's startup sequence are handled
; separately from display_errors. We strongly recommend you set this to 'off' ; separately from display_errors. We strongly recommend you set this to 'off'
@ -963,7 +959,7 @@ cli_server.color = On
; https://php.net/date.timezone ; https://php.net/date.timezone
;date.timezone = ;date.timezone =
;>GNUNUX ;>GNUNUX
date.timezone = "{{ general.php.time_zone }}" date.timezone = "{{ general.base.time_zone }}"
;<GNUNUX ;<GNUNUX
; https://php.net/date.default-latitude ; https://php.net/date.default-latitude
@ -1258,9 +1254,6 @@ bcmath.scale = 0
[browscap] [browscap]
; https://php.net/browscap ; https://php.net/browscap
;browscap = extra/browscap.ini ;browscap = extra/browscap.ini
{% if general.php.php_browscap %}
browscap = /etc/php/extra/browscap.ini
{% endif %}
[Session] [Session]
; Handler used to store/retrieve data. ; Handler used to store/retrieve data.

232
seed/piwigo/README.md
View file

@ -3,32 +3,58 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# piwigo # piwigo
## Synopsis ## Synopsis
Piwigo, a photo management software.
[Software's website.](http://piwigo.org/) [Piwigo, a photo management software.](http://piwigo.org/)
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
```
piwigo:
applicationservice: piwigo
zones_name:
- ldap
- localdns
- mariadb
- oauth2
- redis
- reverseproxy
- smtp
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
general.piwigo.piwigo_admin_email: admin@example.net
general.piwigo.users.piwigo_users:
- jdoe
general.piwigo.users.piwigo_email:
'0': johndoe@example.net
```
## Basic variables ## Basic variables
### Général ### General
#### Reverse proxy #### Reverse proxy
##### Point d'entrée des clients ##### Clients configuration
This family is a leadership. This family is a leadership.
| Parameter | Comments | | Parameter | Comment |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**<br/>mandatory, multiple<br/>**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.<br/>**Example:** service.example.net | | **[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)**<br/>mandatory, multiple<br/>**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.<br/>**Example:** service.example.net |
| **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**<br/>mandatory<br/>**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. | | **[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** / |
#### Piwigo #### Piwigo
| Parameter | Comments | | Parameter | Comment |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------| |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|
| **[general.piwigo.piwigo_admin_email](dictionaries/31_piwigo.xml)**<br/>mandatory<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Adresse courriel de l'administrateur Piwigo.<br/>**Example:** admin@example.net | | **[general.piwigo.piwigo_admin_email](dictionaries/31_piwigo.xml)**<br/>mandatory<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Adresse courriel de l'administrateur Piwigo.<br/>**Example:** admin@example.net |
@ -43,79 +69,29 @@ This family is a leadership.
## Variables ## Variables
### Général ### General
#### Piwigo #### OpenLDAP directory
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|
| **[general.piwigo.piwigo_title](dictionaries/31_piwigo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Titre de l'album.<br/>**Default:** Album photographique |
## Variables for expert
### Général
#### PHP
Paramètrage avancé de PHP.
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.php.php_post_max_size](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximale des données reçues par la méthode POST.<br/>Valeur en Mo.<br/>**Default:** 32 |
| **[general.php.php_upload_max_filesize](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximale d'un fichier à charger.<br/>Valeur en Mo.<br/>**Default:** 16 |
| **[general.php.php_max_execution_time](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Temps maximal d'exécution d'un script.<br/>Valeur en secondes.<br/>**Default:** 30 |
| **[general.php.php_max_input_time](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Durée maximale pour analyser les données d'entrée.<br/>Valeur en secondes.<br/>**Default:** 60 |
| **[general.php.php_memory_limit](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille mémoire maximale qu'un script est autorisé à allouer.<br/>Valeur en Mo.<br/>**Default:** 512 |
| **[general.php.php_display_errors](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`boolean`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Affichage des erreurs à l'écran.<br/>**Default:** False |
| **[general.php.php_session_gc_maxlifetime](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Durée de vie des données sur le serveur.<br/>Valeur en secondes.<br/>**Default:** 3600 |
| **[general.php.php_browscap](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`boolean`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Activer la directive de configuration browscap.<br/>La directive de configuration browscap permet d'obtenir plus d'information sur les capacités du navigateur client grâce à la fonction get_browser().<br/>**Default:** False |
| **[general.php.time_zone](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Fuseau horaire.<br/>**Default:** Europe/Paris |
| **[general.php.php_enable_output_buffering](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`boolean`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Activer les tampons de sortie.<br/>**Default:** True |
| **[general.php.php_disable_pcntl](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`boolean`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Désactiver PCNTL.<br/>**Default:** True |
#### NGINX
Paramétrage global de NGINX.
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Longueur maximum pour un nom de domaine.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximale des données reçues par la méthode POST (en Mo).<br/>**Default:** 32 |
#### Annuaire OpenLDAP
##### Client ##### Client
| Parameter | Comments | | Parameter | Comment |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------| |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|
| **[general.ldap.client.ldapclient_family](dictionaries/21_ldap-client.xml)**<br/>**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. | | **[general.ldap.client.ldapclient_family](dictionaries/21_ldap-client.xml)**<br/>**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.<br/>"all" for all families. |
| **[general.ldap.client.ldapclient_base_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
| **[general.ldap.client.ldapclient_search_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
| **[general.ldap.client.ldapclient_group_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
| **[general.ldap.client.ldapclient_user_dn](dictionaries/21_ldap-client.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
#### Reverse proxy #### Reverse proxy
##### Point d'entrée des clients ##### Clients configuration
This family is a leadership. This family is a leadership.
| Parameter | Comments | | Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
| **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**<br/>**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. | | **[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)**<br/>**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. |
#### Redis
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|
| **[general.redis.redis_client_username](dictionaries/23_redis.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom d'utilisateur.<br/>**Default:** *calculated* |
| **[general.redis.redis_client_password](dictionaries/23_redis.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
#### OAuth2 client #### OAuth2 client
| Parameter | Comments | | Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
| **[general.oauth2_client.oauth2_client_name](dictionaries/31_piwigo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.<br/>**Default:** Album<br/>**Example:** example | | **[general.oauth2_client.oauth2_client_name](dictionaries/31_piwigo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.<br/>**Default:** Album<br/>**Example:** example |
| **[general.oauth2_client.oauth2_client_description](dictionaries/31_piwigo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.<br/>**Default:** Album photographique Piwigo<br/>**Example:** Example description | | **[general.oauth2_client.oauth2_client_description](dictionaries/31_piwigo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.<br/>**Default:** Album photographique Piwigo<br/>**Example:** Example description |
@ -128,72 +104,80 @@ This family is a leadership.
| **[general.oauth2_client.external.oauth2_client_external](dictionaries/30_oauth2_client.xml)**<br/>mandatory, multiple<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client external.<br/>**Default:** *calculated* | | **[general.oauth2_client.external.oauth2_client_external](dictionaries/30_oauth2_client.xml)**<br/>mandatory, multiple<br/>**Type:** [`web_address`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client external.<br/>**Default:** *calculated* |
| **[general.oauth2_client.external.oauth2_client_family](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 family.<br/>**Default:** users | | **[general.oauth2_client.external.oauth2_client_family](dictionaries/30_oauth2_client.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 family.<br/>**Default:** users |
| Parameter | Comments | | Parameter | Comment |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|
| **[general.oauth2_client.oauth2_client_category](dictionaries/31_piwigo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.<br/>**Default:** Diffusion | | **[general.oauth2_client.oauth2_client_category](dictionaries/31_piwigo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.<br/>**Default:** Diffusion |
| **[general.oauth2_client.oauth2_client_logo](dictionaries/31_piwigo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.<br/>**Default:** silique_image.png | | **[general.oauth2_client.oauth2_client_logo](dictionaries/31_piwigo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.<br/>**Default:** silique_image.png |
#### Piwigo
| Parameter | Comment |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|
| **[general.piwigo.piwigo_title](dictionaries/31_piwigo.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Titre de l'album.<br/>**Default:** Album photographique |
## Variables for expert
### General
#### PHP
Paramètrage avancé de PHP.
| Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|
| **[general.php.php_post_max_size](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Maximum size of POST data that PHP will accept.<br/>Value in Mb.<br/>**Default:** 32 |
| **[general.php.php_upload_max_filesize](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Maximum allowed size for uploaded files.<br/>Value in Mb.<br/>**Default:** 16 |
| **[general.php.php_max_execution_time](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Maximum amount of time each script may spend parsing request data.<br/>Value in seconds.<br/>**Default:** 30 |
| **[general.php.php_max_input_time](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Maximum amount of time each script may spend parsing request data.<br/>Value in seconds.<br/>**Default:** 60 |
| **[general.php.php_memory_limit](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Maximum amount of memory a script may consume.<br/>Value in Mb.<br/>**Default:** 512 |
| **[general.php.php_session_gc_maxlifetime](dictionaries/20_php.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Data will be seen as 'garbage' and potentially cleaned up after this delay.<br/>Value in seconds.<br/>**Default:** 3600 |
#### NGINX
| Parameter | Comment |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The bucket size for the server names hash tables.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](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.<br/>This value is in Mb.<br/>**Default:** 32 |
## Requirements services ## Requirements services
- **LocalDNS** ### Mandatories
- Journald
- **MariaDB**
- **SMTP**
- **LDAP**
- **ReverseProxy**
- **Redis**
- **OAuth2**
**bold**: provider is mandatory - [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name.
- [SMTP](../README.SMTP.md): Create a SMTP relay account and authorize sending email.
- [LDAP](../README.LDAP.md): Create account and connexion to a LDAP server.
- [ReverseProxy](../README.ReverseProxy.md): Register to service to a reverse proxy server.
- [OAuth2](../README.OAuth2.md): Remote clients needing to verify OAuth2 account.
- [Redis](../README.Redis.md): Create account and connexion to a Redis server.
- [MariaDB](../README.MariaDB.md): Create account and connexion to a MariaDB server.
## Example ### Optionals
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. - [Journald](../README.Journald.md): Concentrate journal messages on one host.
```
piwigo:
applicationservice: piwigo
zones_name:
- ldap
- localdns
- mariadb
- reverseproxy
- smtp
- redis
- oauth2
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
general.piwigo.piwigo_admin_email: admin@example.net
general.piwigo.users.piwigo_users:
- jdoe
general.piwigo.users.piwigo_email:
'0': johndoe@example.net
```
## Dependances ## Dependances
- [base-fedora-36](../base-fedora-36/README.md) - [base-fedora-36](../base-fedora-36/README.md): Base information of a Fedora 36.
- [base-fedora](../base-fedora/README.md) - [base-fedora](../base-fedora/README.md): Base information of a Fedora.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
- [mariadb-client](../mariadb-client/README.md) - [mariadb-client](../mariadb-client/README.md): Application service needs interact with a MariaDB server.
- [ldap-client](../ldap-client/README.md) - [ldap-client](../ldap-client/README.md): Application service needs interact with a LDAP server.
- [redis-client](../redis-client/README.md) - [redis-client](../redis-client/README.md): Application service needs interact with a Redis server.
- [redis-common](../redis-common/README.md) - [redis-common](../redis-common/README.md): Redis, an in-memory data structure store.
- [oauth2-client](../oauth2-client/README.md) - [oauth2-client](../oauth2-client/README.md): Application service needs interact with a Oauth2 server.
- [relay-mail-client](../relay-mail-client/README.md) - [relay-mail-client](../relay-mail-client/README.md): Client SMTP.
- [nginx-https](../nginx-https/README.md) - [nginx-https](../nginx-https/README.md): Nginx as HTTPS web site.
- [nginx-common](../nginx-common/README.md) - [nginx-common](../nginx-common/README.md): Nginx common configuration.
- [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.
- [php-fpm](../php-fpm/README.md) - [php-fpm](../php-fpm/README.md): PHP FPM.
- [php](../php/README.md) - [php](../php/README.md): PHP, a popular general-purpose scripting language.
[All applications services for this dataset.](../README.md)

4
seed/pki-tls/README.md
View file

@ -3,6 +3,8 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# pki-tls # pki-tls
## Synopsis ## Synopsis
@ -12,5 +14,3 @@ Autosign PKI or Let's encrypt support for TLS certificates.
## Used by ## Used by
[base-machine](../base-machine/README.md) [base-machine](../base-machine/README.md)
[All applications services for this dataset.](../README.md)

11
seed/postfix-lmtp-relay/README.md
View file

@ -3,20 +3,15 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# postfix-lmtp-relay # postfix-lmtp-relay
## Synopsis ## 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 ## Used by
[postfix-relay](../postfix-relay/README.md) [postfix-relay](../postfix-relay/README.md)
## Supplier
[relay-lmtp-client](../relay-lmtp-client/README.md)
[All applications services for this dataset.](../README.md)

6
seed/postfix-lmtp-relay/extras/lmtp/00_lmtp.xml
View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<rougail version="0.10"> <rougail version="0.10">
<variables> <variables>
<variable name="server_lmtp" description="LMTP remote server" type="domainname" provider="LMTP" multi="True"/> <variable name="server_lmtp" description="LMTP remote server" help="A service needs send email with LMTP protocol" type="domainname" provider="LMTP" multi="True" hidden="True"/>
<family name="lmtp_" description="LMTP " dynamic="lmtp.server_lmtp"> <family name="lmtp_" description="LMTP " dynamic="lmtp.server_lmtp" hidden="True">
<variable name="criteria_" description="transport criteria " type="string" multi="True" mandatory="True" hidden="True" provider="LMTP:criteria"/> <variable name="criteria_" description="Domain name allowes to send email with LMTP protocol for " type="string" multi="True" mandatory="True" provider="LMTP:criteria"/>
</family> </family>
</variables> </variables>
<constraints> <constraints>

89
seed/postfix-relay/README.md
View file

@ -3,33 +3,17 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# postfix-relay # postfix-relay
## Synopsis ## Synopsis
Postfix, the mail server, as relay.
[Software's website.](http://www.postfix.org/) [Postfix, the mail server, as relay.](http://www.postfix.org/)
The mail relay allows the various internal services to communicate with the other services.
## Variables It is also possible to receive from outside or send emails to the outside.
### Général
#### Postfix mail server
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.postfix.postfix_mail_hostname](dictionaries/30_postfix.xml)**<br/>**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.<br/>Cette variable est obligatoire pour recevoir des courriels depuis l'extérieur. |
| **[general.postfix.postfix_crt_provider](dictionaries/30_postfix.xml)**<br/>mandatory<br/>**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.<br/>**Choices:**<br/>- `self-signed` ← default<br/>- `letsencrypt` |
## Requirements services
- **ExternalDNS**
- Journald
**bold**: provider is mandatory
## Example ## Example
@ -40,25 +24,56 @@ postfix-relay:
applicationservice: postfix-relay applicationservice: postfix-relay
provider_zone: smtp provider_zone: smtp
zones_name: zones_name:
- localdns - externaldns
``` ```
## Basic variables
### General
#### Postfix mail server
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.postfix.postfix_mail_hostname](dictionaries/30_postfix.xml)**<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | External email server domain name.<br/>This variable is mandatory if mail server needs to interact with external area. |
| **[general.postfix.postfix_crt_provider](dictionaries/30_postfix.xml)**<br/>mandatory<br/>**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 certificate.<br/>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).<br/>**Choices:**<br/>- `self-signed` ← default<br/>- `letsencrypt` |
## Requirements services
### Mandatories
- [ExternalDNS](../README.ExternalDNS.md): DNS forwarder for all DNS zones.
### Optionals
- [Journald](../README.Journald.md): Concentrate journal messages on one host.
## Dependances ## Dependances
- [base-fedora-35](../base-fedora-35/README.md) - [base-fedora-35](../base-fedora-35/README.md): Base information of a Fedora 35.
- [base-fedora](../base-fedora/README.md) - [base-fedora](../base-fedora/README.md): Base information of a Fedora.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
- [dns-external](../dns-external/README.md) - [dns-external](../dns-external/README.md): DNS client with resolution on all zones (especially outside).
- [postfix-lmtp-relay](../postfix-lmtp-relay/README.md) - [postfix-lmtp-relay](../postfix-lmtp-relay/README.md): Postfix, the mail server, as LMTP relay.
## Supplier ## Useful for services
[relay-mail-client](../relay-mail-client/README.md) - [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.
[All applications services for this dataset.](../README.md) - [gitea](../gitea/README.md): Transitional package for Gitea to Forgejo.
- [grafana](../grafana/README.md): Grafana is an analytics and interactive visualization web application.
- [lemonldap](../lemonldap/README.md): LemonLDAP, a Web Single Sign On and Access Management.
- [mailman](../mailman/README.md): GNU Mailman, managing electronic mail discussion and e-newsletter lists.
- [nextcloud](../nextcloud/README.md): Nextcloud, Online collaboration platform.
- [odoo](../odoo/README.md): Odoo, an ERP and CRM.
- [peertube](../peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform.
- [piwigo](../piwigo/README.md): Piwigo, a photo management software.
- [vaultwarden](../vaultwarden/README.md): Vaultwarden, a password manager.

3
seed/postfix-relay/applicationservice.yml
View file

@ -1,5 +1,8 @@
format: '0.1' format: '0.1'
description: Postfix, the mail server, as relay description: Postfix, the mail server, as relay
help: |
The mail relay allows the various internal services to communicate with the other services.
It is also possible to receive from outside or send emails to the outside.
website: http://www.postfix.org/ website: http://www.postfix.org/
depends: depends:
- base-fedora-35 - base-fedora-35

29
seed/postfix-relay/dictionaries/30_postfix.xml
View file

@ -31,27 +31,26 @@
</services> </services>
<variables> <variables>
<family name="network"> <family name="network">
<variable name="outgoing_ports" redefine="True"> <variable name="outgoing_ports" redefine="True" mandatory="False"/>
<value>25</value>
</variable>
<variable name="incoming_ports" redefine="True" mandatory="False"/> <variable name="incoming_ports" redefine="True" mandatory="False"/>
</family> </family>
<family name="postfix" description="Postfix mail server"> <family name="postfix" description="Postfix mail server">
<variable name="postfix_mail_hostname" type="domainname" description="Nom de domaine extérieur du serveur de courriel" help="Cette variable est obligatoire pour recevoir des courriels depuis l'extérieur"/> <variable name="postfix_mail_hostname" type="domainname" description="External email server domain name" help="This variable is mandatory if mail server needs to interact with external area" mode="basic"/>
<variable name="postfix_crt_provider" type="choice" description="Autorité de certification signant le certificat du domaine extérieur" mandatory="True"> <variable name="postfix_crt_provider" type="choice" description="Type of certificate autority signing external certificate" mandatory="True" mode="basic" help="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)">
<value>self-signed</value> <value>self-signed</value>
<choice>self-signed</choice> <choice>self-signed</choice>
<choice>letsencrypt</choice> <choice>letsencrypt</choice>
</variable> </variable>
<variable name="postfix_relay_domains" type="domainname" description="Local LTMP domain" multi="True" hidden="True"/> <variable name="postfix_relay_domains" type="domainname" multi="True" hidden="True"/>
<variable name='postfix_relay_authentifications' description="Authentification sur le relai SMTP" multi="True" provider="SMTP"/> <variable name='postfix_relay_authentifications' description="Create a SMTP relay account and authorize sending email" help="A service needs send email with SMTP protocol, so an account is created and SMTP relay accept sending mail by this account" multi="True" provider="SMTP" hidden="True"/>
<family name="local_authentification_" description="Local server authentification" dynamic='postfix_relay_authentifications'> <family name="local_authentification_" dynamic='postfix_relay_authentifications' hidden="True">
<variable name="local_authentification_password_" type="secret" auto_save="False" provider="SMTP:password"/> <variable name="local_authentification_username_" description="User account to send email for " type="unix_user" provider="SMTP:username"/>
<variable name="postfix_relay_ip_" type="ip" hidden="True"/> <variable name="local_authentification_password_" description="Password to send email for " type="secret" provider="SMTP:password"/>
<variable name="postfix_relay_ip_" type="ip"/>
</family> </family>
</family> </family>
<family name="opendkim"> <family name="opendkim">
<variable name="opendkim_keys" type="filename" description="Keys filename" multi="True" hidden="True"/> <variable name="opendkim_keys" type="filename" multi="True" hidden="True"/>
</family> </family>
</variables> </variables>
<constraints> <constraints>
@ -76,5 +75,13 @@
<param name="multi">True</param> <param name="multi">True</param>
<target>incoming_ports</target> <target>incoming_ports</target>
</fill> </fill>
<fill name="calc_value">
<param type="nil"/>
<param name="default">25</param>
<param name="condition" type="variable">postfix_mail_hostname</param>
<param name="expected" type="nil"/>
<param name="multi">True</param>
<target>outgoing_ports</target>
</fill>
</constraints> </constraints>
</rougail> </rougail>

2
seed/postfix-relay/templates/postfix.service
View file

@ -2,7 +2,7 @@
ExecStartPre=/usr/sbin/postmap /etc/postfix/lmtp ExecStartPre=/usr/sbin/postmap /etc/postfix/lmtp
ExecStartPre=/usr/sbin/postmap -F /etc/postfix/sni ExecStartPre=/usr/sbin/postmap -F /etc/postfix/sni
{% for local in general.postfix.postfix_relay_authentifications %} {% for local in general.postfix.postfix_relay_authentifications %}
{% set user = local|normalize_family %} {% set user = general.postfix['local_authentification_' + user]['local_authentification_username_' + user] %}
{% set password = general.postfix['local_authentification_' + user]['local_authentification_password_' + user] %} {% set password = general.postfix['local_authentification_' + user]['local_authentification_password_' + user] %}
{% set ip = general.postfix['local_authentification_' + user]['postfix_relay_ip_' + user] %} {% set ip = general.postfix['local_authentification_' + user]['postfix_relay_ip_' + user] %}
ExecStartPre=-/usr/bin/bash -c "echo {{ password }} | /usr/sbin/saslpasswd2 -u {{ ip }} {{ user }} -p" ExecStartPre=-/usr/bin/bash -c "echo {{ password }} | /usr/sbin/saslpasswd2 -u {{ ip }} {{ user }} -p"

25
seed/postgresql-client/README.md
View file

@ -3,27 +3,14 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# postgresql-client # postgresql-client
## Synopsis ## 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)
## Variables for expert
### Général
#### PostgreSQL
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|
| **[general.postgresql.pg_client_username](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client username.<br/>**Default:** *calculated* |
| **[general.postgresql.pg_client_password](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`password`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client password.<br/>**Default:** *calculated* |
| **[general.postgresql.pg_client_database](dictionaries/23_postgresql.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Client database.<br/>**Default:** *calculated* |
## Used by ## Used by
@ -35,9 +22,3 @@ Application service needs interact with a Postgresql server.
- [roundcube](../roundcube/README.md) - [roundcube](../roundcube/README.md)
- [vaultwarden](../vaultwarden/README.md) - [vaultwarden](../vaultwarden/README.md)
- [nextcloud](../nextcloud/README.md) - [nextcloud](../nextcloud/README.md)
## Provider
[postgresql](../postgresql/README.md)
[All applications services for this dataset.](../README.md)

10
seed/postgresql-client/dictionaries/23_postgresql.xml
View file

@ -10,11 +10,11 @@
</services> </services>
<variables> <variables>
<family name="postgresql" description="PostgreSQL"> <family name="postgresql" description="PostgreSQL">
<variable name="pg_client_server_domainname" type="domainname" description="Nom de domaine du serveur PostgreSQL" mandatory="True" supplier="Postgresql"/> <variable name="pg_client_server_domainname" type="domainname" mandatory="True" supplier="Postgresql" hidden="True"/>
<variable name="pg_client_username" description="Client username" mandatory="True" supplier="Postgresql:username"/> <variable name="pg_client_username" mandatory="True" supplier="Postgresql:username" hidden="True"/>
<variable name="pg_client_password" type="password" description="Client password" mandatory="True" supplier="Postgresql:password"/> <variable name="pg_client_password" type="password" mandatory="True" supplier="Postgresql:password" hidden="True"/>
<variable name="pg_client_database" description="Client database" mandatory="True" supplier="Postgresql:database"/> <variable name="pg_client_database" mandatory="True" supplier="Postgresql:database" hidden="True"/>
<variable name="pg_client_key_owner" type="unix_user" description="Key owner" mandatory="True" hidden="True"> <variable name="pg_client_key_owner" type="unix_user" mandatory="True" hidden="True">
<value>apache</value> <value>apache</value>
</variable> </variable>
</family> </family>

78
seed/postgresql/README.md
View file

@ -3,18 +3,31 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# postgresql # postgresql
## Synopsis ## Synopsis
Postgresql, a database.
[Software's website.](https://www.postgresql.org) [Postgresql, a database.](https://www.postgresql.org)
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
```
postgresql:
applicationservice: postgresql
provider_zone: postgresql
zones_name:
- localdns
```
## Variables ## Variables
### Général ### General
#### PostgreSQL #### PostgreSQL
@ -39,50 +52,37 @@ Paramétrage du serveur de gestion de bases de données PostgreSQL.
| **[general.postgresql.pg_effective_cache_size](dictionaries/22_postgresql.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille du cache.<br/>Initialise l'estimation faite par le planificateur pour le nombre de bloc de 8ko réelle du cache disque disponible pour une requête.<br/>**Default:** 4 | | **[general.postgresql.pg_effective_cache_size](dictionaries/22_postgresql.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille du cache.<br/>Initialise l'estimation faite par le planificateur pour le nombre de bloc de 8ko réelle du cache disque disponible pour une requête.<br/>**Default:** 4 |
| **[general.postgresql.pg_effective_cache_size_unit](dictionaries/22_postgresql.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Unité de la taille du cache.<br/>**Choices:**<br/>- `MB`<br/>- `kB`<br/>- `GB` ← default | | **[general.postgresql.pg_effective_cache_size_unit](dictionaries/22_postgresql.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Unité de la taille du cache.<br/>**Choices:**<br/>- `MB`<br/>- `kB`<br/>- `GB` ← default |
### Accounts
#### Account for *suffix value*
This a dynamic family generated from the variable "accounts.remotes".
| Parameter | Comments |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------|
| **[accounts.remote_*suffix value*.remote_ip_*suffix value*](extras/accounts/00_accounts.xml)**<br/>mandatory<br/>**Type:** [`ip`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Remote IP .<br/>**Default:** *calculated* |
## Requirements services ## Requirements services
- **LocalDNS** ### Mandatories
- Journald
**bold**: provider is mandatory - [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name.
## Example ### Optionals
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. - [Journald](../README.Journald.md): Concentrate journal messages on one host.
```
postgresql:
applicationservice: postgresql
provider_zone: postgresql
zones_name:
- localdns
```
## Dependances ## Dependances
- [base-fedora-37](../base-fedora-37/README.md) - [base-fedora-37](../base-fedora-37/README.md): Base information of a Fedora 37.
- [base-fedora](../base-fedora/README.md) - [base-fedora](../base-fedora/README.md): Base information of a Fedora.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
## Supplier ## Useful for services
[postgresql-client](../postgresql-client/README.md) - [forgejo](../forgejo/README.md): Forgejo, a community managed lightweight code hosting solution.
- [gitea](../gitea/README.md): Transitional package for Gitea to Forgejo.
[All applications services for this dataset.](../README.md) - [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.
- [nextcloud](../nextcloud/README.md): Nextcloud, Online collaboration platform.
- [odoo](../odoo/README.md): Odoo, an ERP and CRM.
- [peertube](../peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform.
- [roundcube](../roundcube/README.md): Roundcube, a webmail.
- [vaultwarden](../vaultwarden/README.md): Vaultwarden, a password manager.

10
seed/postgresql/extras/accounts/00_accounts.xml
View file

@ -1,12 +1,12 @@
<?xml version='1.0' encoding='UTF-8'?> <?xml version='1.0' encoding='UTF-8'?>
<rougail version="0.10"> <rougail version="0.10">
<variables> <variables>
<variable name="remotes" description="Remote clients needing an account" type="domainname" multi="True" provider="Postgresql"/> <variable name="remotes" description="Create account and connexion to a PostgreSQL server" type="domainname" multi="True" provider="Postgresql" hidden="True"/>
<family name="remote_" description="Account for " dynamic="accounts.remotes"> <family name="remote_" description="Account for " dynamic="accounts.remotes" hidden="True">
<variable name="remote_ip_" description="Remote IP " type="ip" mandatory="True"/> <variable name="remote_ip_" description="Remote IP " type="ip" mandatory="True"/>
<variable name="database_" description="Remote database " auto_save="False" hidden="True" mandatory="True" provider="Postgresql:database"/> <variable name="database_" description="Postgresql database name for " mandatory="True" provider="Postgresql:database"/>
<variable name="username_" description="Remote username " auto_save="False" hidden="True" mandatory="True" provider="Postgresql:username"/> <variable name="username_" description="Postgresql username for " mandatory="True" provider="Postgresql:username"/>
<variable name="password_" description="Remote password " auto_save="False" hidden="True" type="password" mandatory="True" provider="Postgresql:password"/> <variable name="password_" description="Postgresql password for " type="password" mandatory="True" provider="Postgresql:password"/>
</family> </family>
</variables> </variables>
<constraints> <constraints>

5
seed/postgresql/templates/postgresql.conf
View file

@ -627,7 +627,7 @@ log_destination = 'syslog'
#FIXME en dure ? #FIXME en dure ?
#>GNUNUX #>GNUNUX
#log_timezone = 'GMT' #log_timezone = 'GMT'
log_timezone = 'Europe/Paris' log_timezone = '{{ general.base.time_zone }}'
#<GNUNUX #<GNUNUX
@ -756,8 +756,7 @@ datestyle = 'iso, dmy'
#intervalstyle = 'postgres' #intervalstyle = 'postgres'
#timezone = 'GMT' #timezone = 'GMT'
#>GNUNUX #>GNUNUX
#FIXME en dure ? timezone = '{{ general.base.time_zone }}'
timezone = 'Europe/Paris'
#<GNUNUX #<GNUNUX
#timezone_abbreviations = 'Default' # Select the set of available time zone #timezone_abbreviations = 'Default' # Select the set of available time zone
# abbreviations. Currently, there are # abbreviations. Currently, there are

46
seed/prometheus/README.md
View file

@ -3,20 +3,14 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# prometheus # prometheus
## Synopsis ## Synopsis
Prometheus, an event monitoring.
[Software's website.](https://prometheus.io/) [Prometheus, an event monitoring.](https://prometheus.io/)
## Requirements services
- **LocalDNS**
- Journald
**bold**: provider is mandatory
## Example ## Example
@ -30,20 +24,24 @@ prometheus:
- localdns - localdns
``` ```
## Requirements services
### Mandatories
- [LocalDNS](../README.LocalDNS.md): DNS forwarder for local domain name.
### Optionals
- [Journald](../README.Journald.md): Concentrate journal messages on one host.
## Dependances ## Dependances
- [base-fedora-38](../base-fedora-38/README.md) - [base-fedora-38](../base-fedora-38/README.md): Base information of a Fedora 38.
- [base-fedora](../base-fedora/README.md) - [base-fedora](../base-fedora/README.md): Base information of a Fedora.
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
## Supplier
[host-systemd-machined](../host-systemd-machined/README.md)
[All applications services for this dataset.](../README.md)

2
seed/prometheus/dictionaries/20_prometheus.xml
View file

@ -11,7 +11,7 @@
</services> </services>
<variables> <variables>
<family name="prometheus"> <family name="prometheus">
<variable name="client_addresses" type="domainname" provider="Prometheus" multi="True"/> <variable name="client_addresses" description="Configure Prometheus exporter" type="domainname" provider="Prometheus" multi="True" hidden="True"/>
<variable name="listen_addresses" type="ip" hidden="True" multi="True"/> <variable name="listen_addresses" type="ip" hidden="True" multi="True"/>
</family> </family>
</variables> </variables>

50
seed/provider-systemd-machined/README.md
View file

@ -3,51 +3,21 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# provider-systemd-machined # provider-systemd-machined
## Synopsis ## 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
### Général
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
| **[general.use_systemd_repart](dictionaries/16_machined.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | **Default:** False |
#### network
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|
| **[general.network.netwokd_interface_name_type](dictionaries/16_machined.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | **Default:** host |
## Variables for expert
### Général
#### network
| Parameter | Comments |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|
| **[general.network.zones_list](dictionaries/16_machined.xml)**<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | |
## Dependances ## Dependances
- [systemd](../systemd/README.md) - [systemd](../systemd/README.md): Systemd, a system and service manager.
- [base-machine](../base-machine/README.md) - [base-machine](../base-machine/README.md): Base information for a machine.
- [base](../base/README.md) - [base](../base/README.md): Base of all application services.
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md): DNS client with access to local zones.
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates.
- [journald](../journald/README.md) - [journald](../journald/README.md): Journald.
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md): Resolved.
## Provider
[host-systemd-machined](../host-systemd-machined/README.md)
[All applications services for this dataset.](../README.md)

6
seed/provider-systemd-machined/dictionaries/16_machined.xml
View file

@ -26,16 +26,16 @@
<value>/var/lib/risotto/journals</value> <value>/var/lib/risotto/journals</value>
</variable> </variable>
<variable name="journal_dir" description='Nom du répertoire des journaux' type="filename" hidden="True" mandatory="True" supplier="Host:machine_journal"/> <variable name="journal_dir" description='Nom du répertoire des journaux' type="filename" hidden="True" mandatory="True" supplier="Host:machine_journal"/>
<variable name="use_systemd_repart" redefine="True"> <variable name="use_systemd_repart" redefine="True" hidden="True">
<value>False</value> <value>False</value>
</variable> </variable>
<family name="network"> <family name="network">
<variable name="incoming_ports" type="port" description="Ports exposés depuis l'extérieur" multi="True" supplier="Host:incoming_ports" hidden="True"/> <variable name="incoming_ports" type="port" description="Ports exposés depuis l'extérieur" multi="True" supplier="Host:incoming_ports" hidden="True"/>
<variable name="outgoing_ports" type="port" description="Ports autorisés vers l'extérieur" multi="True" supplier="Host:outgoing_ports" hidden="True"/> <variable name="outgoing_ports" type="port" description="Ports autorisés vers l'extérieur" multi="True" supplier="Host:outgoing_ports" hidden="True"/>
<variable name="netwokd_interface_name_type" redefine="True"> <variable name="netwokd_interface_name_type" redefine="True" hidden="True">
<value>host</value> <value>host</value>
</variable> </variable>
<variable name="zones_list" redefine="True" supplier="Host:machine_zones"/> <variable name="zones_list" redefine="True" supplier="Host:machine_zones" hidden="True"/>
</family> </family>
<variable name="do_backup" type="boolean" description="Do backup for this machine" hidden="True"> <variable name="do_backup" type="boolean" description="Do backup for this machine" hidden="True">
<value>True</value> <value>True</value>

26
seed/redis-client/README.md
View file

@ -3,30 +3,18 @@ gitea: none
include_toc: true include_toc: true
--- ---
[Return to the list of application services.](../README.md)
# redis-client # redis-client
## Synopsis ## 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/)
## Variables for expert
### Général
#### Redis
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|
| **[general.redis.redis_client_username](dictionaries/23_redis.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom d'utilisateur.<br/>**Default:** *calculated* |
| **[general.redis.redis_client_password](dictionaries/23_redis.xml)**<br/>mandatory<br/>**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.<br/>**Default:** *calculated* |
## Dependances ## Dependances
- [redis-common](../redis-common/README.md) - [redis-common](../redis-common/README.md): Redis, an in-memory data structure store.
## Used by ## Used by
@ -35,9 +23,3 @@ Application service needs interact with a Redis server.
- [forgejo](../forgejo/README.md) - [forgejo](../forgejo/README.md)
- [roundcube](../roundcube/README.md) - [roundcube](../roundcube/README.md)
- [nextcloud](../nextcloud/README.md) - [nextcloud](../nextcloud/README.md)
## Provider
[redis](../redis/README.md)
[All applications services for this dataset.](../README.md)

12
seed/redis-client/dictionaries/23_redis.xml
View file

@ -6,12 +6,12 @@
</service> </service>
</services> </services>
<variables> <variables>
<family name="redis" description="Redis"> <family name="redis" description="Redis" hidden="True">
<variable name="redis_client_server_domainname" type="domainname" description="Nom de domaine du serveur Redis" mandatory="True" supplier="Redis"/> <variable name="redis_client_server_domainname" type="domainname" mandatory="True" supplier="Redis"/>
<variable name="redis_client_username" description="Nom d'utilisateur" mandatory="True" supplier="Redis:username"/> <variable name="redis_client_username" mandatory="True" supplier="Redis:username"/>
<variable name="redis_client_password" type="password" description="Mot de passe de connexion" mandatory="True" supplier="Redis:password"/> <variable name="redis_client_password" type="password" mandatory="True" supplier="Redis:password"/>
<variable name="redis_client_index" type="number" description="Redis index" mandatory='True' provider="Redis:index"/> <variable name="redis_client_index" description="Redis database index" help="Only index 0 is allowed, Redis project discourage to use the server with several database" type="number" mandatory='True' provider="Redis:index"/>
<variable name="redis_client_key_owner" type="unix_user" description="Key owner" mandatory="True" hidden="True"> <variable name="redis_client_key_owner" description="" type="unix_user" mandatory="True">
<value>apache</value> <value>apache</value>
</variable> </variable>
</family> </family>

Some files were not shown because too many files have changed in this diff Show more