stove/dataset
3
0
Fork 1
Code Issues 2 Pull requests Projects Releases Wiki Activity

update doc

Browse source
This commit is contained in:
egarette@silique.fr 2023-08-02 09:26:54 +02:00
parent 71a61627e3
commit e8e9e8719e
100 changed files with 2248 additions and 2076 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

62
seed/README.md
View file

@ -1,5 +1,36 @@
# Application services # Application services
- [dovecot](dovecot/README.md): Postfix and Dovecot as mail servers (Submission and IMAP)
- [forgejo](forgejo/README.md): Forgejo, a community managed lightweight code hosting solution
- [gitea](gitea/README.md): Transitional package for Gitea to Forgejo
- [grafana](grafana/README.md): Grafana is an analytics and interactive visualization web application
- [lemonldap](lemonldap/README.md): LemonLDAP, a Web Single Sign On and Access Management
- [loki](loki/README.md): Loki, a log aggregation platform
- [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:
- [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](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
- [peertube](peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform
- [piwigo](piwigo/README.md): Piwigo, a photo management software
- [postfix-relay](postfix-relay/README.md): Postfix, the mail server, as relay
- [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
- [unbound](unbound/README.md): Unbound, a validating, recursive, caching DNS resolver
- [vaultwarden](vaultwarden/README.md): Vaultwarden, a password manager
- [vector](vector/README.md): Vector, a lightweight, ultra-fast tool for building observability pipelines
- [znc](znc/README.md): ZNC, a bouncer IRC
# Application dependencies
- [apache](apache/README.md): Apache as web server - [apache](apache/README.md): Apache as web server
- base: - base:
- [base](base/README.md): Base of all application services - [base](base/README.md): Base of all application services
@ -14,49 +45,24 @@
- dns: - dns:
- [dns-external](dns-external/README.md): DNS client with resolution on all zones (especially outside) - [dns-external](dns-external/README.md): DNS client with resolution on all zones (especially outside)
- [dns-local](dns-local/README.md): DNS client with access to local zones - [dns-local](dns-local/README.md): DNS client with access to local zones
- [dovecot](dovecot/README.md): Postfix and Dovecot as mail servers (Submission and IMAP)
- [forgejo](forgejo/README.md): Forgejo, a community managed lightweight code hosting solution
- [gitea](gitea/README.md): Transitional package for Gitea to Forgejo
- [grafana](grafana/README.md): Grafana is an analytics and interactive visualization web application
- [host-systemd-machined](host-systemd-machined/README.md): Host with machine started in Systemd Machined environment - [host-systemd-machined](host-systemd-machined/README.md): Host with machine started in Systemd Machined environment
- [imap-client](imap-client/README.md): Application service needs interact with an IMAP server - [imap-client](imap-client/README.md): Application service needs interact with an IMAP server
- [journald](journald/README.md): Journald - [journald](journald/README.md): Journald
- [journald_remote](journald_remote/README.md): Journald remote - [journald_remote](journald_remote/README.md): Journald remote
- [ldap-client](ldap-client/README.md): Application service needs interact with a LDAP server - [ldap-client](ldap-client/README.md): Application service needs interact with a LDAP server
- [lemonldap](lemonldap/README.md): LemonLDAP, a Web Single Sign On and Access Management
- [loki](loki/README.md): Loki, a log aggregation platform
- [mailman](mailman/README.md): GNU Mailman, managing electronic mail discussion and e-newsletter lists
- mariadb:
- [mariadb](mariadb/README.md): MariaDB, a relational database
- [mariadb-client](mariadb-client/README.md): Application service needs interact with a MariaDB server - [mariadb-client](mariadb-client/README.md): Application service needs interact with a MariaDB server
- [nextcloud](nextcloud/README.md): Nextcloud, Online collaboration platform
- nginx: - nginx:
- [nginx-common](nginx-common/README.md): Nginx common configuration - [nginx-common](nginx-common/README.md): Nginx common configuration
- [nginx-https](nginx-https/README.md): Nginx as HTTPS web site - [nginx-https](nginx-https/README.md): Nginx as HTTPS web site
- [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](nsd/README.md): NSD, an authoritative DNS name server
- [nsd-local](nsd-local/README.md): NSD, an authoritative DNS name server for local resolution
- [oauth2-client](oauth2-client/README.md): Application service needs interact with a Oauth2 server - [oauth2-client](oauth2-client/README.md): Application service needs interact with a Oauth2 server
- [odoo](odoo/README.md): Odoo, an ERP and CRM
- [openldap](openldap/README.md): OpenLDAP, a LDAP server
- [peertube](peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform
- php: - php:
- [php](php/README.md): PHP, a popular general-purpose scripting language - [php](php/README.md): PHP, a popular general-purpose scripting language
- [php-fpm](php-fpm/README.md): PHP FPM - [php-fpm](php-fpm/README.md): PHP FPM
- [piwigo](piwigo/README.md): Piwigo, a photo management software
- [pki-tls](pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates - [pki-tls](pki-tls/README.md): Autosign PKI or Let's encrypt support for TLS certificates
- postfix:
- [postfix-lmtp-relay](postfix-lmtp-relay/README.md): Postfix, the mail server, as LMTP relay - [postfix-lmtp-relay](postfix-lmtp-relay/README.md): Postfix, the mail server, as LMTP relay
- [postfix-relay](postfix-relay/README.md): Postfix, the mail server, as relay
- postgresql:
- [postgresql](postgresql/README.md): Postgresql, a database
- [postgresql-client](postgresql-client/README.md): Application service needs interact with a Postgresql server - [postgresql-client](postgresql-client/README.md): Application service needs interact with a Postgresql server
- [prometheus](prometheus/README.md): Prometheus, an event monitoring
- [provider-systemd-machined](provider-systemd-machined/README.md): Machine started in Systemd Machined environment - [provider-systemd-machined](provider-systemd-machined/README.md): Machine started in Systemd Machined environment
- redis: - redis:
- [redis](redis/README.md): Redis, an in-memory data structure store
- [redis-client](redis-client/README.md): Application service needs interact with a Redis server - [redis-client](redis-client/README.md): Application service needs interact with a Redis server
- [redis-common](redis-common/README.md): Redis, an in-memory data structure store - [redis-common](redis-common/README.md): Redis, an in-memory data structure store
- relay: - relay:
@ -64,13 +70,7 @@
- [relay-mail-client](relay-mail-client/README.md): Client SMTP - [relay-mail-client](relay-mail-client/README.md): Client SMTP
- [resolved](resolved/README.md): Resolved - [resolved](resolved/README.md): Resolved
- [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
- [roundcube](roundcube/README.md): Roundcube, a webmail
- [speedtest-rs](speedtest-rs/README.md): Speedtest-rs, a very lightweight Speedtest
- [systemd](systemd/README.md): Systemd, a system and service manager - [systemd](systemd/README.md): Systemd, a system and service manager
- [unbound](unbound/README.md): Unbound, a validating, recursive, caching DNS resolver
- [vaultwarden](vaultwarden/README.md): Vaultwarden, a password manager
- [vector](vector/README.md): Vector, a lightweight, ultra-fast tool for building observability pipelines
- [znc](znc/README.md): ZNC, a bouncer IRC
# Providers and suppliers # Providers and suppliers

46
seed/apache/README.md
View file

@ -5,51 +5,31 @@ include_toc: true
# apache # apache
## Description ## Synopsis
Apache as web server. Apache as web server.
[For more informations](https://httpd.apache.org/) [More informations about this software.](https://httpd.apache.org/)
## Examples
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
``` ## Variables for expert
apache:
applicationservice: apache
zones_name:
- reverseproxy
```
``` ### Général
apache:
applicationservice: apache #### Apache
zones_name:
- reverseproxy 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 |
## Dependances ## Dependances
- [reverse-proxy-client](../reverse-proxy-client/README.md) - [reverse-proxy-client](../reverse-proxy-client/README.md)
## Variables
### Général (*general*)
#### Apache (*general.apache*)
Paramètrage avancé du serveur web Apache
| Description | Help | Type | Values |
|-----------------------------------------------------------------------------------------------------------------------------------|-------------------|-------------------------------------------------------------------------------------------------------------------------|----------|
| **Temps d'attente des entrées/sorties avant de considérer qu'une requête a échoué** (*[apache_timeout](dictionaries/20_web.xml)*) | Temps en secondes | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 300 |
| **Autoriser les connexions persistantes** (*[apache_keepalive](dictionaries/20_web.xml)*) | | [boolean](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | True |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Used by ## Used by
[nextcloud](../nextcloud/README.md) [nextcloud](../nextcloud/README.md)

1
seed/apache/applicationservice.yml
View file

@ -3,4 +3,3 @@ description: Apache as web server
website: https://httpd.apache.org/ website: https://httpd.apache.org/
depends: depends:
- reverse-proxy-client - reverse-proxy-client
service: true

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

@ -16,10 +16,10 @@
</variable> </variable>
</family> </family>
<family name="apache" description="Apache" help="Paramètrage avancé du serveur web Apache"> <family name="apache" description="Apache" help="Paramètrage avancé du serveur web Apache">
<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"> <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">
<value>300</value> <value>300</value>
</variable> </variable>
<variable name="apache_keepalive" type="boolean" description="Autoriser les connexions persistantes"/> <variable name="apache_keepalive" type="boolean" description="Autoriser les connexions persistantes" mode="expert"/>
</family> </family>
</variables> </variables>
</rougail> </rougail>

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

@ -5,11 +5,11 @@ include_toc: true
# base-debian-bullseye # base-debian-bullseye
## Description ## Synopsis
Base information of a Debian Bulleye server. Base information of a Debian Bulleye server.
[For more informations](https://www.debian.org/) [More informations about this software.](https://www.debian.org/)
## Dependances ## Dependances

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

@ -5,11 +5,11 @@ include_toc: true
# base-debian # base-debian
## Description ## Synopsis
Base information of a Debian server. Base information of a Debian server.
[For more informations](https://www.debian.org/) [More informations about this software.](https://www.debian.org/)
## Dependances ## Dependances

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

@ -5,11 +5,11 @@ include_toc: true
# base-fedora-35 # base-fedora-35
## Description ## Synopsis
Base information of a Fedora 35. Base information of a Fedora 35.
[For more informations](https://getfedora.org/) [More informations about this software.](https://getfedora.org/)
## Dependances ## Dependances

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

@ -5,11 +5,11 @@ include_toc: true
# base-fedora-36 # base-fedora-36
## Description ## Synopsis
Base information of a Fedora 36. Base information of a Fedora 36.
[For more informations](https://getfedora.org/) [More informations about this software.](https://getfedora.org/)
## Dependances ## Dependances

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

@ -5,11 +5,11 @@ include_toc: true
# base-fedora-37 # base-fedora-37
## Description ## Synopsis
Base information of a Fedora 37. Base information of a Fedora 37.
[For more informations](https://getfedora.org/) [More informations about this software.](https://getfedora.org/)
## Dependances ## Dependances

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

@ -5,11 +5,11 @@ include_toc: true
# base-fedora-38 # base-fedora-38
## Description ## Synopsis
Base information of a Fedora 38. Base information of a Fedora 38.
[For more informations](https://getfedora.org/) [More informations about this software.](https://getfedora.org/)
## Dependances ## Dependances

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

@ -5,11 +5,11 @@ include_toc: true
# base-fedora # base-fedora
## Description ## Synopsis
Base information of a Fedora. Base information of a Fedora.
[For more informations](https://getfedora.org/) [More informations about this software.](https://getfedora.org/)
## Dependances ## Dependances

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

@ -5,28 +5,26 @@ include_toc: true
# base-machine # base-machine
## Description ## Synopsis
Base information for a machine. Base information for a machine.
## Variables
### Machine
| Parameter | Comments |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|
| **[machine.data_disk_size](extras/machine/00_base.xml)**<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Data disk size. |
## Dependances ## Dependances
- [base](../base/README.md) - [base](../base/README.md)
- [dns-local](../dns-local/README.md) - [dns-local](../dns-local/README.md)
- [pki-tls](../pki-tls/README.md) - [pki-tls](../pki-tls/README.md)
## Variables
### Machine (*machine*)
| Description | Type |
|-----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| Data disk size (*[data_disk_size](extras/machine/00_base.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Used by ## Used by
[systemd](../systemd/README.md) [systemd](../systemd/README.md)

2
seed/base/README.md
View file

@ -5,7 +5,7 @@ include_toc: true
# base # base
## Description ## Synopsis
Base of all application services. Base of all application services.

9
seed/base/funcs/base.py
View file

@ -60,3 +60,12 @@ def get_zones_info(zones: dict,
continue continue
ret.append(val) ret.append(val)
return ret return ret
def get_first_value(lst: list):
if lst:
if isinstance(lst[0], list):
if lst[0] and lst[0][0]:
return lst[0][0]
else:
return lst[0]

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

@ -5,25 +5,22 @@ include_toc: true
# dns-external # dns-external
## Description ## Synopsis
DNS client with resolution on all zones (especially outside). DNS client with resolution on all zones (especially outside).
## Variables ## Variables
### Général (*general*) ### Général
#### network (*general.network*) #### network
| Description | Values | Supplier | | Parameter | Comments |
|-------------------------------------------------------------|----------|-------------| |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
| *[**dns_is_only_local**](dictionaries/14_dns-external.xml)* | False | | | **[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 |
| *[dns_client_address](dictionaries/14_dns-external.xml)* | | ExternalDNS |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Used by ## Used by
- [postfix-relay](../postfix-relay/README.md) - [postfix-relay](../postfix-relay/README.md)

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

@ -5,7 +5,7 @@ include_toc: true
# dns-local # dns-local
## Description ## Synopsis
DNS client with access to local zones. DNS client with access to local zones.

151
seed/dovecot/README.md
View file

@ -5,18 +5,76 @@ include_toc: true
# dovecot # dovecot
## Description ## Synopsis
Postfix and Dovecot as mail servers (Submission and IMAP). Postfix and Dovecot as mail servers (Submission and IMAP).
[For more informations](https://www.dovecot.org/) [More informations about this software.](https://www.dovecot.org/)
## Examples ## Basic variables
### Général
#### Mail configuration
##### Mail domain
This a 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 a 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
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
dovecot: dovecot:
applicationservice: dovecot applicationservice: dovecot
@ -28,22 +86,13 @@ dovecot:
- smtp - smtp
- lmtp - lmtp
- oauth2 - oauth2
``` values:
general.mail.domain.mail_domains:
With all providers: - example.net
general.mail.domain.imap_domainname:
``` '0': imap.example.net
dovecot: general.mail.domain.submission_domainname:
applicationservice: dovecot '0': submission.example.net
provider_zone: imap
zones_name:
- journald
- ldap
- localdns
- reverseproxy
- smtp
- lmtp
- oauth2
``` ```
## Dependances ## Dependances
@ -65,66 +114,6 @@ dovecot:
- [nginx-common](../nginx-common/README.md) - [nginx-common](../nginx-common/README.md)
- [reverse-proxy-client](../reverse-proxy-client/README.md) - [reverse-proxy-client](../reverse-proxy-client/README.md)
## Variables
### Général (*general*)
#### network (*general.network*)
| Description | Values |
|---------------------------------------------------------|--------------|
| *[**incoming_ports**](dictionaries/26_dovecot.xml)* [+] | 587<br />993 |
#### ldap (*general.ldap*)
##### client (*general.ldap.client*)
| Description | Values |
|----------------------------------------------------------|----------|
| *[**ldapclient_family**](dictionaries/26_dovecot.xml)* | all |
| *[**ldap_key_file_owner**](dictionaries/26_dovecot.xml)* | dovecot |
#### Mail configuration (*general.mail*)
| Description | Type | Values | Choices |
|------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|-----------|----------------------------|
| **Autorité de certification signant les certificats des domaines extérieurs** (*[mail_crt_provider](dictionaries/26_dovecot.xml)*) | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | autosigne | autosigne<br />letsencrypt |
##### Mail domain (*general.mail.domain*)
This a family is a leadership.
| Description | Type | Supplier |
|---------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|---------------|
| **Domaine de courriel géré localement** (*[mail_domains](dictionaries/26_dovecot.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | LMTP:criteria |
| *[**imap_domainname**](dictionaries/26_dovecot.xml)* | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | |
| *[**submission_domainname**](dictionaries/26_dovecot.xml)* | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | |
#### IMAP mail server (*general.dovecot*)
| Description | Type | Provider |
|----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------|
| **IMAP client address** (*[imap_internal_addresses](dictionaries/26_dovecot.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | IMAP |
#### revprox (*general.revprox*)
##### revprox_client (*general.revprox.revprox_client*)
| Description | Values |
|----------------------------------------------------------------------|--------------|
| *[revprox_client_external_domainnames](dictionaries/26_dovecot.xml)* | <calculated> |
| *[revprox_client_web_address](dictionaries/26_dovecot.xml)* | <calculated> |
#### nginx (*general.nginx*)
| Description | Values |
|-------------------------------------------------|---------------|
| *[**nginx_root**](dictionaries/26_dovecot.xml)* | /var/www/html |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Supplier ## Supplier
[imap-client](../imap-client/README.md) [imap-client](../imap-client/README.md)

18
seed/dovecot/dictionaries/26_dovecot.xml → seed/dovecot/dictionaries/31_dovecot.xml
View file

@ -65,14 +65,14 @@
</family> </family>
<family name="mail" description="Mail configuration"> <family name="mail" description="Mail configuration">
<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"/> <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_calc" type="domainname" hidden="True"/> <variable name="mail_domains_calc" type="domainname" hidden="True"/>
<variable name="imap_domainname" type="domainname" mandatory="True"/> <variable name="imap_domainname" type="domainname" description="Domaine exterieur d'accès au serveur IMAP" mandatory="True" test="imap.example.net"/>
<variable name="submission_domainname" type="domainname" mandatory="True"/> <variable name="submission_domainname" type="domainname" description="Domaine exterieur d'accès au serveur submission" mandatory="True" test="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="Autorité de certification signant les certificats des domaines extérieurs" mandatory="True">
<value>autosigne</value> <value>self-signed</value>
<choice>autosigne</choice> <choice>self-signed</choice>
<choice>letsencrypt</choice> <choice>letsencrypt</choice>
</variable> </variable>
</family> </family>
@ -82,15 +82,17 @@
</family> </family>
<family name="revprox"> <family name="revprox">
<family name="revprox_client"> <family name="revprox_client">
<variable name="revprox_client_external_domainnames" redefine="True"/> <variable name="revprox_client_external_domainnames" redefine="True" hidden="True"/>
<variable name="revprox_client_web_address" redefine="True"/> <variable name="revprox_client_web_address" redefine="True" hidden="True"/>
</family> </family>
</family> </family>
<family name="nginx"> <family name="nginx" hidden="True">
<variable name="nginx_root" redefine='True'> <variable name="nginx_root" redefine='True'>
<value>/var/www/html</value> <value>/var/www/html</value>
</variable> </variable>
</family> </family>
<!-- just for doc ... -->
<family name="oauth2_client" hidden="True"/>
</variables> </variables>
<constraints> <constraints>
<!--fill name="calc_value"> <!--fill name="calc_value">

180
seed/forgejo/README.md
View file

@ -5,18 +5,104 @@ include_toc: true
# forgejo # forgejo
## Description ## Synopsis
Forgejo, a community managed lightweight code hosting solution. Forgejo, a community managed lightweight code hosting solution.
[For more informations](https://forgejo.org/) [More informations about this software.](https://forgejo.org/)
## Examples ## Basic variables
### Général
#### Reverse proxy
##### Point d'entrée des clients
This a 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. |
#### Forgejo
Git forge Forgejo.
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|
| **[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 |
## Variables for expert
### Général
#### Reverse proxy
##### Point d'entrée des clients
This a 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. |
#### 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
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| **[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_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.<br/>**Default:** *calculated* |
##### external
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|
| **[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 |
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|
| **[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 |
## Requirements services
- **LocalDNS**
- Journald
- **SMTP**
- **ReverseProxy**
- **Postgresql**
- **Redis**
- **OAuth2**
**bold**: provider is mandatory
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
forgejo: forgejo:
applicationservice: forgejo applicationservice: forgejo
@ -27,21 +113,10 @@ forgejo:
- redis - redis
- oauth2 - oauth2
- postgresql - postgresql
``` values:
general.revprox.revprox_client.revprox_client_external_domainnames:
With all providers: - service.example.net
general.forgejo.forgejo_mail_sender: admin@example.net
```
forgejo:
applicationservice: forgejo
zones_name:
- journald
- localdns
- reverseproxy
- smtp
- redis
- oauth2
- postgresql
``` ```
## Dependances ## Dependances
@ -62,71 +137,6 @@ forgejo:
- [redis-common](../redis-common/README.md) - [redis-common](../redis-common/README.md)
- [oauth2-client](../oauth2-client/README.md) - [oauth2-client](../oauth2-client/README.md)
## Variables
### Général (*general*)
#### network (*general.network*)
| Description | Values |
|-----------------------------------------------------|----------|
| *[**incoming_ports**](dictionaries/31_forgejo.xml)* | 2222 |
#### Redis (*general.redis*)
| Description | Values |
|-------------------------------------------------------------|----------|
| *[**redis_client_key_owner**](dictionaries/31_forgejo.xml)* | forgejo |
#### Forgejo (*general.forgejo*)
Git forge Forgejo
| Description | Values | Type |
|---------------------------------------------------------------------------------------------------------------|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| **Titre de la forge** (*[forgejo_title](dictionaries/31_forgejo.xml)*) | Forgejo : Au-delà du développement. Nous forgeons. | [string](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** (*[forgejo_mail_sender](dictionaries/31_forgejo.xml)*) | | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
#### revprox (*general.revprox*)
| Description | Values |
|----------------------------------------------------------------|----------|
| *[**revprox_client_port**](dictionaries/31_forgejo.xml)* | 3000 |
| *[**revprox_client_cert_owner**](dictionaries/31_forgejo.xml)* | forgejo |
##### revprox_client (*general.revprox.revprox_client*)
| Description | Values |
|--------------------------------------------------------------------|----------|
| *[**revprox_client_local_location**](dictionaries/31_forgejo.xml)* | / |
#### oauth2_client (*general.oauth2_client*)
| Description | Values |
|-------------------------------------------------------------------------|------------------------|
| *[**oauth2_is_client_application**](dictionaries/31_forgejo.xml)* | True |
| *[**oauth2_client_name**](dictionaries/31_forgejo.xml)* | Forge |
| *[**oauth2_client_description**](dictionaries/31_forgejo.xml)* | Forge logiciel Forgejo |
| *[**oauth2_client_category**](dictionaries/31_forgejo.xml)* | Développement |
| *[**oauth2_client_logo**](dictionaries/31_forgejo.xml)* | silique_note.png |
| *[**oauth2_client_token_signature_algo**](dictionaries/31_forgejo.xml)* | RS256 |
##### external (*general.oauth2_client.external*)
| Description | Values |
|---------------------------------------------------------|--------------|
| *[oauth2_client_external](dictionaries/31_forgejo.xml)* | <calculated> |
#### postgresql (*general.postgresql*)
| Description | Values |
|----------------------------------------------------------|----------|
| *[**pg_client_key_owner**](dictionaries/31_forgejo.xml)* | forgejo |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Used by ## Used by
[gitea](../gitea/README.md) [gitea](../gitea/README.md)

4
seed/forgejo/dictionaries/31_forgejo.xml
View file

@ -20,10 +20,10 @@
</variable> </variable>
</family> </family>
<family name="forgejo" description="Forgejo" help="Git forge Forgejo"> <family name="forgejo" description="Forgejo" help="Git forge Forgejo">
<variable name="forgejo_title" mandatory="True" description="Titre de la forge"> <variable name="forgejo_title" mandatory="True" description="Titre de la forge" mode="basic">
<value>Forgejo : Au-delà du développement. Nous forgeons.</value> <value>Forgejo : Au-delà du développement. Nous forgeons.</value>
</variable> </variable>
<variable name="forgejo_mail_sender" type="mail" description="Les courriels sont envoyés à partir de cet adresse" mandatory="True"/> <variable name="forgejo_mail_sender" type="mail" description="Les courriels sont envoyés à partir de cet adresse" mandatory="True" test="admin@example.net"/>
<variable name="forgejo_secret_key" type="password" hidden="True"/> <variable name="forgejo_secret_key" type="password" hidden="True"/>
<variable name="forgejo_internal_token" type="password" hidden="True"/> <variable name="forgejo_internal_token" type="password" hidden="True"/>
<variable name="forgejo_lfs_jwt_secret" type="password" hidden="True"/> <variable name="forgejo_lfs_jwt_secret" type="password" hidden="True"/>

141
seed/gitea/README.md
View file

@ -5,10 +5,135 @@ include_toc: true
# gitea # gitea
## Description ## Synopsis
Transitional package for Gitea to Forgejo. Transitional package for Gitea to Forgejo.
## Basic variables
### Général
#### Reverse proxy
##### Point d'entrée des clients
This a 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. |
#### Forgejo
Git forge Forgejo.
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|
| **[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. |
## Variables
### Général
#### 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
##### Point d'entrée des clients
This a 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. |
#### 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
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| **[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_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.<br/>**Default:** *calculated* |
##### external
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|
| **[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 |
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|
| **[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 |
## Requirements services
- **LocalDNS**
- Journald
- **SMTP**
- **ReverseProxy**
- **Postgresql**
- **Redis**
- **OAuth2**
**bold**: provider is mandatory
## 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
- 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)
@ -28,18 +153,4 @@ Transitional package for Gitea to Forgejo.
- [redis-common](../redis-common/README.md) - [redis-common](../redis-common/README.md)
- [oauth2-client](../oauth2-client/README.md) - [oauth2-client](../oauth2-client/README.md)
## Variables
### Général (*general*)
#### Transitional family (*general.gitea*)
| Description | Type |
|------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|
| Transitional variable, please do not use it (*[gitea_mail_sender](dictionaries/32_gitea.xml)*) | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
- [+]: variable is multiple
- **bold**: variable is mandatory
[All applications services for this dataset.](../README.md) [All applications services for this dataset.](../README.md)

1
seed/gitea/applicationservice.yml
View file

@ -2,3 +2,4 @@ format: '0.1'
description: Transitional package for Gitea to Forgejo description: Transitional package for Gitea to Forgejo
depends: depends:
- forgejo - forgejo
service: true

142
seed/grafana/README.md
View file

@ -5,18 +5,93 @@ include_toc: true
# grafana # grafana
## Description ## Synopsis
Grafana is an analytics and interactive visualization web application. Grafana is an analytics and interactive visualization web application.
[For more informations](https://grafana.com/) [More informations about this software.](https://grafana.com/)
## Examples ## Basic variables
### Général
#### Reverse proxy
##### Point d'entrée des clients
This a 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. |
#### OAuth2 client
##### external
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| **[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 for expert
### Général
#### Reverse proxy
##### Point d'entrée des clients
This a 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. |
#### 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
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|
| **[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_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
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|
| **[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 |
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|
| **[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 |
## Requirements services
- **LocalDNS**
- Journald
- **SMTP**
- **ReverseProxy**
- **Postgresql**
- **OAuth2**
**bold**: provider is mandatory
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
grafana: grafana:
applicationservice: grafana applicationservice: grafana
@ -26,20 +101,10 @@ grafana:
- smtp - smtp
- oauth2 - oauth2
- postgresql - postgresql
``` values:
general.revprox.revprox_client.revprox_client_external_domainnames:
With all providers: - service.example.net
general.oauth2_client.oauth2_email_domain: example.net
```
grafana:
applicationservice: grafana
zones_name:
- journald
- localdns
- reverseproxy
- smtp
- oauth2
- postgresql
``` ```
## Dependances ## Dependances
@ -58,43 +123,4 @@ grafana:
- [reverse-proxy-client](../reverse-proxy-client/README.md) - [reverse-proxy-client](../reverse-proxy-client/README.md)
- [relay-mail-client](../relay-mail-client/README.md) - [relay-mail-client](../relay-mail-client/README.md)
## Variables
### Général (*general*)
#### revprox (*general.revprox*)
| Description | Values |
|----------------------------------------------------------------|----------|
| *[**revprox_client_port**](dictionaries/31_grafana.xml)* | 3000 |
| *[**revprox_client_cert_owner**](dictionaries/31_grafana.xml)* | grafana |
##### revprox_client (*general.revprox.revprox_client*)
| Description | Values |
|--------------------------------------------------------------------|----------|
| *[**revprox_client_local_location**](dictionaries/31_grafana.xml)* | / |
#### oauth2_client (*general.oauth2_client*)
| Description | Values | Type |
|--------------------------------------------------------------------------------------------------|--------------------------|----------------------------------------------------------------------------------------------------------------------------|
| *[**oauth2_is_client_application**](dictionaries/31_grafana.xml)* | True | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| *[**oauth2_client_name**](dictionaries/31_grafana.xml)* | Grafana | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| *[**oauth2_client_description**](dictionaries/31_grafana.xml)* | Visualisation de données | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| *[**oauth2_client_category**](dictionaries/31_grafana.xml)* | Administration | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| *[**oauth2_client_logo**](dictionaries/31_grafana.xml)* | silique_note.png | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| *[**oauth2_client_token_signature_algo**](dictionaries/31_grafana.xml)* | RS256 | [string](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** (*[oauth2_email_domain](dictionaries/31_grafana.xml)*) | | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
#### postgresql (*general.postgresql*)
| Description | Values |
|----------------------------------------------------------|----------|
| *[**pg_client_key_owner**](dictionaries/31_grafana.xml)* | grafana |
- [+]: variable is multiple
- **bold**: variable is mandatory
[All applications services for this dataset.](../README.md) [All applications services for this dataset.](../README.md)

2
seed/grafana/dictionaries/31_grafana.xml
View file

@ -44,7 +44,7 @@
<variable name="oauth2_client_token_signature_algo" redefine="True"> <variable name="oauth2_client_token_signature_algo" redefine="True">
<value>RS256</value> <value>RS256</value>
</variable> </variable>
<variable name="oauth2_email_domain" type="domainname" description="Domain name allowed to log on Grafana" mandatory="True"/> <variable name="oauth2_email_domain" type="domainname" description="Domain name allowed to log on Grafana" mandatory="True" test="example.net"/>
</family> </family>
<family name="postgresql"> <family name="postgresql">
<variable name="pg_client_key_owner" redefine="True"> <variable name="pg_client_key_owner" redefine="True">

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

@ -5,54 +5,56 @@ include_toc: true
# host-systemd-machined # host-systemd-machined
## Description ## Synopsis
Host with machine started in Systemd Machined environment. Host with machine started in Systemd Machined environment.
[For more informations](https://www.freedesktop.org/wiki/Software/systemd/machined/) [More informations about this software.](https://www.freedesktop.org/wiki/Software/systemd/machined/)
## Basic variables
### Général
#### network
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|
| **[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. |
##### interfaces
This a family is a leadership.
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|
| **[general.network.interfaces.interface_names](dictionaries/21_machined.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 de l'interface. |
| **[general.network.interfaces.interface_ip](dictionaries/21_machined.xml)**<br/>mandatory<br/>**Type:** [`cidr`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | IP au format CIDR de l'interface. |
| **[general.network.interfaces.interface_gateway](dictionaries/21_machined.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) | IP de la route par défaut. |
| **[general.network.interfaces.interface_domain_name_servers](dictionaries/21_machined.xml)**<br/>mandatory, multiple<br/>**Type:** [`ip`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | IP des serveurs DNS. |
## Variables
### Général
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|
| **[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 |
#### network
##### interfaces
This a family is a leadership.
| 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` |
## Dependances ## Dependances
- [base](../base/README.md) - [base](../base/README.md)
## Variables
### Général (*general*)
| Description | Type | Provider | Values |
|-----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|-------------------------|----------|
| **Nom du répertoire comprenant les descriptions d'installation** (*[host_install_dir](dictionaries/21_machined.xml)*) | [filename](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | global:host_install_dir | |
| **tls domaine name** (*[tls_server](dictionaries/21_machined.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | global:tls_server | |
| **Ajustement de la mémoire virtuelle** (*[vm_swappiness](dictionaries/21_machined.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | 60 |
#### network (*general.network*)
| Description |
|---------------------------------------------------------------------------------------|
| **Nom de l'interface de sortie** (*[output_interface](dictionaries/21_machined.xml)*) |
##### interfaces (*general.network.interfaces*)
This a family is a leadership.
| Description | Type | Choices |
|-----------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|----------------|
| **Nom de l'interface** (*[interface_names](dictionaries/21_machined.xml)*) [+] | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | |
| **Type de la carte** (*[interface_type](dictionaries/21_machined.xml)*) | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | dhcp<br />ipv4 |
| **IP au format CIDR de l'interface** (*[interface_ip](dictionaries/21_machined.xml)*) | [cidr](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | |
| **IP de la route par défaut** (*[interface_gateway](dictionaries/21_machined.xml)*) | [ip](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | |
| **IP des serveurs DNS** (*[interface_domain_name_servers](dictionaries/21_machined.xml)*) [+] | [ip](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | |
### Machined (*machined*)
| Description | Type | Provider |
|-----------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------|
| Machines started in this host (*[machines](extras/machined/00_machined.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Host |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Supplier ## Supplier
[provider-systemd-machined](../provider-systemd-machined/README.md) [provider-systemd-machined](../provider-systemd-machined/README.md)

2
seed/host-systemd-machined/templates/tls-script
View file

@ -15,7 +15,7 @@ set -e
if [ -d "{{ dst_dir }}" ] && [ -d "{{ src_dir }}" ]; then if [ -d "{{ dst_dir }}" ] && [ -d "{{ src_dir }}" ]; then
{% for certificate in extra_variables['certificates'][rougail_variable] %} {% for certificate in extra_variables['certificates'][rougail_variable] %}
{% set files = [certificate.name] %} {% set files = [certificate.name] %}
{% if certificate.provider == 'autosigne' %} {% if certificate.provider == 'self-signed' %}
{{ files.append(certificate.authority) }} {{ files.append(certificate.authority) }}
{% endif %} {% endif %}
{% if 'private' in certificate %} {% if 'private' in certificate %}

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

@ -5,24 +5,10 @@ include_toc: true
# imap-client # imap-client
## Description ## Synopsis
Application service needs interact with an IMAP server. Application service needs interact with an IMAP server.
## Variables
### Général (*general*)
#### Client SMTP (*general.imap*)
| Description | Type | Supplier |
|----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------|
| **Nom de domaine du serveur IMAP** (*[imap_address](dictionaries/21_imap_client.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | IMAP |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Used by ## Used by
[roundcube](../roundcube/README.md) [roundcube](../roundcube/README.md)

19
seed/journald/README.md
View file

@ -5,26 +5,11 @@ include_toc: true
# journald # journald
## Description ## Synopsis
Journald. Journald.
[For more informations](https://systemd.io/) [More informations about this software.](https://systemd.io/)
## Variables
### Général (*general*)
#### systemd-journald (*general.journald*)
| Description | Type | Supplier | Values |
|--------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|---------------|--------------|
| *[journal_client_server_domainname](dictionaries/20_journald.xml)* | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Journald | |
| *[journal_host_name](dictionaries/20_journald.xml)* | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Journald:host | <calculated> |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Used by ## Used by

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

@ -10,7 +10,7 @@
<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"/>
<variable name="journal_host_name" type="domainname" supplier="Journald:host"/> <variable name="journal_host_name" type="domainname" supplier="Journald:host" hidden="True"/>
</family> </family>
</variables> </variables>
<constraints> <constraints>

27
seed/journald_remote/README.md
View file

@ -5,34 +5,11 @@ include_toc: true
# journald_remote # journald_remote
## Description ## Synopsis
Journald remote. Journald remote.
[For more informations](https://systemd.io/) [More informations about this software.](https://systemd.io/)
## Variables
### Accounts (*accounts*)
| Description | Type | Provider |
|------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------|
| **Remote journald** (*[remotes](extras/accounts/00_accounts.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Journald |
#### Account for (*accounts.remote_*)
This a dynamic family generated from the variable "accounts.remotes".
| Description | Type | Provider |
|--------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|-------------------|
| **Remote host** (*[host_](extras/accounts/00_accounts.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Journald:host |
| *[messages_](extras/accounts/00_accounts.xml)* [+] | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Journald:message |
| *[services_](extras/accounts/00_accounts.xml)* [+] | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Journald:service |
| *[functions_](extras/accounts/00_accounts.xml)* [+] | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Journald:function |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Used by ## Used by

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

@ -5,35 +5,27 @@ include_toc: true
# ldap-client # ldap-client
## Description ## Synopsis
Application service needs interact with a LDAP server. Application service needs interact with a LDAP server.
## Variables
### Général (*general*)
#### Annuaire OpenLDAP (*general.ldap*)
##### Serveur (*general.ldap.server*)
| Description | Type | Supplier |
|----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------|
| **Nom DNS du serveur LDAP** (*[ldap_server_address](dictionaries/21_ldap-client.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | LDAP |
##### Client (*general.ldap.client*)
| Description | Type | Supplier | Values |
|----------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|--------------|--------------|
| Nom de la famille LDAP (*[ldapclient_family](dictionaries/21_ldap-client.xml)*) | [unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | LDAP:family | |
| **Base DN de l'annuaire** (*[ldapclient_base_dn](dictionaries/21_ldap-client.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | LDAP:base_dn | <calculated> |
| **Base DN de l'annuaire des utilisateurs** (*[ldapclient_search_dn](dictionaries/21_ldap-client.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | <calculated> |
| **Base DN de l'annuaire des groupes** (*[ldapclient_group_dn](dictionaries/21_ldap-client.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | <calculated> |
| **Base DN de l'annuaire des utilisateurs n'appartenant à une famille** (*[ldapclient_user_dn](dictionaries/21_ldap-client.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | <calculated> |
- [+]: variable is multiple ## Variables for expert
- **bold**: variable is mandatory
### Général
#### Annuaire OpenLDAP
##### Client
| 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_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

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

@ -21,10 +21,10 @@
<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' description="DN de l'utilisateur LDAP" 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' description="Mot de passe de l'utilisateur LDAP" 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"/> <variable name='ldapclient_base_dn' type='string' description="Base DN de l'annuaire" mandatory="True" supplier="LDAP:base_dn" mode="expert"/>
<variable name='ldapclient_search_dn' type='string' description="Base DN de l'annuaire des utilisateurs" mandatory="True"/> <variable name='ldapclient_search_dn' type='string' description="Base DN de l'annuaire des utilisateurs" mandatory="True" mode="expert"/>
<variable name='ldapclient_group_dn' type='string' description="Base DN de l'annuaire des groupes" mandatory="True"/> <variable name='ldapclient_group_dn' type='string' description="Base DN de l'annuaire des groupes" mandatory="True" mode="expert"/>
<variable name='ldapclient_user_dn' type='string' description="Base DN de l'annuaire des utilisateurs n'appartenant à une famille" mandatory="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="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" description="Propriétaire du fichier de la clef privée LDAP" hidden="True">
<value>root</value> <value>root</value>
</variable> </variable>

152
seed/lemonldap/README.md
View file

@ -5,18 +5,93 @@ include_toc: true
# lemonldap # lemonldap
## Description ## Synopsis
LemonLDAP, a Web Single Sign On and Access Management. LemonLDAP, a Web Single Sign On and Access Management.
[For more informations](https://lemonldap-ng.org/) [More informations about this software.](https://lemonldap-ng.org/)
## Examples ## Basic variables
### Général
#### Reverse proxy
##### Point d'entrée des clients
This a 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 a 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
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
lemonldap: lemonldap:
applicationservice: lemonldap applicationservice: lemonldap
@ -26,20 +101,10 @@ lemonldap:
- localdns - localdns
- reverseproxy - reverseproxy
- smtp - smtp
``` values:
general.revprox.revprox_client.revprox_client_external_domainnames:
With all providers: - service.example.net
general.lemonldap.lemon_mail_admin: admin@example.net
```
lemonldap:
applicationservice: lemonldap
provider_zone: oauth2
zones_name:
- journald
- ldap
- localdns
- reverseproxy
- smtp
``` ```
## Dependances ## Dependances
@ -59,55 +124,6 @@ lemonldap:
- [journald](../journald/README.md) - [journald](../journald/README.md)
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md)
## Variables
### Général (*general*)
#### nginx (*general.nginx*)
| Description | Values |
|---------------------------------------------------------------|----------|
| *[**nginx_default_https**](dictionaries/70_lemonldap_ng.xml)* | False |
#### LemonLDAP (*general.lemonldap*)
Configuration de la solution d'authentification unique LemonLDAP::NG
| Description | Type | Values |
|------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|----------|
| **Nombre de processus dédié à LemonLdap (équivalent au nombre de processeurs)** (*[lemon_proc](dictionaries/70_lemonldap_ng.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 1 |
| **Courriel de l'administrateur** (*[lemon_mail_admin](dictionaries/70_lemonldap_ng.xml)*) | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | |
#### ldap (*general.ldap*)
##### client (*general.ldap.client*)
| Description | Values |
|-------------------------------------------------------------|----------|
| *[**ldapclient_family**](dictionaries/70_lemonldap_ng.xml)* | all |
### Oauth2 (*oauth2*)
| Description | Type | Provider |
|------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------|
| Remote clients needing to verify OAuth2 account (*[remotes](extras/oauth2/00_oauth2.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 |
#### OAuth2 for (*oauth2.oauth2_*)
This a dynamic family generated from the variable "oauth2.remotes".
##### external_ (*oauth2.oauth2_.external_*)
This a family is a leadership.
| Description | Provider |
|--------------------------------------------------------------------|-----------------|
| Remote external for (*[hosts_](extras/oauth2/00_oauth2.xml)*) [+] | OAuth2:external |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Supplier ## Supplier
[oauth2-client](../oauth2-client/README.md) [oauth2-client](../oauth2-client/README.md)

4
seed/lemonldap/dictionaries/70_lemonldap_ng.xml
View file

@ -29,10 +29,10 @@
</variable> </variable>
</family> </family>
<family name="lemonldap" description="LemonLDAP" help="Configuration de la solution d'authentification unique LemonLDAP::NG"> <family name="lemonldap" description="LemonLDAP" help="Configuration de la solution d'authentification unique LemonLDAP::NG">
<variable name="lemon_proc" type="number" description="Nombre de processus dédié à LemonLdap (équivalent au nombre de processeurs)" mandatory="True"> <variable name="lemon_proc" type="number" description="Nombre de processus dédié à LemonLdap (équivalent au nombre de processeurs)" mandatory="True" mode="expert">
<value>1</value> <value>1</value>
</variable> </variable>
<variable name="lemon_mail_admin" type="mail" description="Courriel de l'administrateur" mandatory="True"/> <variable name="lemon_mail_admin" type="mail" description="Courriel de l'administrateur" mandatory="True" test="admin@example.net"/>
</family> </family>
<family name="ldap"> <family name="ldap">
<family name="client"> <family name="client">

40
seed/loki/README.md
View file

@ -5,18 +5,23 @@ include_toc: true
# loki # loki
## Description ## Synopsis
Loki, a log aggregation platform. Loki, a log aggregation platform.
[For more informations](https://grafana.com/) [More informations about this software.](https://grafana.com/)
## Examples ## Requirements services
- **LocalDNS**
- Journald
**bold**: provider is mandatory
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
loki: loki:
applicationservice: loki applicationservice: loki
@ -25,17 +30,6 @@ loki:
- localdns - localdns
``` ```
With all providers:
```
loki:
applicationservice: loki
provider_zone: loki
zones_name:
- journald
- localdns
```
## Dependances ## Dependances
- [base-fedora-38](../base-fedora-38/README.md) - [base-fedora-38](../base-fedora-38/README.md)
@ -48,20 +42,6 @@ loki:
- [journald](../journald/README.md) - [journald](../journald/README.md)
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md)
## Variables
### Général (*general*)
#### loki (*general.loki*)
| Description | Type | Provider |
|--------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------|
| **Remote loki client** (*[remotes](dictionaries/20_loki.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Loki |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Supplier ## Supplier
[vector](../vector/README.md) [vector](../vector/README.md)

190
seed/mailman/README.md
View file

@ -5,18 +5,114 @@ include_toc: true
# mailman # mailman
## Description ## Synopsis
GNU Mailman, managing electronic mail discussion and e-newsletter lists. GNU Mailman, managing electronic mail discussion and e-newsletter lists.
[For more informations](https://www.list.org) [More informations about this software.](https://www.list.org)
## Examples ## Basic variables
### Général
#### Reverse proxy
##### Point d'entrée des clients
This a 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. |
#### Gestionnaire de liste
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|
| **[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 |
### Mailman
#### Listes du domaine
This a dynamic family generated from the variable "general.mailman.mailman_domains".
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|
| **[mailman.list_.name_](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 . |
## 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 a 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. |
#### 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
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| **[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_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
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|
| **[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 |
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|
| **[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 |
## Requirements services
- **LocalDNS**
- Journald
- **SMTP**
- **ReverseProxy**
- **Postgresql**
- **LMTP**
- **OAuth2**
**bold**: provider is mandatory
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
mailman: mailman:
applicationservice: mailman applicationservice: mailman
@ -27,21 +123,12 @@ mailman:
- lmtp - lmtp
- oauth2 - oauth2
- postgresql - postgresql
``` values:
general.revprox.revprox_client.revprox_client_external_domainnames:
With all providers: - service.example.net
general.mailman.mailman_mail_owner: admin@example.net
``` general.mailman.mailman_domains:
mailman: - list.example.net
applicationservice: mailman
zones_name:
- journald
- localdns
- reverseproxy
- smtp
- lmtp
- oauth2
- postgresql
``` ```
## Dependances ## Dependances
@ -64,67 +151,4 @@ mailman:
- [reverse-proxy-client](../reverse-proxy-client/README.md) - [reverse-proxy-client](../reverse-proxy-client/README.md)
- [oauth2-client](../oauth2-client/README.md) - [oauth2-client](../oauth2-client/README.md)
## Variables
### Général (*general*)
#### Gestionnaire de liste (*general.mailman*)
| Description | Type |
|-------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
| Courriel du gestionnaire de liste du site (*[mailman_mail_owner](dictionaries/31_mailman.xml)*) | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **Nom de domaine des listes** (*[mailman_domains](dictionaries/31_mailman.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
#### oauth2_client (*general.oauth2_client*)
| Description | Values |
|-------------------------------------------------------------------------|-------------------------------|
| *[**oauth2_is_client_application**](dictionaries/31_mailman.xml)* | True |
| *[**oauth2_client_name**](dictionaries/31_mailman.xml)* | Liste de distribution |
| *[**oauth2_client_description**](dictionaries/31_mailman.xml)* | Liste de distribution Mailman |
| *[**oauth2_client_category**](dictionaries/31_mailman.xml)* | Développement |
| *[**oauth2_client_logo**](dictionaries/31_mailman.xml)* | silique_email.png |
| *[**oauth2_client_token_signature_algo**](dictionaries/31_mailman.xml)* | RS256 |
##### external (*general.oauth2_client.external*)
| Description | Values |
|---------------------------------------------------------|--------------|
| *[oauth2_client_external](dictionaries/31_mailman.xml)* | <calculated> |
#### nginx (*general.nginx*)
| Description | Values |
|----------------------------------------------------------|------------------------------|
| *[**nginx_default_https**](dictionaries/31_mailman.xml)* | False |
| *[**nginx_root**](dictionaries/31_mailman.xml)* | /usr/share/webapps/postorius |
#### postgresql (*general.postgresql*)
| Description | Values |
|----------------------------------------------------------|----------|
| *[**pg_client_key_owner**](dictionaries/31_mailman.xml)* | list |
### Mailman (*mailman*)
#### Listes du domaine (*mailman.list_*)
This a dynamic family generated from the variable "general.mailman.mailman_domains".
| Description | Type |
|--------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
| **Nom des listes ** (*[name_](extras/mailman/20_mailman.xml)*) [+] | [unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
### Machine (*machine*)
| Description | Values |
|-------------------------------------------------|----------|
| *[**var_size**](extras/machine/20_mailman.xml)* | 256 |
| *[**add_tmp**](extras/machine/20_mailman.xml)* | False |
| *[**add_swap**](extras/machine/20_mailman.xml)* | False |
- [+]: variable is multiple
- **bold**: variable is mandatory
[All applications services for this dataset.](../README.md) [All applications services for this dataset.](../README.md)

4
seed/mailman/dictionaries/31_mailman.xml
View file

@ -20,8 +20,8 @@
</services> </services>
<variables> <variables>
<family name="mailman" description="Gestionnaire de liste"> <family name="mailman" description="Gestionnaire de liste">
<variable name="mailman_mail_owner" type="mail" description="Courriel du gestionnaire de liste du site"/> <variable name="mailman_mail_owner" type="mail" description="Courriel du gestionnaire de liste du site" mandatory="True" test="admin@example.net"/>
<variable name="mailman_domains" type="domainname" description="Nom de domaine des listes" multi="True" mandatory="True"/> <variable name="mailman_domains" type="domainname" description="Nom de domaine des listes" multi="True" mandatory="True" test="list.example.net"/>
<variable name="postorius_secret_key" type="password" description="Internal secret key" mandatory="True" hidden="True" auto_save="False"/> <variable name="postorius_secret_key" type="password" description="Internal secret key" mandatory="True" hidden="True" auto_save="False"/>
</family> </family>
<family name="oauth2_client"> <family name="oauth2_client">

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

@ -5,25 +5,11 @@ include_toc: true
# mariadb-client # mariadb-client
## Description ## Synopsis
Application service needs interact with a MariaDB server. Application service needs interact with a MariaDB server.
[For more informations](https://mariadb.org/) [More informations about this software.](https://mariadb.org/)
## Variables
### Général (*general*)
#### MariaDB (*general.mariadb*)
| Description | Type | Supplier |
|-----------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------|
| **Nom de domaine du serveur MariaDB** (*[mariadb_client_server_domainname](dictionaries/20_mariadb.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | MariaDB |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Used by ## Used by

38
seed/mariadb/README.md
View file

@ -5,18 +5,23 @@ include_toc: true
# mariadb # mariadb
## Description ## Synopsis
MariaDB, a relational database. MariaDB, a relational database.
[For more informations](https://mariadb.org/) [More informations about this software.](https://mariadb.org/)
## Examples ## Requirements services
- **LocalDNS**
- Journald
**bold**: provider is mandatory
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
mariadb: mariadb:
applicationservice: mariadb applicationservice: mariadb
@ -25,17 +30,6 @@ mariadb:
- localdns - localdns
``` ```
With all providers:
```
mariadb:
applicationservice: mariadb
provider_zone: mariadb
zones_name:
- journald
- localdns
```
## Dependances ## Dependances
- [base-fedora-36](../base-fedora-36/README.md) - [base-fedora-36](../base-fedora-36/README.md)
@ -48,18 +42,6 @@ mariadb:
- [journald](../journald/README.md) - [journald](../journald/README.md)
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md)
## Variables
### Accounts (*accounts*)
| Description | Type | Provider |
|--------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------|
| Remote clients needing an account (*[remotes](extras/accounts/00_accounts.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | MariaDB |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Supplier ## Supplier
[mariadb-client](../mariadb-client/README.md) [mariadb-client](../mariadb-client/README.md)

185
seed/nextcloud/README.md
View file

@ -5,18 +5,141 @@ include_toc: true
# nextcloud # nextcloud
## Description ## Synopsis
Nextcloud, Online collaboration platform. Nextcloud, Online collaboration platform.
[For more informations](https://nextcloud.com/) [More informations about this software.](https://nextcloud.com/)
## Examples ## Basic variables
### Général
#### Reverse proxy
##### Point d'entrée des clients
This a 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. |
#### Nextcloud
| 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 |
## 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/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
| 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_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
##### Point d'entrée des clients
This a 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. |
#### 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
| Parameter | Comments |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| **[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_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
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|
| **[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 |
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|
| **[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 |
## Requirements services
- **LocalDNS**
- Journald
- **SMTP**
- **LDAP**
- **ReverseProxy**
- **Postgresql**
- **Redis**
- **OAuth2**
**bold**: provider is mandatory
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
nextcloud: nextcloud:
applicationservice: nextcloud applicationservice: nextcloud
@ -28,22 +151,10 @@ nextcloud:
- redis - redis
- oauth2 - oauth2
- postgresql - postgresql
``` values:
general.revprox.revprox_client.revprox_client_external_domainnames:
With all providers: - service.example.net
general.nextcloud.nextcloud_mail_admin: admin@example.net
```
nextcloud:
applicationservice: nextcloud
zones_name:
- journald
- ldap
- localdns
- reverseproxy
- smtp
- redis
- oauth2
- postgresql
``` ```
## Dependances ## Dependances
@ -68,36 +179,4 @@ nextcloud:
- [php-fpm](../php-fpm/README.md) - [php-fpm](../php-fpm/README.md)
- [php](../php/README.md) - [php](../php/README.md)
## Variables
### Général (*general*)
#### Nextcloud (*general.nextcloud*)
| Description | Type |
|---------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
| *[**nextcloud_mail_admin**](dictionaries/31_nextcloud.xml)* | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| Nom de domaine du serveur hebergeant le répertoire .well-known (*[nextcloud_well_known_server](dictionaries/31_nextcloud.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
#### oauth2_client (*general.oauth2_client*)
| Description | Values |
|---------------------------------------------------------------------|---------------------------------------|
| *[**oauth2_is_client_application**](dictionaries/31_nextcloud.xml)* | True |
| *[**oauth2_client_name**](dictionaries/31_nextcloud.xml)* | Collaboration |
| *[**oauth2_client_description**](dictionaries/31_nextcloud.xml)* | Plateforme de collaboration Nextcloud |
| *[**oauth2_client_category**](dictionaries/31_nextcloud.xml)* | Diffusion |
| *[**oauth2_client_logo**](dictionaries/31_nextcloud.xml)* | silique_folder.png |
#### php (*general.php*)
| Description | Values |
|--------------------------------------------------------------------|----------|
| *[**php_enable_output_buffering**](dictionaries/31_nextcloud.xml)* | False |
| *[**php_disable_pcntl**](dictionaries/31_nextcloud.xml)* | False |
- [+]: variable is multiple
- **bold**: variable is mandatory
[All applications services for this dataset.](../README.md) [All applications services for this dataset.](../README.md)

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

@ -15,11 +15,8 @@
<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"/> <variable name="nextcloud_mail_admin" type="mail" 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"/>
<variable name="nextcloud_well_known_server" type="domainname" description="Nom de domaine du serveur hebergeant le répertoire .well-known"/>
<variable name="nextcloud_well_known_caldav" type="web_address" hidden='True'/>
<variable name="nextcloud_well_known_carddav" type="web_address" hidden='True'/>
</family> </family>
<family name="oauth2_client"> <family name="oauth2_client">
<variable name="oauth2_is_client_application" redefine='True'> <variable name="oauth2_is_client_application" redefine='True'>
@ -66,19 +63,5 @@
<param name="hide" type="variable">hide_secret</param> <param name="hide" type="variable">hide_secret</param>
<target>nextcloud_instance_id</target> <target>nextcloud_instance_id</target>
</fill> </fill>
<fill name="calc_web_address">
<param type="variable">domain_name_eth0</param>
<param type="variable">revprox_client_port</param>
<param>/.well-known/caldav</param>
<param type="variable">revprox_client_http</param>
<target>nextcloud_well_known_caldav</target>
</fill>
<fill name="calc_web_address">
<param type="variable">domain_name_eth0</param>
<param type="variable">revprox_client_port</param>
<param>/.well-known/carddav</param>
<param type="variable">revprox_client_http</param>
<target>nextcloud_well_known_carddav</target>
</fill>
</constraints> </constraints>
</rougail> </rougail>

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

@ -5,29 +5,26 @@ include_toc: true
# nginx-common # nginx-common
## Description ## Synopsis
Nginx common configuration. Nginx common configuration.
[For more informations](https://nginx.org/) [More informations about this software.](https://nginx.org/)
## Variables
### Général (*general*)
#### NGINX (*general.nginx*)
Paramétrage global de NGINX
| Description | Help | Type | Values | Choices |
|-------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|----------|---------------------|
| Nom de domaine du serveur mandataire inverse par défaut (*[nginx_default](dictionaries/21_nginx.xml)*) | Si un client accède au serveur avec un nom de domaine non déclaré, le flux est redirigé vers ce domaine | [domainname](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** (*[nginx_hash_bucket_size](dictionaries/21_nginx.xml)*) | | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 128 | 128<br />64<br />32 |
| **Taille maximale des données reçues par la méthode POST (en Mo)** (*[nginx_post_max_size](dictionaries/21_nginx.xml)*) | | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 32 | |
- [+]: variable is multiple
- **bold**: variable is mandatory ## 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 |
## Used by ## Used by

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

@ -19,7 +19,7 @@
<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="Activer la gestion du répertoire default.d en HTTPS sur le serveur" 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'/> <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_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>

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

@ -5,11 +5,11 @@ include_toc: true
# nginx-https # nginx-https
## Description ## Synopsis
Nginx as HTTPS web site. Nginx as HTTPS web site.
[For more informations](https://nginx.org/) [More informations about this software.](https://nginx.org/)
## Dependances ## Dependances

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

@ -5,18 +5,50 @@ include_toc: true
# nginx-reverse-proxy # nginx-reverse-proxy
## Description ## Synopsis
Nginx as reverse proxy. Nginx as reverse proxy.
[For more informations](https://nginx.org/) [More informations about this software.](https://nginx.org/)
## Examples
## Variables
### 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
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
nginx-reverse-proxy: nginx-reverse-proxy:
applicationservice: nginx-reverse-proxy applicationservice: nginx-reverse-proxy
@ -25,17 +57,6 @@ nginx-reverse-proxy:
- localdns - localdns
``` ```
With all providers:
```
nginx-reverse-proxy:
applicationservice: nginx-reverse-proxy
provider_zone: reverseproxy
zones_name:
- journald
- localdns
```
## Dependances ## Dependances
- [nginx-common](../nginx-common/README.md) - [nginx-common](../nginx-common/README.md)
@ -49,46 +70,6 @@ nginx-reverse-proxy:
- [journald](../journald/README.md) - [journald](../journald/README.md)
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md)
## Variables
### Général (*general*)
#### network (*general.network*)
| Description | Values |
|-------------------------------------------------------|-------------|
| *[**incoming_ports**](dictionaries/25_nginx.xml)* [+] | 80<br />443 |
#### NGINX (*general.nginx*)
Paramétrage global de NGINX
| Description | Type | Values | Choices |
|------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|--------------|----------------------------|
| **Autorité de certification signant le certificat des domaines extérieurs** (*[nginx_certificates_provider](dictionaries/25_nginx.xml)*) | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | autosigne | autosigne<br />letsencrypt |
| *[**nginx_default**](dictionaries/25_nginx.xml)* | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | <calculated> | |
| *[**nginx_default_http**](dictionaries/25_nginx.xml)* | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | False | |
| *[**nginx_default_https**](dictionaries/25_nginx.xml)* | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | False | |
### Machine (*machine*)
| Description | Values |
|-------------------------------------------------------|----------|
| *[**var_size**](extras/machine/20_reverse_proxy.xml)* | 256 |
| *[**add_tmp**](extras/machine/20_reverse_proxy.xml)* | False |
| *[**add_srv**](extras/machine/20_reverse_proxy.xml)* | False |
| *[**add_swap**](extras/machine/20_reverse_proxy.xml)* | False |
### Nginx (*nginx*)
| Description | Type | Provider |
|--------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|--------------|
| Nom des domaines dans le serveur mandataire inverse (*[remotes](extras/nginx/00_nginx.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | ReverseProxy |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Supplier ## Supplier
[reverse-proxy-client](../reverse-proxy-client/README.md) [reverse-proxy-client](../reverse-proxy-client/README.md)

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

@ -21,11 +21,11 @@
</family> </family>
<family name="nginx" description="NGINX" help="Paramétrage global de NGINX"> <family name="nginx" description="NGINX" help="Paramétrage global de NGINX">
<variable name="nginx_certificates_provider" type="choice" description="Autorité de certification signant le certificat des domaines extérieurs" mandatory="True"> <variable name="nginx_certificates_provider" type="choice" description="Autorité de certification signant le certificat des domaines extérieurs" mandatory="True">
<value>autosigne</value> <value>self-signed</value>
<choice>autosigne</choice> <choice>self-signed</choice>
<choice>letsencrypt</choice> <choice>letsencrypt</choice>
</variable> </variable>
<variable name="nginx_default" redefine="True" mandatory="True"/> <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>

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

@ -5,11 +5,86 @@ include_toc: true
# nginx-static # nginx-static
## Description ## Synopsis
Nginx as static web site. Nginx as static web site.
[For more informations](https://nginx.org/) [More informations about this software.](https://nginx.org/)
## Basic variables
### Général
#### Reverse proxy
##### Point d'entrée des clients
This a 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 a 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
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
```
nginx-static:
applicationservice: nginx-static
zones_name:
- localdns
- reverseproxy
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
```
## Dependances ## Dependances
@ -26,18 +101,4 @@ Nginx as static web site.
- [journald](../journald/README.md) - [journald](../journald/README.md)
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md)
## Variables
### Général (*general*)
#### nginx (*general.nginx*)
| Description | Values |
|------------------------------------------------------|-------------|
| *[**nginx_root**](dictionaries/22_nginx_static.xml)* | /srv/static |
- [+]: variable is multiple
- **bold**: variable is mandatory
[All applications services for this dataset.](../README.md) [All applications services for this dataset.](../README.md)

1
seed/nginx-static/applicationservice.yml
View file

@ -4,3 +4,4 @@ website: https://nginx.org/
depends: depends:
- nginx-https - nginx-https
- base-fedora-37 - base-fedora-37
service: true

2
seed/nginx-static/dictionaries/22_nginx_static.xml
View file

@ -8,7 +8,7 @@
</services> </services>
<variables> <variables>
<family name="nginx"> <family name="nginx">
<variable name="nginx_root" redefine="True" mandatory='True'> <variable name="nginx_root" description="Adresse racine du site web" redefine="True" mandatory='True' hidden="False">
<value>/srv/static</value> <value>/srv/static</value>
</variable> </variable>
<variable name="nginx_index_file" type="filename" mandatory='True' hidden="True"/> <variable name="nginx_index_file" type="filename" mandatory='True' hidden="True"/>

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

@ -5,18 +5,24 @@ include_toc: true
# nsd-local # nsd-local
## Description ## Synopsis
NSD, an authoritative DNS name server for local resolution. NSD, an authoritative DNS name server for local resolution.
[For more informations](https://www.nlnetlabs.nl/projects/nsd/about/) [More informations about this software.](https://www.nlnetlabs.nl/projects/nsd/about/)
## Examples ## Requirements services
- **LocalDNS**
- Journald
- ExternalDNS
**bold**: provider is mandatory
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
nsd-local: nsd-local:
applicationservice: nsd-local applicationservice: nsd-local
@ -25,18 +31,6 @@ nsd-local:
- localdns - localdns
``` ```
With all providers:
```
nsd-local:
applicationservice: nsd-local
provider_zone: localdns
zones_name:
- journald
- externaldns
- localdns
```
## Dependances ## Dependances
- [nsd](../nsd/README.md) - [nsd](../nsd/README.md)
@ -50,20 +44,6 @@ nsd-local:
- [journald](../journald/README.md) - [journald](../journald/README.md)
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md)
## Variables
### Général (*general*)
#### Serveur DNS (*general.dns_server*)
| Description | Supplier |
|-------------------------------------------------|-------------|
| *[nsd_resolver](dictionaries/21_nsd-local.xml)* | ExternalDNS |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Supplier ## Supplier
[dns-local](../dns-local/README.md) [dns-local](../dns-local/README.md)

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

@ -2,6 +2,7 @@
<rougail version="0.10"> <rougail version="0.10">
<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_clients" type="domainname" description="Clients" multi="True" hidden="True" provider="LocalDNS"/> <variable name="nsd_allowed_clients" type="domainname" description="Clients" 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"/>
@ -10,6 +11,12 @@
<variable name="nsd_resolver" redefine="True" supplier="ExternalDNS"/> <variable name="nsd_resolver" redefine="True" supplier="ExternalDNS"/>
<variable name="nsd_resolve_ip" type="ip" hidden="True"/> <variable name="nsd_resolve_ip" type="ip" hidden="True"/>
</family> </family>
<family name="dns_zone">
<variable name="nsd_zones" redefine="True" hidden="True"/>
</family>
<family name="dns_reverses">
<variable name="nsd_reverse_network" redefine="True" hidden="True"/>
</family>
</variables> </variables>
<constraints> <constraints>
<fill name="get_ip"> <fill name="get_ip">

141
seed/nsd/README.md
View file

@ -5,33 +5,79 @@ include_toc: true
# nsd # nsd
## Description ## Synopsis
NSD, an authoritative DNS name server. NSD, an authoritative DNS name server.
[For more informations](https://www.nlnetlabs.nl/projects/nsd/about/) [More informations about this software.](https://www.nlnetlabs.nl/projects/nsd/about/)
## Examples ## 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 a 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
This a dynamic family generated from the variable "general.dns_zone.nsd_zones".
##### Nom d'hôte pour
This a family is a leadership.
| Parameter | Comments |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
| **[nsd.nsd_zone_.hostname_.hostname_](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_.hostname_.type_](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_.hostname_.ip_](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_.hostname_.cname_](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_.ns_](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
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
nsd: nsd:
applicationservice: nsd applicationservice: nsd
zones_name: zones_name:
- localdns - localdns
``` values:
general.dns_zone.nsd_zones:
With all providers: - subdomain.example.net
```
nsd:
applicationservice: nsd
zones_name:
- journald
- localdns
``` ```
## Dependances ## Dependances
@ -46,71 +92,6 @@ nsd:
- [journald](../journald/README.md) - [journald](../journald/README.md)
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md)
## Variables
### Général (*general*)
#### network (*general.network*)
| Description | Values |
|-------------------------------------|--------------|
| *[ip_dns](dictionaries/20_nsd.xml)* | <calculated> |
#### Serveur DNS (*general.dns_server*)
| Description | Type |
|----------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
| Clients autorisés à interroger le serveur DNS (*[nsd_allowed_client_cidr](dictionaries/20_nsd.xml)*) [+] | [network_cidr](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é (*[nsd_resolver](dictionaries/20_nsd.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
#### Zone DNS (*general.dns_zone*)
| Description | Type |
|------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
| **Zones DNS** (*[nsd_zones](dictionaries/20_nsd.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
#### Zone DNS reverse (*general.dns_reverses*)
This a family is a leadership.
| Description | Type |
|------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
| Réseau pour la résolution reverse (*[nsd_reverse_network](dictionaries/20_nsd.xml)*) [+] | [network_cidr](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
### Machine (*machine*)
| Description | Values |
|---------------------------------------------|----------|
| *[**var_size**](extras/machine/20_nsd.xml)* | 256 |
| *[**add_tmp**](extras/machine/20_nsd.xml)* | False |
| *[**add_srv**](extras/machine/20_nsd.xml)* | False |
| *[**add_swap**](extras/machine/20_nsd.xml)* | False |
### Nsd (*nsd*)
#### Zone (*nsd.nsd_zone_*)
This a dynamic family generated from the variable "general.dns_zone.nsd_zones".
| Description | Type |
|------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
| **Nom des serveurs de nom de la zone ** (*[ns_](extras/nsd/00_nsd.xml)*) [+] | [domainname](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_.hostname_*)
This a family is a leadership.
| Description | Type | Choices |
|-------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|--------------|
| **Nom d'hôte pour ** (*[hostname_](extras/nsd/00_nsd.xml)*) [+] | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | |
| **Type pour ** (*[type_](extras/nsd/00_nsd.xml)*) | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | A<br />CNAME |
| **Adresse IP a renvoyer pour ** (*[ip_](extras/nsd/00_nsd.xml)*) | [ip](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 ** (*[cname_](extras/nsd/00_nsd.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Used by ## Used by
[nsd-local](../nsd-local/README.md) [nsd-local](../nsd-local/README.md)

8
seed/nsd/dictionaries/20_nsd.xml
View file

@ -20,15 +20,15 @@
<variable name="ip_dns" redefine="True" remove_fill="True"/> <variable name="ip_dns" redefine="True" remove_fill="True"/>
</family> </family>
<family name="dns_server" description="Serveur DNS"> <family name="dns_server" description="Serveur DNS">
<variable name="nsd_allowed_client_cidr" type="network_cidr" description="Clients autorisés à interroger le serveur DNS" multi="True"/> <variable name="nsd_allowed_client_cidr" type="network_cidr" description="Clients autorisés à interroger le serveur DNS" multi="True" mode="basic"/>
<variable name="nsd_resolver" type="domainname" description="Nom de domaine du résolveur DNS associé"/> <variable name="nsd_resolver" type="domainname" description="Nom de domaine du résolveur DNS associé" mode="basic"/>
<variable name="nsd_allowed_all_client" type="network_cidr" description="All autorised IP" multi="True" hidden="True"/> <variable name="nsd_allowed_all_client" type="network_cidr" description="All autorised IP" multi="True" hidden="True"/>
</family> </family>
<family name="dns_zone" description="Zone DNS"> <family name="dns_zone" description="Zone DNS">
<variable name="nsd_zones" type="domainname" description="Zones DNS" multi="True" mandatory="True"/> <variable name="nsd_zones" type="domainname" description="Zones DNS" multi="True" mandatory="True" test="subdomain.example.net" mode="basic"/>
</family> </family>
<family name="dns_reverses" description="Zone DNS reverse" leadership="True"> <family name="dns_reverses" description="Zone DNS reverse" leadership="True">
<variable name="nsd_reverse_network" description="Réseau pour la résolution reverse" type="network_cidr" multi="True"/> <variable name="nsd_reverse_network" description="Réseau pour la résolution reverse" type="network_cidr" multi="True" mode="basic"/>
<variable name="nsd_reverse_name" description="Nom de la zone" hidden="True"/> <variable name="nsd_reverse_name" description="Nom de la zone" hidden="True"/>
</family> </family>
<variable name="nsd_reverse_networks" description="Réseaux pour la résolution inverse" hidden="True" multi="True"/> <variable name="nsd_reverse_networks" description="Réseaux pour la résolution inverse" hidden="True" multi="True"/>

2
seed/nsd/extras/nsd/00_nsd.xml
View file

@ -4,7 +4,7 @@
<family name="nsd_zone_" description="Zone " dynamic="nsd_zones"> <family name="nsd_zone_" description="Zone " dynamic="nsd_zones">
<family name="hostname_" description="Nom d'hôte pour " leadership="True"> <family name="hostname_" description="Nom d'hôte pour " leadership="True">
<variable name="hostname_" description="Nom d'hôte pour " type="string" multi="True" mandatory="True"/> <variable name="hostname_" description="Nom d'hôte pour " type="string" multi="True" mandatory="True"/>
<variable name="type_" description="Type pour " type="choice"> <variable name="type_" description="Type pour " type="choice" mode="basic">
<choice type="string">A</choice> <choice type="string">A</choice>
<choice type="string">CNAME</choice> <choice type="string">CNAME</choice>
<value type="string">A</value> <value type="string">A</value>

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

@ -5,37 +5,35 @@ include_toc: true
# oauth2-client # oauth2-client
## Description ## Synopsis
Application service needs interact with a Oauth2 server. Application service needs interact with a Oauth2 server.
## Variables
### Général (*general*)
#### OAuth2 client (*general.oauth2_client*)
| Description | Type | Supplier | Values | Provider |
|-----------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|--------------------|----------|------------------------|
| **OAuth2 server domain name** (*[oauth2_client_server_domainname](dictionaries/30_oauth2_client.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 | | |
| **OAuth2 client is an application** (*[oauth2_is_client_application](dictionaries/30_oauth2_client.xml)*) | [boolean](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | False | |
| **OAuth2 client name** (*[oauth2_client_name](dictionaries/30_oauth2_client.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2:name | | |
| **OAuth2 client description** (*[oauth2_client_description](dictionaries/30_oauth2_client.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2:description | | |
| OAuth2 URL to valid login (*[oauth2_client_login](dictionaries/30_oauth2_client.xml)*) | [web_address](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2:login | | |
| **OAuth2 category** (*[oauth2_client_category](dictionaries/30_oauth2_client.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2:category | Défaut | |
| **OAuth2 logo** (*[oauth2_client_logo](dictionaries/30_oauth2_client.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2:logo | demo.png | |
| **OAuth2 server external domain name** (*[oauth2_server_domainname](dictionaries/30_oauth2_client.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | OAuth2:external_domain |
##### external (*general.oauth2_client.external*)
| Description | Type | Values | Supplier |
|------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|--------------|-----------------|
| **OAuth2 client external** (*[oauth2_client_external](dictionaries/30_oauth2_client.xml)*) [+] | [web_address](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | <calculated> | OAuth2:external |
| **OAuth2 family** (*[oauth2_client_family](dictionaries/30_oauth2_client.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | users | OAuth2:family |
- [+]: variable is multiple ## Variables for expert
- **bold**: variable is mandatory
### Général
#### OAuth2 client
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| **[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_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
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|
| **[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 |
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|
| **[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 |
## Used by ## Used by

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

@ -6,11 +6,11 @@
<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" description="OAuth2 server domain name" mandatory='True' supplier="OAuth2"/>
<variable name="oauth2_is_client_application" type="boolean" description="OAuth2 client is an application" mandatory='True'> <variable name="oauth2_is_client_application" type="boolean" description="OAuth2 client is an application" 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"/> <variable name="oauth2_client_name" description="OAuth2 client name" mandatory='True' supplier="OAuth2:name" test="example"/>
<variable name="oauth2_client_description" description="OAuth2 client description" mandatory='True' supplier="OAuth2:description"/> <variable name="oauth2_client_description" description="OAuth2 client description" mandatory='True' supplier="OAuth2:description" test="Example description"/>
<variable name="oauth2_client_login" type="web_address" description="OAuth2 URL to valid login" supplier="OAuth2:login"/> <variable name="oauth2_client_login" type="web_address" description="OAuth2 URL to valid login" supplier="OAuth2:login"/>
<family name="external"> <family name="external">
<variable name="oauth2_client_external" type="web_address" description="OAuth2 client external" mandatory='True' multi="True" supplier="OAuth2:external"/> <variable name="oauth2_client_external" type="web_address" description="OAuth2 client external" mandatory='True' multi="True" supplier="OAuth2:external"/>

218
seed/odoo/README.md
View file

@ -5,18 +5,132 @@ include_toc: true
# odoo # odoo
## Description ## Synopsis
Odoo, an ERP and CRM. Odoo, an ERP and CRM.
[For more informations](https://www.odoo.com/fr) [More informations about this software.](https://www.odoo.com/fr)
## Examples ## Basic variables
### Général
#### Reverse proxy
##### Point d'entrée des clients
This a 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. |
#### Odoo
| Parameter | Comments |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|
| **[general.odoo.odoo_admin_email](dictionaries/40_odoo.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.<br/>**Example:** johndoe@example.net |
| **[general.odoo.odoo_company_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) | Nom.<br/>**Example:** ACME |
| **[general.odoo.odoo_company_street](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) | Adresse.<br/>**Example:** John Doe Street |
| **[general.odoo.odoo_company_city](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) | Ville.<br/>**Example:** Dijon |
| **[general.odoo.odoo_company_zip](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) | Code postal.<br/>**Example:** 21000 |
| **[general.odoo.odoo_company_vat](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) | Numéro TVA.<br/>**Example:** FR 99999999999 |
| **[general.odoo.odoo_company_registry](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) | Registre de la société.<br/>**Example:** 999 999 999 00099 |
| **[general.odoo.odoo_company_phone](dictionaries/40_odoo.xml)**<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Numéro de téléphone. |
| **[general.odoo.odoo_company_mobile](dictionaries/40_odoo.xml)**<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Numéro de téléphone mobile. |
| **[general.odoo.odoo_company_email](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) | Adresse courriel.<br/>**Example:** johndoe@example.net |
| **[general.odoo.odoo_company_website](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) | Site internet.<br/>**Example:** https://example.net |
| **[general.odoo.odoo_company_logo](dictionaries/40_odoo.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) | Chemin du logo.<br/>**Example:** /home/jdoe/logo.png |
| **[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` |
## Variables for expert
### Général
#### Annuaire OpenLDAP
##### Client
| 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_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 a 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. |
#### 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
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------|
| **[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_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
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|
| **[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> |
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|
| **[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 |
#### Odoo
| Parameter | Comments |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.odoo.odoo_addons](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) | Liste des applications à activer.<br/>**Default:** <ul><li>base</li><li>l10n_fr</li><li>l10n_fr_fec</li><li>account</li><li>hr</li><li>hr_contract</li><li>sale_management</li></ul> |
## Requirements services
- **LocalDNS**
- Journald
- **SMTP**
- **LDAP**
- **ReverseProxy**
- **Postgresql**
- **OAuth2**
**bold**: provider is mandatory
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
odoo: odoo:
applicationservice: odoo applicationservice: odoo
@ -27,21 +141,20 @@ odoo:
- smtp - smtp
- oauth2 - oauth2
- postgresql - postgresql
``` values:
general.revprox.revprox_client.revprox_client_external_domainnames:
With all providers: - service.example.net
general.odoo.odoo_admin_email: johndoe@example.net
``` general.odoo.odoo_company_name: ACME
odoo: general.odoo.odoo_company_street: John Doe Street
applicationservice: odoo general.odoo.odoo_company_city: Dijon
zones_name: general.odoo.odoo_company_zip: 21000
- journald general.odoo.odoo_company_vat: FR 99999999999
- ldap general.odoo.odoo_company_registry: 999 999 999 00099
- localdns general.odoo.odoo_company_email: johndoe@example.net
- reverseproxy general.odoo.odoo_company_website: https://example.net
- smtp general.odoo.odoo_company_logo: /home/jdoe/logo.png
- oauth2 general.odoo.odoo_company_footer: foot
- postgresql
``` ```
## Dependances ## Dependances
@ -64,69 +177,4 @@ odoo:
- [nginx-common](../nginx-common/README.md) - [nginx-common](../nginx-common/README.md)
- [reverse-proxy-client](../reverse-proxy-client/README.md) - [reverse-proxy-client](../reverse-proxy-client/README.md)
## Variables
### Général (*general*)
#### Odoo (*general.odoo*)
| Description | Type | Values | Choices |
|-------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|--------------------------------------------|
| **Adresse courriel de l'administrateur** (*[odoo_admin_email](dictionaries/40_odoo.xml)*) | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
| **Nom** (*[odoo_company_name](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
| **Adresse** (*[odoo_company_street](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
| **Ville** (*[odoo_company_city](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
| **Code postal** (*[odoo_company_zip](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
| **Numéro TVA** (*[odoo_company_vat](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
| **Registre de la société** (*[odoo_company_registry](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
| Numéro de téléphone (*[odoo_company_phone](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
| Numéro de téléphone mobile (*[odoo_company_mobile](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
| **Adresse courriel** (*[odoo_company_email](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
| **Site internet** (*[odoo_company_website](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
| **Chemin du logo** (*[odoo_company_logo](dictionaries/40_odoo.xml)*) | [filename](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
| **Pied de page des documents** (*[odoo_company_footer](dictionaries/40_odoo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
| **Agencement des documents** (*[odoo_company_layout](dictionaries/40_odoo.xml)*) | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | standard | standard<br />bold<br />boxed<br />striped |
| **Liste des applications à activer** (*[odoo_addons](dictionaries/40_odoo.xml)*) [+] | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | base<br />l10n_fr<br />l10n_fr_fec<br />account<br />hr<br />hr_contract<br />sale_management | |
#### postgresql (*general.postgresql*)
| Description | Values |
|-------------------------------------------------------|----------|
| *[**pg_client_key_owner**](dictionaries/40_odoo.xml)* | odoo |
#### oauth2_client (*general.oauth2_client*)
| Description | Values |
|----------------------------------------------------------------|------------------|
| *[**oauth2_is_client_application**](dictionaries/40_odoo.xml)* | True |
| *[**oauth2_client_name**](dictionaries/40_odoo.xml)* | ERP |
| *[**oauth2_client_description**](dictionaries/40_odoo.xml)* | ERP Odoo |
| *[**oauth2_client_category**](dictionaries/40_odoo.xml)* | Entreprise |
| *[**oauth2_client_logo**](dictionaries/40_odoo.xml)* | silique_note.png |
##### external (*general.oauth2_client.external*)
| Description |
|----------------------------------------------------------|
| *[oauth2_client_external](dictionaries/40_odoo.xml)* [+] |
| *[oauth2_client_family](dictionaries/40_odoo.xml)* [+] |
#### ldap (*general.ldap*)
##### client (*general.ldap.client*)
| Description | Values |
|-------------------------------------------------------|----------|
| *[**ldap_key_file_owner**](dictionaries/40_odoo.xml)* | odoo |
#### nginx (*general.nginx*)
| Description | Values |
|-------------------------------------------------------|----------|
| *[**nginx_default_https**](dictionaries/40_odoo.xml)* | False |
- [+]: variable is multiple
- **bold**: variable is mandatory
[All applications services for this dataset.](../README.md) [All applications services for this dataset.](../README.md)

30
seed/odoo/dictionaries/40_odoo.xml
View file

@ -15,27 +15,27 @@
<variables> <variables>
<family name="odoo" description="Odoo"> <family name="odoo" description="Odoo">
<variable name="odoo_admin_password" type="password" description="Mot de passe de l'administrateur" hidden="True"/> <variable name="odoo_admin_password" type="password" description="Mot de passe de l'administrateur" hidden="True"/>
<variable name="odoo_admin_email" type="mail" description="Adresse courriel de l'administrateur" mandatory="True"/> <variable name="odoo_admin_email" type="mail" description="Adresse courriel de l'administrateur" mandatory="True" test="johndoe@example.net"/>
<variable name="odoo_company_name" description="Nom" mandatory="True"/> <variable name="odoo_company_name" description="Nom" mandatory="True" test="ACME"/>
<variable name="odoo_company_street" description="Adresse" mandatory="True"/> <variable name="odoo_company_street" description="Adresse" mandatory="True" test="John Doe Street"/>
<variable name="odoo_company_city" description="Ville" mandatory="True"/> <variable name="odoo_company_city" description="Ville" mandatory="True" test="Dijon"/>
<variable name="odoo_company_zip" description="Code postal" mandatory="True"/> <variable name="odoo_company_zip" description="Code postal" mandatory="True" test="21000"/>
<variable name="odoo_company_vat" description="Numéro TVA" mandatory="True"/> <variable name="odoo_company_vat" description="Numéro TVA" mandatory="True" test="FR 99999999999"/>
<variable name="odoo_company_registry" description="Registre de la société" mandatory="True"/> <variable name="odoo_company_registry" description="Registre de la société" mandatory="True" test="999 999 999 00099"/>
<variable name="odoo_company_phone" description="Numéro de téléphone"/> <variable name="odoo_company_phone" description="Numéro de téléphone" mode="basic"/>
<variable name="odoo_company_mobile" description="Numéro de téléphone mobile"/> <variable name="odoo_company_mobile" description="Numéro de téléphone mobile" mode="basic"/>
<variable name="odoo_company_email" description="Adresse courriel" mandatory="True"/> <variable name="odoo_company_email" description="Adresse courriel" mandatory="True" test="johndoe@example.net"/>
<variable name="odoo_company_website" description="Site internet" mandatory="True"/> <variable name="odoo_company_website" description="Site internet" mandatory="True" test="https://example.net"/>
<variable name="odoo_company_logo" type="filename" description="Chemin du logo" mandatory="True"/> <variable name="odoo_company_logo" type="filename" description="Chemin du logo" mandatory="True" test="/home/jdoe/logo.png"/>
<variable name="odoo_company_footer" description="Pied de page des documents" mandatory="True"/> <variable name="odoo_company_footer" description="Pied de page des documents" mandatory="True" test="foot"/>
<variable name="odoo_company_layout" description="Agencement des documents" mandatory="True" type="choice"> <variable name="odoo_company_layout" description="Agencement des documents" mandatory="True" type="choice" mode="basic">
<value>standard</value> <value>standard</value>
<choice>standard</choice> <choice>standard</choice>
<choice>bold</choice> <choice>bold</choice>
<choice>boxed</choice> <choice>boxed</choice>
<choice>striped</choice> <choice>striped</choice>
</variable> </variable>
<variable name="odoo_addons" description="Liste des applications à activer" multi="True"> <variable name="odoo_addons" description="Liste des applications à activer" multi="True" mode="expert">
<value>base</value> <value>base</value>
<value>l10n_fr</value> <value>l10n_fr</value>
<value>l10n_fr_fec</value> <value>l10n_fr_fec</value>

191
seed/openldap/README.md
View file

@ -5,18 +5,106 @@ include_toc: true
# openldap # openldap
## Description ## Synopsis
OpenLDAP, a LDAP server. OpenLDAP, the LDAP server.
[For more informations](https://www.openldap.org/) [More informations about this software.](https://www.openldap.org/)
## Examples This service provides a LDAP server.
It is possible to request the creation of users. Those users can be mixed or
classified into families.
Those users will be created and updated. They will never be deleted. The
initial password will be generated but never updated. You can modify them.
Other services may also require automatic user creation.
## Variables
### Accounts
#### Gestion des utilisateurs
This a family is a leadership.
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------|
| **[accounts.users.ldap_user_mail](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) | Adresse courriel du compte.<br/>**Example:** johndoe@example.net |
| **[accounts.users.ldap_user_aliases](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) | Aliases du mail. |
| **[accounts.users.ldap_user_uid](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) | Nom de compte.<br/>**Example:** jdoe |
| **[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) | Prénom.<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) | Nom de famille.<br/>**Example:** Doe |
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|
| **[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) | Familles. |
#### Gestion de la famille
This a dynamic family generated from the variable "accounts.families".
##### Gestion des utilisateurs de la famille
This a family is a leadership.
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|
| **[accounts.family_.users_.ldap_user_mail_](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) | Adresse courriel du compte de la famille . |
| **[accounts.family_.users_.ldap_user_aliases_](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) | Aliases du mail de la famille . |
| **[accounts.family_.users_.ldap_user_uid_](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) | Nom de compte de la famille . |
| **[accounts.family_.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) | Prénom de la famille . |
| **[accounts.family_.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) | Nom de famille de la famille . |
## Variables for expert
### Général
#### ldap
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[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) | Schémas LDAP additionnel.<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> |
##### Limites
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|
| **[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) | Niveau de log.<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_timelimit](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) | Temps de réponse maximum à une requête (en secondes).<br/>**Default:** 3600 |
##### DB environment
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
| **[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_chunks](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 de fichiers ou écrire le cache HDB.<br/>**Default:** 1 |
| **[general.ldap.db_environment.db_log_region_max](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 fichier de cache mis en cache mémoire.<br/>**Default:** 262144 |
| **[general.ldap.db_environment.db_log_max](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'informations de journalisation conservé jusqu'à rotation.<br/>**Default:** 10485760 |
| **[general.ldap.db_environment.db_log_bsize](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'informations de journalisation du cache reporté sur le disque.<br/>**Default:** 2097152 |
| **[general.ldap.db_environment.db_log_directory](dictionaries/21_openldap-server.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) | Répertoire de conservation des informations de journalisation.<br/>**Default:** /srv/openldap/log |
| **[general.ldap.db_environment.db_lk_max_objects](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 d'objet qui peuvent être verrouillés simultanément .<br/>**Default:** 5000 |
| **[general.ldap.db_environment.db_lk_max](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 de verrous maximal.<br/>**Default:** 5000 |
| **[general.ldap.db_environment.db_lk_max_lockers](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 de verroulleur maximal.<br/>**Default:** 5000 |
## Requirements services
- **LocalDNS**
- Journald
**bold**: provider is mandatory
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
openldap: openldap:
applicationservice: openldap applicationservice: openldap
@ -25,17 +113,6 @@ openldap:
- localdns - localdns
``` ```
With all providers:
```
openldap:
applicationservice: openldap
provider_zone: ldap
zones_name:
- journald
- localdns
```
## Dependances ## Dependances
- [base-fedora-37](../base-fedora-37/README.md) - [base-fedora-37](../base-fedora-37/README.md)
@ -48,86 +125,6 @@ openldap:
- [journald](../journald/README.md) - [journald](../journald/README.md)
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md)
## Variables
### Général (*general*)
#### ldap (*general.ldap*)
| Description | Type | Values |
|------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Schémas LDAP additionnel** (*[ldap_schemas](dictionaries/21_openldap-server.xml)*) [+] | [filename](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | /etc/openldap/schema/cosine.ldif<br />/etc/openldap/schema/inetorgperson.ldif<br />/etc/openldap/schema/nis.ldif<br />/etc/openldap/schema/misc.ldif |
##### Limites (*general.ldap.limits*)
| Description | Type | Values |
|-----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|----------|
| **Niveau de log** (*[ldap_loglevel](dictionaries/21_openldap-server.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 0 |
| **Nombre maximum d'entrées à retourner lors d'une requête** (*[ldap_sizelimit](dictionaries/21_openldap-server.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 5000 |
| **Temps de réponse maximum à une requête (en secondes)** (*[ldap_timelimit](dictionaries/21_openldap-server.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 3600 |
##### DB environment (*general.ldap.db_environment*)
| Description | Type | Values |
|--------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|-------------------|
| **Quantité de Giga-octets à utiliser pour le cache HDB** (*[db_cache_size_g](dictionaries/21_openldap-server.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 0 |
| **Quantité d'octets à utiliser pour le cache HDB** (*[db_cache_size_o](dictionaries/21_openldap-server.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 268435456 |
| **Nombre de fichiers ou écrire le cache HDB** (*[db_cache_chunks](dictionaries/21_openldap-server.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 1 |
| **Quantité de fichier de cache mis en cache mémoire** (*[db_log_region_max](dictionaries/21_openldap-server.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 262144 |
| **Quantité d'informations de journalisation conservé jusqu'à rotation** (*[db_log_max](dictionaries/21_openldap-server.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 10485760 |
| **Quantité d'informations de journalisation du cache reporté sur le disque** (*[db_log_bsize](dictionaries/21_openldap-server.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 2097152 |
| **Répertoire de conservation des informations de journalisation** (*[db_log_directory](dictionaries/21_openldap-server.xml)*) | [filename](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | /srv/openldap/log |
| **Nombre d'objet qui peuvent être verrouillés simultanément ** (*[db_lk_max_objects](dictionaries/21_openldap-server.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 5000 |
| **Nombre de verrous maximal** (*[db_lk_max](dictionaries/21_openldap-server.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 5000 |
| **Nombre de verroulleur maximal** (*[db_lk_max_lockers](dictionaries/21_openldap-server.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 5000 |
### Machine (*machine*)
| Description | Values |
|--------------------------------------------------|----------|
| *[**var_size**](extras/machine/20_openldap.xml)* | 256 |
| *[**add_tmp**](extras/machine/20_openldap.xml)* | False |
| *[**add_swap**](extras/machine/20_openldap.xml)* | False |
### Accounts (*accounts*)
| Description | Type | Provider |
|------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------|
| Serveurs distant ayant un compte (*[remotes](extras/accounts/00_account.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | LDAP |
| Familles (*[families](extras/accounts/00_account.xml)*) [+] | [unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | |
#### Gestion des utilisateurs (*accounts.users*)
This a family is a leadership.
| Description | Type |
|-------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
| Adresse courriel du compte (*[ldap_user_mail](extras/accounts/00_account.xml)*) [+] | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| Aliases du mail (*[ldap_user_aliases](extras/accounts/00_account.xml)*) [+] | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **Nom de compte** (*[ldap_user_uid](extras/accounts/00_account.xml)*) | [unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **Prénom** (*[ldap_user_sn](extras/accounts/00_account.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **Nom de famille** (*[ldap_user_gn](extras/accounts/00_account.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
#### Gestion de la famille (*accounts.family_*)
This a dynamic family generated from the variable "accounts.families".
##### Gestion des utilisateurs de la famille (*accounts.family_.users_*)
This a family is a leadership.
| Description | Type |
|-----------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
| Adresse courriel du compte de la famille (*[ldap_user_mail_](extras/accounts/00_account.xml)*) [+] | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| Aliases du mail de la famille (*[ldap_user_aliases_](extras/accounts/00_account.xml)*) [+] | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **Nom de compte de la famille ** (*[ldap_user_uid_](extras/accounts/00_account.xml)*) | [unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **Prénom de la famille ** (*[ldap_user_sn_](extras/accounts/00_account.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **Nom de famille de la famille ** (*[ldap_user_gn_](extras/accounts/00_account.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Supplier ## Supplier
[ldap-client](../ldap-client/README.md) [ldap-client](../ldap-client/README.md)

12
seed/openldap/applicationservice.yml
View file

@ -1,5 +1,15 @@
format: '0.1' format: '0.1'
description: OpenLDAP, a LDAP server description: OpenLDAP, the LDAP server
help: |
This service provides a LDAP server.
It is possible to request the creation of users. Those users can be mixed or
classified into families.
Those users will be created and updated. They will never be deleted. The
initial password will be generated but never updated. You can modify them.
Other services may also require automatic user creation.
website: https://www.openldap.org/ website: https://www.openldap.org/
depends: depends:
# - ldap-client # - ldap-client

2
seed/openldap/dictionaries/21_openldap-server.xml
View file

@ -21,7 +21,7 @@
<family name="ldap"> <family name="ldap">
<!--variable name='ldap_server_address' redefine="True" hidden="True"/--> <!--variable name='ldap_server_address' redefine="True" hidden="True"/-->
<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"/>
<variable name='ldap_schemas' type='filename' description='Schémas LDAP additionnel' multi='True'> <variable name='ldap_schemas' type='filename' description='Schémas LDAP additionnel' multi='True' mode="expert">
<value>/etc/openldap/schema/cosine.ldif</value> <value>/etc/openldap/schema/cosine.ldif</value>
<value>/etc/openldap/schema/inetorgperson.ldif</value> <value>/etc/openldap/schema/inetorgperson.ldif</value>
<value>/etc/openldap/schema/nis.ldif</value> <value>/etc/openldap/schema/nis.ldif</value>

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

@ -9,11 +9,11 @@
<variable name="base_dn_" description="LDAP base DN de " hidden="True" provider="LDAP:base_dn"/> <variable name="base_dn_" description="LDAP base DN de " hidden="True" provider="LDAP:base_dn"/>
</family> </family>
<family name="users" description="Gestion des utilisateurs" leadership="True"> <family name="users" description="Gestion des utilisateurs" leadership="True">
<variable name='ldap_user_mail' type="mail" description="Adresse courriel du compte" multi="True"/> <variable name='ldap_user_mail' type="mail" description="Adresse courriel du compte" multi="True" test="johndoe@example.net"/>
<variable name='ldap_user_aliases' type="mail" description="Aliases du mail" multi="True"/> <variable name='ldap_user_aliases' type="mail" description="Aliases du mail" multi="True"/>
<variable name='ldap_user_uid' type="unix_user" description="Nom de compte" mandatory="True"/> <variable name='ldap_user_uid' type="unix_user" description="Nom de compte" mandatory="True" test="jdoe"/>
<variable name='ldap_user_sn' type="string" description="Prénom" mandatory="True"/> <variable name='ldap_user_sn' type="string" description="Prénom" mandatory="True" test="John"/>
<variable name='ldap_user_gn' type="string" description="Nom de famille" mandatory="True"/> <variable name='ldap_user_gn' type="string" description="Nom de famille" mandatory="True" test="Doe"/>
<variable name='ldap_user_password' type="password" description="Mot de passe" mandatory="True" hidden="True"/> <variable name='ldap_user_password' type="password" description="Mot de passe" mandatory="True" hidden="True"/>
</family> </family>
<variable name="families" description="Familles" type="unix_user" multi="True"/> <variable name="families" description="Familles" type="unix_user" multi="True"/>

185
seed/peertube/README.md
View file

@ -5,18 +5,120 @@ include_toc: true
# peertube # peertube
## Description ## Synopsis
Peertube, a federated (ActivityPub) video streaming platform. Peertube, a federated (ActivityPub) video streaming platform.
[For more informations](https://www.openldap.org/) [More informations about this software.](https://www.openldap.org/)
## Examples ## Basic variables
### Général
#### Reverse proxy
##### Point d'entrée des clients
This a 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/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. |
#### peertube
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|
| **[general.peertube.peertube_admin_email](dictionaries/30_peertube.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 Peertube.<br/>**Example:** john.doe@example.net |
## Variables
### Général
#### 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
##### Point d'entrée des clients
This a family is a leadership.
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|
| **[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. |
#### 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
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|
| **[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_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
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|
| **[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 |
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|
| **[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 |
## Requirements services
- **ExternalDNS**
- Journald
- **SMTP**
- **ReverseProxy**
- **Postgresql**
- **Redis**
- **OAuth2**
**bold**: provider is mandatory
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
peertube: peertube:
applicationservice: peertube applicationservice: peertube
@ -27,22 +129,10 @@ peertube:
- redis - redis
- oauth2 - oauth2
- postgresql - postgresql
``` values:
general.revprox.revprox_client.revprox_client_external_domainnames:
With all providers: - service.example.net
general.peertube.peertube_admin_email: john.doe@example.net
```
peertube:
applicationservice: peertube
zones_name:
- journald
- externaldns
- localdns
- reverseproxy
- smtp
- redis
- oauth2
- postgresql
``` ```
## Dependances ## Dependances
@ -67,57 +157,4 @@ peertube:
- [reverse-proxy-client](../reverse-proxy-client/README.md) - [reverse-proxy-client](../reverse-proxy-client/README.md)
- [oauth2-client](../oauth2-client/README.md) - [oauth2-client](../oauth2-client/README.md)
## Variables
### Général (*general*)
#### network (*general.network*)
| Description | Values |
|------------------------------------------------------|----------|
| *[**outgoing_ports**](dictionaries/30_peertube.xml)* | 443 |
#### peertube (*general.peertube*)
| Description | Type | Values |
|------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------|
| **Adresse courriel de l'administrateur Peertube** (*[peertube_admin_email](dictionaries/30_peertube.xml)*) | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | |
| **Description courte de l'instance** (*[peertube_short_description](dictionaries/30_peertube.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser. |
| **Description de l'instance** (*[peertube_description](dictionaries/30_peertube.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Welcome to this PeerTube instance! |
#### oauth2_client (*general.oauth2_client*)
| Description | Values |
|--------------------------------------------------------------------|-----------------------------------------|
| *[**oauth2_is_client_application**](dictionaries/30_peertube.xml)* | True |
| *[**oauth2_client_name**](dictionaries/30_peertube.xml)* | Vidéo |
| *[**oauth2_client_description**](dictionaries/30_peertube.xml)* | Plateforme de partage de vidéo Peertube |
| *[**oauth2_client_category**](dictionaries/30_peertube.xml)* | Réseaux sociaux |
| *[**oauth2_client_logo**](dictionaries/30_peertube.xml)* | silique_video.png |
##### external (*general.oauth2_client.external*)
| Description | Values |
|----------------------------------------------------------|--------------|
| *[oauth2_client_external](dictionaries/30_peertube.xml)* | <calculated> |
#### nginx (*general.nginx*)
| Description | Values |
|--------------------------------------------------|---------------------|
| *[**nginx_root**](dictionaries/30_peertube.xml)* | /usr/share/peertube |
#### revprox (*general.revprox*)
##### revprox_client (*general.revprox.revprox_client*)
| Description | Values |
|--------------------------------------------------------------------|----------|
| *[**revprox_client_location**](dictionaries/30_peertube.xml)* | / |
| *[**revprox_client_max_body_size**](dictionaries/30_peertube.xml)* | 12G |
- [+]: variable is multiple
- **bold**: variable is mandatory
[All applications services for this dataset.](../README.md) [All applications services for this dataset.](../README.md)

2
seed/peertube/dictionaries/30_peertube.xml
View file

@ -17,7 +17,7 @@
</variable> </variable>
</family> </family>
<family name="peertube"> <family name="peertube">
<variable name="peertube_admin_email" type="mail" description="Adresse courriel de l'administrateur Peertube" mandatory="True"/> <variable name="peertube_admin_email" type="mail" description="Adresse courriel de l'administrateur Peertube" mandatory="True" test="john.doe@example.net"/>
<variable name="peertube_short_description" type="string" description="Description courte de l'instance"> <variable name="peertube_short_description" type="string" description="Description courte de l'instance">
<value>PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.</value> <value>PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.</value>
</variable> </variable>

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

@ -5,7 +5,7 @@ include_toc: true
# php-fpm # php-fpm
## Description ## Synopsis
PHP FPM. PHP FPM.
@ -13,21 +13,6 @@ PHP FPM.
- [php](../php/README.md) - [php](../php/README.md)
## Variables
### Général (*general*)
#### nginx (*general.nginx*)
| Description | Type | Values |
|-------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|----------|
| *[**php_fpm_user**](dictionaries/20_phpfpm.xml)* | [unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | root |
| *[**php_fpm_installed**](dictionaries/20_phpfpm.xml)* | [boolean](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | True |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Used by ## Used by
- [piwigo](../piwigo/README.md) - [piwigo](../piwigo/README.md)

5
seed/php-fpm/dictionaries/20_phpfpm.xml
View file

@ -10,12 +10,9 @@
</services> </services>
<variables> <variables>
<family name="nginx"> <family name="nginx">
<variable name="php_fpm_user" type="unix_user"> <variable name="php_fpm_user" type="unix_user" hidden="True">
<value>root</value> <value>root</value>
</variable> </variable>
<variable name="php_fpm_installed" type="boolean">
<value>True</value>
</variable>
</family> </family>
</variables> </variables>
</rougail> </rougail>

50
seed/php/README.md
View file

@ -5,37 +5,35 @@ include_toc: true
# php # php
## Description ## Synopsis
PHP, a popular general-purpose scripting language. PHP, a popular general-purpose scripting language.
[For more informations](https://secure.php.net/) [More informations about this software.](https://secure.php.net/)
## Variables
### Général (*general*)
#### PHP (*general.php*)
Paramètrage avancé de PHP
| Description | Help | Type | Values |
|-----------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|--------------|
| **Taille maximale des données reçues par la méthode POST** (*[php_post_max_size](dictionaries/20_php.xml)*) | Valeur en Mo | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 32 |
| **Taille maximale d'un fichier à charger** (*[php_upload_max_filesize](dictionaries/20_php.xml)*) | Valeur en Mo | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 16 |
| **Temps maximal d'exécution d'un script** (*[php_max_execution_time](dictionaries/20_php.xml)*) | Valeur en secondes | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 30 |
| **Durée maximale pour analyser les données d'entrée** (*[php_max_input_time](dictionaries/20_php.xml)*) | Valeur en secondes | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 60 |
| **Taille mémoire maximale qu'un script est autorisé à allouer** (*[php_memory_limit](dictionaries/20_php.xml)*) | Valeur en Mo | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 512 |
| **Affichage des erreurs à l'écran** (*[php_display_errors](dictionaries/20_php.xml)*) | | [boolean](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | False |
| **Durée de vie des données sur le serveur** (*[php_session_gc_maxlifetime](dictionaries/20_php.xml)*) | Valeur en secondes | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 3600 |
| **Activer la directive de configuration browscap** (*[php_browscap](dictionaries/20_php.xml)*) | La directive de configuration browscap permet d'obtenir plus d'information sur les capacités du navigateur client grâce à la fonction get_browser() | [boolean](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | False |
| **Fuseau horaire** (*[time_zone](dictionaries/20_php.xml)*) | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Europe/Paris |
| **Activer les tampons de sortie** (*[php_enable_output_buffering](dictionaries/20_php.xml)*) | | [boolean](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | True |
| **Désactiver PCNTL** (*[php_disable_pcntl](dictionaries/20_php.xml)*) | | [boolean](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | True |
- [+]: variable is multiple
- **bold**: variable is mandatory ## 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 |
## Used by ## Used by

203
seed/piwigo/README.md
View file

@ -5,18 +5,153 @@ include_toc: true
# piwigo # piwigo
## Description ## Synopsis
Piwigo, a photo management software. Piwigo, a photo management software.
[For more informations](http://piwigo.org/) [More informations about this software.](http://piwigo.org/)
## Examples ## Basic variables
### Général
#### Reverse proxy
##### Point d'entrée des clients
This a 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. |
#### Piwigo
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|
| **[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 |
##### Piwigo users
This a family is a leadership.
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------|
| **[general.piwigo.users.piwigo_users](dictionaries/31_piwigo.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) | Utilisateur ayant un album.<br/>**Example:** jdoe |
| **[general.piwigo.users.piwigo_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.<br/>**Example:** johndoe@example.net |
## Variables
### Général
#### Piwigo
| 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
| 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_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
##### Point d'entrée des clients
This a 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. |
#### 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
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
| **[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_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
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|
| **[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 |
| Parameter | Comments |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|
| **[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 |
## Requirements services
- **LocalDNS**
- Journald
- **MariaDB**
- **SMTP**
- **LDAP**
- **ReverseProxy**
- **Redis**
- **OAuth2**
**bold**: provider is mandatory
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
piwigo: piwigo:
applicationservice: piwigo applicationservice: piwigo
@ -28,22 +163,14 @@ piwigo:
- smtp - smtp
- redis - redis
- oauth2 - oauth2
``` values:
general.revprox.revprox_client.revprox_client_external_domainnames:
With all providers: - service.example.net
general.piwigo.piwigo_admin_email: admin@example.net
``` general.piwigo.users.piwigo_users:
piwigo: - jdoe
applicationservice: piwigo general.piwigo.users.piwigo_email:
zones_name: '0': johndoe@example.net
- journald
- ldap
- localdns
- mariadb
- reverseproxy
- smtp
- redis
- oauth2
``` ```
## Dependances ## Dependances
@ -69,38 +196,4 @@ piwigo:
- [php-fpm](../php-fpm/README.md) - [php-fpm](../php-fpm/README.md)
- [php](../php/README.md) - [php](../php/README.md)
## Variables
### Général (*general*)
#### Piwigo (*general.piwigo*)
| Description | Type | Values |
|------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|----------------------|
| **Adresse courriel de l'administrateur Piwigo** (*[piwigo_admin_email](dictionaries/31_piwigo.xml)*) | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | |
| **Titre de l'album** (*[piwigo_title](dictionaries/31_piwigo.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Album photographique |
##### Piwigo users (*general.piwigo.users*)
This a family is a leadership.
| Description | Type |
|-----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
| **Utilisateur ayant un album** (*[piwigo_users](dictionaries/31_piwigo.xml)*) [+] | [unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **Adresse courriel** (*[piwigo_email](dictionaries/31_piwigo.xml)*) | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
#### oauth2_client (*general.oauth2_client*)
| Description | Values |
|------------------------------------------------------------------|-----------------------------|
| *[**oauth2_is_client_application**](dictionaries/31_piwigo.xml)* | True |
| *[**oauth2_client_name**](dictionaries/31_piwigo.xml)* | Album |
| *[**oauth2_client_description**](dictionaries/31_piwigo.xml)* | Album photographique Piwigo |
| *[**oauth2_client_category**](dictionaries/31_piwigo.xml)* | Diffusion |
| *[**oauth2_client_logo**](dictionaries/31_piwigo.xml)* | silique_image.png |
- [+]: variable is multiple
- **bold**: variable is mandatory
[All applications services for this dataset.](../README.md) [All applications services for this dataset.](../README.md)

6
seed/piwigo/dictionaries/31_piwigo.xml
View file

@ -12,15 +12,15 @@
</services> </services>
<variables> <variables>
<family name="piwigo" description="Piwigo"> <family name="piwigo" description="Piwigo">
<variable name="piwigo_admin_email" type="mail" description="Adresse courriel de l'administrateur Piwigo" mandatory="True"/> <variable name="piwigo_admin_email" type="mail" description="Adresse courriel de l'administrateur Piwigo" mandatory="True" test="admin@example.net"/>
<variable name="piwigo_admin_password" type="password" auto_save="False" hidden="True"/> <variable name="piwigo_admin_password" type="password" auto_save="False" hidden="True"/>
<variable name="piwigo_locations" type="filename" multi="True" mandatory="True" hidden="True"/> <variable name="piwigo_locations" type="filename" multi="True" mandatory="True" hidden="True"/>
<variable name="piwigo_title" type="string" description="Titre de l'album" mandatory="True"> <variable name="piwigo_title" type="string" description="Titre de l'album" mandatory="True">
<value>Album photographique</value> <value>Album photographique</value>
</variable> </variable>
<family name="users" description="Piwigo users" leadership="True"> <family name="users" description="Piwigo users" leadership="True">
<variable name="piwigo_users" type="unix_user" description="Utilisateur ayant un album" multi="True" mandatory="True"/> <variable name="piwigo_users" type="unix_user" description="Utilisateur ayant un album" multi="True" mandatory="True" test="jdoe"/>
<variable name="piwigo_email" type="mail" description="Adresse courriel" mandatory="True"/> <variable name="piwigo_email" type="mail" description="Adresse courriel" mandatory="True" test="johndoe@example.net"/>
</family> </family>
</family> </family>
<family name="oauth2_client"> <family name="oauth2_client">

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

@ -5,7 +5,7 @@ include_toc: true
# pki-tls # pki-tls
## Description ## Synopsis
Autosign PKI or Let's encrypt support for TLS certificates. Autosign PKI or Let's encrypt support for TLS certificates.

2
seed/pki-tls/templates/0certificate.conf
View file

@ -33,7 +33,7 @@ C {{ tls_key_directory }}/{{ cert }}.pem {{ mode }} {{ owner }} {{ group }} - /u
{% endfor %} {% endfor %}
{% endif %} {% endif %}
{% endif %} {% endif %}
{% if certificate['authority'] not in cas and ('provider' not in certificate or certificate['provider'] == 'autosigne') %} {% if certificate['authority'] not in cas and ('provider' not in certificate or certificate['provider'] == 'self-signed') %}
{{ cas.append(certificate['authority']) }} {{ cas.append(certificate['authority']) }}
C {{ tls_ca_directory }}/{{ certificate['authority'] }}.crt 444 root root - /usr/local/lib{{ tls_ca_directory }}/{{ certificate['authority'] }}.crt C {{ tls_ca_directory }}/{{ certificate['authority'] }}.crt 444 root root - /usr/local/lib{{ tls_ca_directory }}/{{ certificate['authority'] }}.crt
{% endif %} {% endif %}

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

@ -5,23 +5,11 @@ include_toc: true
# postfix-lmtp-relay # postfix-lmtp-relay
## Description ## Synopsis
Postfix, the mail server, as LMTP relay. Postfix, the mail server, as LMTP relay.
[For more informations](http://www.postfix.org/) [More informations about this software.](http://www.postfix.org/)
## Variables
### Lmtp (*lmtp*)
| Description | Type | Provider |
|-------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------|
| LMTP remote server (*[server_lmtp](extras/lmtp/00_lmtp.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | LMTP |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Used by ## Used by

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

@ -5,18 +5,36 @@ include_toc: true
# postfix-relay # postfix-relay
## Description ## Synopsis
Postfix, the mail server, as relay. Postfix, the mail server, as relay.
[For more informations](http://www.postfix.org/) [More informations about this software.](http://www.postfix.org/)
## Examples
## Variables
### 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
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
postfix-relay: postfix-relay:
applicationservice: postfix-relay applicationservice: postfix-relay
@ -25,18 +43,6 @@ postfix-relay:
- localdns - localdns
``` ```
With all providers:
```
postfix-relay:
applicationservice: postfix-relay
provider_zone: smtp
zones_name:
- journald
- externaldns
- localdns
```
## Dependances ## Dependances
- [base-fedora-35](../base-fedora-35/README.md) - [base-fedora-35](../base-fedora-35/README.md)
@ -51,37 +57,6 @@ postfix-relay:
- [dns-external](../dns-external/README.md) - [dns-external](../dns-external/README.md)
- [postfix-lmtp-relay](../postfix-lmtp-relay/README.md) - [postfix-lmtp-relay](../postfix-lmtp-relay/README.md)
## Variables
### Général (*general*)
#### network (*general.network*)
| Description | Values |
|-----------------------------------------------------|--------------|
| *[**outgoing_ports**](dictionaries/30_postfix.xml)* | 25 |
| *[incoming_ports](dictionaries/30_postfix.xml)* | <calculated> |
#### Postfix mail server (*general.postfix*)
| Description | Help | Type | Values | Choices | Provider |
|----------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|-----------|----------------------------|------------|
| Nom de domaine extérieur du serveur de courriel (*[postfix_mail_hostname](dictionaries/30_postfix.xml)*) | Cette variable est obligatoire pour recevoir des courriels depuis l'extérieur | [domainname](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** (*[postfix_crt_provider](dictionaries/30_postfix.xml)*) | | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | autosigne | autosigne<br />letsencrypt | |
| Authentification sur le relai SMTP (*[postfix_relay_authentifications](dictionaries/30_postfix.xml)*) [+] | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | SMTP |
##### Local server authentification (*general.postfix.local_authentification_*)
This a dynamic family generated from the variable "general.postfix.postfix_relay_authentifications".
| Description | Type | Provider |
|-------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|---------------|
| *[local_authentification_password_](dictionaries/30_postfix.xml)* | [secret](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | SMTP:password |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Supplier ## Supplier
[relay-mail-client](../relay-mail-client/README.md) [relay-mail-client](../relay-mail-client/README.md)

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

@ -39,8 +39,8 @@
<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="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_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="Autorité de certification signant le certificat du domaine extérieur" mandatory="True">
<value>autosigne</value> <value>self-signed</value>
<choice>autosigne</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" description="Local LTMP domain" multi="True" hidden="True"/>

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

@ -5,28 +5,25 @@ include_toc: true
# postgresql-client # postgresql-client
## Description ## Synopsis
Application service needs interact with a Postgresql server. Application service needs interact with a Postgresql server.
[For more informations](https://www.postgresql.org) [More informations about this software.](https://www.postgresql.org)
## Variables
### Général (*general*)
#### PostgreSQL (*general.postgresql*)
| Description | Type | Supplier | Values |
|------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|---------------------|--------------|
| **Nom de domaine du serveur PostgreSQL** (*[pg_client_server_domainname](dictionaries/23_postgresql.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Postgresql | |
| **Client username** (*[pg_client_username](dictionaries/23_postgresql.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Postgresql:username | <calculated> |
| **Client password** (*[pg_client_password](dictionaries/23_postgresql.xml)*) | [password](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Postgresql:password | <calculated> |
| **Client database** (*[pg_client_database](dictionaries/23_postgresql.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Postgresql:database | <calculated> |
- [+]: variable is multiple
- **bold**: variable is mandatory ## 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

110
seed/postgresql/README.md
View file

@ -5,18 +5,62 @@ include_toc: true
# postgresql # postgresql
## Description ## Synopsis
Postgresql, a database. Postgresql, a database.
[For more informations](https://www.postgresql.org) [More informations about this software.](https://www.postgresql.org)
## Examples
## Variables
### Général
#### PostgreSQL
Paramétrage du serveur de gestion de bases de données PostgreSQL.
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.postgresql.pg_max_connections](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) | Nombre maximum de connexions.<br/>Nombre maximum de connexions concurrentes au serveur de base de données.<br/>**Default:** 100 |
| **[general.postgresql.pg_authentication_timeout](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) | Délai de connexion maximum (en secondes).<br/>Temps maximum pour terminer l'authentification du client.<br/>**Default:** 60 |
| **[general.postgresql.pg_server_key](dictionaries/22_postgresql.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) | Emplacement de la clé SSL du serveur PostgreSQL.<br/>**Default:** /etc/postgresql/12/main/server.key |
| **[general.postgresql.pg_server_cert](dictionaries/22_postgresql.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) | Emplacement du certificat du serveur PostgreSQL.<br/>**Default:** /etc/postgresql/12/main/server.crt |
| **[general.postgresql.pg_autovacuum](dictionaries/22_postgresql.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 le VACUUM automatique.<br/>**Default:** True |
| **[general.postgresql.pg_work_mem](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) | Mémoire tampon allouée aux opérations de tri et tables de hash.<br/>Quantité de mémoire allouée à chaque opération avant écriture sur le disque (par défaut : 4MB).<br/>**Default:** 4 |
| **[general.postgresql.pg_work_mem_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 mémoire tampon.<br/>**Choices:**<br/>- `MB` ← (default)<br/>- `kB` |
| **[general.postgresql.pg_maintenance_work_mem](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) | Mémoire tampon allouée pour les opérations de maintenance.<br/>Quantité de mémoire allouée à chaque opération avant écriture sur le disque (par défaut : 64MB, minimum: 1024kB).<br/>**Default:** 64 |
| **[general.postgresql.pg_maintenance_work_mem_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 mémoire tampon.<br/>**Choices:**<br/>- `MB` ← (default)<br/>- `kB` |
| **[general.postgresql.pg_wal_buffers](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) | Mémoire tampon allouée pour les journaux.<br/>Quantité de mémoire allouée avant écriture sur le disque (par défaut : -1, soit 1/32ème de la valeur de shared_buffers).<br/>**Default:** -1 |
| **[general.postgresql.pg_max_wal_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) | Limite douce du Write Ahead Log.<br/>Limite douce pour le Write Ahead Log.<br/>**Default:** 1 |
| **[general.postgresql.pg_max_wal_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 limite douce du Write Ahead Log.<br/>**Choices:**<br/>- `GB` ← (default)<br/>- `MB`<br/>- `kB` |
| **[general.postgresql.pg_shared_buffers](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) | Quantité de mémoire pour les buffers partagés.<br/>Quantité de mémoire que le serveur de bases de données utilise comme mémoire partagée.<br/>**Default:** 128 |
| **[general.postgresql.pg_shared_buffers_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 quantité de mémoire pour les buffers partagés.<br/>**Choices:**<br/>- `MB` ← (default)<br/>- `kB` |
| **[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) |
### Accounts
#### Account for
This a dynamic family generated from the variable "accounts.remotes".
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------|
| **[accounts.remote_.remote_ip_](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
- **LocalDNS**
- Journald
**bold**: provider is mandatory
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
postgresql: postgresql:
applicationservice: postgresql applicationservice: postgresql
@ -25,17 +69,6 @@ postgresql:
- localdns - localdns
``` ```
With all providers:
```
postgresql:
applicationservice: postgresql
provider_zone: postgresql
zones_name:
- journald
- localdns
```
## Dependances ## Dependances
- [base-fedora-37](../base-fedora-37/README.md) - [base-fedora-37](../base-fedora-37/README.md)
@ -48,51 +81,6 @@ postgresql:
- [journald](../journald/README.md) - [journald](../journald/README.md)
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md)
## Variables
### Général (*general*)
#### PostgreSQL (*general.postgresql*)
Paramétrage du serveur de gestion de bases de données PostgreSQL
| Description | Help | Type | Values | Choices |
|-----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|------------------------------------|--------------------|
| **Nombre maximum de connexions** (*[pg_max_connections](dictionaries/22_postgresql.xml)*) | Nombre maximum de connexions concurrentes au serveur de base de données | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 100 | |
| **Délai de connexion maximum (en secondes)** (*[pg_authentication_timeout](dictionaries/22_postgresql.xml)*) | Temps maximum pour terminer l'authentification du client | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 60 | |
| **Emplacement de la clé SSL du serveur PostgreSQL** (*[pg_server_key](dictionaries/22_postgresql.xml)*) | | [filename](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | /etc/postgresql/12/main/server.key | |
| **Emplacement du certificat du serveur PostgreSQL** (*[pg_server_cert](dictionaries/22_postgresql.xml)*) | | [filename](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | /etc/postgresql/12/main/server.crt | |
| **Activer le VACUUM automatique** (*[pg_autovacuum](dictionaries/22_postgresql.xml)*) | | [boolean](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | True | |
| **Mémoire tampon allouée aux opérations de tri et tables de hash** (*[pg_work_mem](dictionaries/22_postgresql.xml)*) | Quantité de mémoire allouée à chaque opération avant écriture sur le disque (par défaut : 4MB) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 4 | |
| **Unité de la mémoire tampon** (*[pg_work_mem_unit](dictionaries/22_postgresql.xml)*) | | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | MB | MB<br />kB |
| **Mémoire tampon allouée pour les opérations de maintenance** (*[pg_maintenance_work_mem](dictionaries/22_postgresql.xml)*) | Quantité de mémoire allouée à chaque opération avant écriture sur le disque (par défaut : 64MB, minimum: 1024kB) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 64 | |
| **Unité de la mémoire tampon** (*[pg_maintenance_work_mem_unit](dictionaries/22_postgresql.xml)*) | | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | MB | MB<br />kB |
| **Mémoire tampon allouée pour les journaux** (*[pg_wal_buffers](dictionaries/22_postgresql.xml)*) | Quantité de mémoire allouée avant écriture sur le disque (par défaut : -1, soit 1/32ème de la valeur de shared_buffers) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | -1 | |
| **Limite douce du Write Ahead Log** (*[pg_max_wal_size](dictionaries/22_postgresql.xml)*) | Limite douce pour le Write Ahead Log | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 1 | |
| **Unité de la limite douce du Write Ahead Log** (*[pg_max_wal_size_unit](dictionaries/22_postgresql.xml)*) | | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | GB | GB<br />MB<br />kB |
| **Quantité de mémoire pour les buffers partagés** (*[pg_shared_buffers](dictionaries/22_postgresql.xml)*) | Quantité de mémoire que le serveur de bases de données utilise comme mémoire partagée | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 128 | |
| **Unité de la quantité de mémoire pour les buffers partagés** (*[pg_shared_buffers_unit](dictionaries/22_postgresql.xml)*) | | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | MB | MB<br />kB |
| **Taille du cache** (*[pg_effective_cache_size](dictionaries/22_postgresql.xml)*) | Initialise l'estimation faite par le planificateur pour le nombre de bloc de 8ko réelle du cache disque disponible pour une requête | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 4 | |
| **Unité de la taille du cache** (*[pg_effective_cache_size_unit](dictionaries/22_postgresql.xml)*) | | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | GB | MB<br />kB<br />GB |
### Accounts (*accounts*)
| Description | Type | Provider |
|--------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------|
| Remote clients needing an account (*[remotes](extras/accounts/00_accounts.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Postgresql |
#### Account for (*accounts.remote_*)
This a dynamic family generated from the variable "accounts.remotes".
| Description | Type | Values |
|------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|--------------|
| **Remote IP ** (*[remote_ip_](extras/accounts/00_accounts.xml)*) | [ip](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | <calculated> |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Supplier ## Supplier
[postgresql-client](../postgresql-client/README.md) [postgresql-client](../postgresql-client/README.md)

40
seed/prometheus/README.md
View file

@ -5,18 +5,23 @@ include_toc: true
# prometheus # prometheus
## Description ## Synopsis
Prometheus, an event monitoring. Prometheus, an event monitoring.
[For more informations](https://prometheus.io/) [More informations about this software.](https://prometheus.io/)
## Examples ## Requirements services
- **LocalDNS**
- Journald
**bold**: provider is mandatory
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
prometheus: prometheus:
applicationservice: prometheus applicationservice: prometheus
@ -25,17 +30,6 @@ prometheus:
- localdns - localdns
``` ```
With all providers:
```
prometheus:
applicationservice: prometheus
provider_zone: prometheus
zones_name:
- journald
- localdns
```
## Dependances ## Dependances
- [base-fedora-38](../base-fedora-38/README.md) - [base-fedora-38](../base-fedora-38/README.md)
@ -48,20 +42,6 @@ prometheus:
- [journald](../journald/README.md) - [journald](../journald/README.md)
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md)
## Variables
### Général (*general*)
#### prometheus (*general.prometheus*)
| Description | Type | Provider |
|----------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------|
| *[client_addresses](dictionaries/20_prometheus.xml)* [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Prometheus |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Supplier ## Supplier
[host-systemd-machined](../host-systemd-machined/README.md) [host-systemd-machined](../host-systemd-machined/README.md)

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

@ -5,11 +5,36 @@ include_toc: true
# provider-systemd-machined # provider-systemd-machined
## Description ## Synopsis
Machine started in Systemd Machined environment. Machine started in Systemd Machined environment.
[For more informations](https://www.freedesktop.org/wiki/Software/systemd/machined/) [More informations about this software.](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
@ -21,29 +46,6 @@ Machine started in Systemd Machined environment.
- [journald](../journald/README.md) - [journald](../journald/README.md)
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md)
## Variables
### Général (*general*)
| Description | Type | Values |
|-----------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|---------------------------------|
| **Nom du répertoire racine des données** (*[container_srv_path](dictionaries/16_machined.xml)*) | [filename](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | /var/lib/risotto/srv |
| **Nom du répertoire racine des configurations** (*[container_config_path](dictionaries/16_machined.xml)*) | [filename](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | /var/lib/risotto/configurations |
| **Nom du répertoire racine des journaux** (*[container_journal_path](dictionaries/16_machined.xml)*) | [filename](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | /var/lib/risotto/journals |
| *[**use_systemd_repart**](dictionaries/16_machined.xml)* | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | False |
| **Do backup for this machine** (*[do_backup](dictionaries/16_machined.xml)*) | [boolean](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | True |
#### network (*general.network*)
| Description | Values | Supplier |
|-------------------------------------------------------------------|----------|--------------------|
| *[**netwokd_interface_name_type**](dictionaries/16_machined.xml)* | host | |
| *[zones_list](dictionaries/16_machined.xml)* | | Host:machine_zones |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Provider ## Provider
[host-systemd-machined](../host-systemd-machined/README.md) [host-systemd-machined](../host-systemd-machined/README.md)

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

@ -14,15 +14,15 @@
</services> </services>
<variables> <variables>
<variable name="link_configurations" redefine="True" disabled="True"/> <variable name="link_configurations" redefine="True" disabled="True"/>
<variable name="container_srv_path" type="filename" description="Nom du répertoire racine des données"> <variable name="container_srv_path" type="filename" description="Nom du répertoire racine des données" hidden="True">
<value>/var/lib/risotto/srv</value> <value>/var/lib/risotto/srv</value>
</variable> </variable>
<variable name="srv_dir" description='Nom du répertoire des données' type="filename" hidden="True" supplier="Host:machine_srv"/> <variable name="srv_dir" description='Nom du répertoire des données' type="filename" hidden="True" supplier="Host:machine_srv"/>
<variable name="container_config_path" type="filename" description="Nom du répertoire racine des configurations"> <variable name="container_config_path" type="filename" description="Nom du répertoire racine des configurations" hidden="True">
<value>/var/lib/risotto/configurations</value> <value>/var/lib/risotto/configurations</value>
</variable> </variable>
<variable name="config_dir" description='Nom du répertoire des configurations' type="filename" hidden="True" mandatory="True" supplier="Host:config_dir"/> <variable name="config_dir" description='Nom du répertoire des configurations' type="filename" hidden="True" mandatory="True" supplier="Host:config_dir"/>
<variable name="container_journal_path" type="filename" description="Nom du répertoire racine des journaux"> <variable name="container_journal_path" type="filename" description="Nom du répertoire racine des journaux" hidden="True">
<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"/>
@ -37,7 +37,7 @@
</variable> </variable>
<variable name="zones_list" redefine="True" supplier="Host:machine_zones"/> <variable name="zones_list" redefine="True" supplier="Host:machine_zones"/>
</family> </family>
<variable name="do_backup" type="boolean" description="Do backup for this machine"> <variable name="do_backup" type="boolean" description="Do backup for this machine" hidden="True">
<value>True</value> <value>True</value>
</variable> </variable>
<variable name="backup_dir" type="filename" hidden="True"> <variable name="backup_dir" type="filename" hidden="True">

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

@ -5,33 +5,29 @@ include_toc: true
# redis-client # redis-client
## Description ## Synopsis
Application service needs interact with a Redis server. Application service needs interact with a Redis server.
[For more informations](https://redis.io/) [More informations about this software.](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)
## Variables
### Général (*general*)
#### Redis (*general.redis*)
| Description | Type | Supplier | Values | Provider |
|-----------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|----------------|--------------|-------------|
| **Nom de domaine du serveur Redis** (*[redis_client_server_domainname](dictionaries/23_redis.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Redis | | |
| **Nom d'utilisateur** (*[redis_client_username](dictionaries/23_redis.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Redis:username | <calculated> | |
| **Mot de passe de connexion** (*[redis_client_password](dictionaries/23_redis.xml)*) | [password](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Redis:password | <calculated> | |
| **Redis index** (*[redis_client_index](dictionaries/23_redis.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | | Redis:index |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Used by ## Used by
- [peertube](../peertube/README.md) - [peertube](../peertube/README.md)

4
seed/redis-common/README.md
View file

@ -5,11 +5,11 @@ include_toc: true
# redis-common # redis-common
## Description ## Synopsis
Redis, an in-memory data structure store. Redis, an in-memory data structure store.
[For more informations](https://redis.io/) [More informations about this software.](https://redis.io/)
## Used by ## Used by

86
seed/redis/README.md
View file

@ -5,18 +5,52 @@ include_toc: true
# redis # redis
## Description ## Synopsis
Redis, an in-memory data structure store. Redis, an in-memory data structure store.
[For more informations](https://redis.io/) [More informations about this software.](https://redis.io/)
## Examples
## Variables
### Général
#### Redis
Configuration du service de cache Redis.
| Parameter | Comments |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.redis.redis_instance_name](dictionaries/90_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 de l'instance.<br/>**Default:** *calculated* |
| **[general.redis.redis_save](dictionaries/90_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) | Activer la persistence des données.<br/>**Default:** False |
| **[general.redis.redis_max_memory](dictionaries/90_redis.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 mémoire utilisable par Redis.<br/>La valeur est en Mo.<br/>**Default:** 512 |
| **[general.redis.redis_memory_policy](dictionaries/90_redis.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) | Méthode de libération de mémoire lorsque le maximum est atteint.<br/>**Choices:**<br/>- `volatile-lru`<br/>- `allkeys-lru`<br/>- `volatile-lfu`<br/>- `allkeys-lfu`<br/>- `volatile-random`<br/>- `allkeys-random`<br/>- `volatile-ttl`<br/>- `noeviction` ← (default) |
| **[general.redis.redis_tcp_keepalive](dictionaries/90_redis.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) | Intervalle entre le dernier envoi de paquet TCP et la réponse ACK.<br/>La valeur est en seconde.<br/>**Default:** 300 |
| **[general.redis.redis_max_clients](dictionaries/90_redis.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 client maximum autorisé.<br/>**Default:** 10000 |
### Accounts
#### remote_
This a dynamic family generated from the variable "accounts.remotes".
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|
| **[accounts.remote_.ip_](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) | **Default:** *calculated* |
## Requirements services
- **LocalDNS**
- Journald
**bold**: provider is mandatory
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
redis: redis:
applicationservice: redis applicationservice: redis
@ -25,17 +59,6 @@ redis:
- localdns - localdns
``` ```
With all providers:
```
redis:
applicationservice: redis
provider_zone: redis
zones_name:
- journald
- localdns
```
## Dependances ## Dependances
- [base-fedora-38](../base-fedora-38/README.md) - [base-fedora-38](../base-fedora-38/README.md)
@ -49,37 +72,6 @@ redis:
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md)
- [redis-common](../redis-common/README.md) - [redis-common](../redis-common/README.md)
## Variables
### Général (*general*)
#### Redis (*general.redis*)
Configuration du service de cache Redis
| Description | Values | Help | Type | Choices |
|----------------------------------------------------------------------------------------------------------------------------|--------------|--------------------------|------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
| **Nom de l'instance** (*[redis_instance_name](dictionaries/90_redis.xml)*) | <calculated> | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | |
| **Activer la persistence des données** (*[redis_save](dictionaries/90_redis.xml)*) | False | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | |
| **Quantité de mémoire utilisable par Redis** (*[redis_max_memory](dictionaries/90_redis.xml)*) | 512 | La valeur est en Mo | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | |
| **Méthode de libération de mémoire lorsque le maximum est atteint** (*[redis_memory_policy](dictionaries/90_redis.xml)*) | noeviction | | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | volatile-lru<br />allkeys-lru<br />volatile-lfu<br />allkeys-lfu<br />volatile-random<br />allkeys-random<br />volatile-ttl<br />noeviction |
| **Intervalle entre le dernier envoi de paquet TCP et la réponse ACK** (*[redis_tcp_keepalive](dictionaries/90_redis.xml)*) | 300 | La valeur est en seconde | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | |
| **Nombre de client maximum autorisé** (*[redis_max_clients](dictionaries/90_redis.xml)*) | 10000 | | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | |
### Accounts (*accounts*)
#### remote_ (*accounts.remote_*)
This a dynamic family generated from the variable "accounts.remotes".
| Description | Type | Values |
|----------------------------------------------|--------------------------------------------------------------------------------------------------------------------|--------------|
| *[**ip_**](extras/accounts/00_accounts.xml)* | [ip](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | <calculated> |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Supplier ## Supplier
[redis-client](../redis-client/README.md) [redis-client](../redis-client/README.md)

14
seed/relay-lmtp-client/README.md
View file

@ -5,7 +5,7 @@ include_toc: true
# relay-lmtp-client # relay-lmtp-client
## Description ## Synopsis
Application service needs interact with a Postfix server with LMTP protocol. Application service needs interact with a Postfix server with LMTP protocol.
@ -13,18 +13,6 @@ 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)
## Variables
### Général (*general*)
| Description | Type | Values | Supplier |
|---------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|--------------|------------|
| **Nom de domaine du serveur LMTP** (*[lmtp_relay_address](dictionaries/30_lmtp.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | <calculated> | LMTP |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Used by ## Used by
- [mailman](../mailman/README.md) - [mailman](../mailman/README.md)

16
seed/relay-mail-client/README.md
View file

@ -5,24 +5,10 @@ include_toc: true
# relay-mail-client # relay-mail-client
## Description ## Synopsis
Client SMTP. Client SMTP.
## Variables
### Général (*general*)
#### Client SMTP (*general.smtp*)
| Description | Type | Supplier |
|----------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------|
| **Nom de domaine du serveur SMTP** (*[smtp_relay_address](dictionaries/20_smtp_client.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | SMTP |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Used by ## Used by
- [odoo](../odoo/README.md) - [odoo](../odoo/README.md)

4
seed/resolved/README.md
View file

@ -5,11 +5,11 @@ include_toc: true
# resolved # resolved
## Description ## Synopsis
Resolved. Resolved.
[For more informations](https://systemd.io/) [More informations about this software.](https://systemd.io/)
## Used by ## Used by

34
seed/reverse-proxy-client/README.md
View file

@ -5,29 +5,39 @@ include_toc: true
# reverse-proxy-client # reverse-proxy-client
## Description ## Synopsis
Application service needs interact with a a reverse proxy server. Application service needs interact with a a reverse proxy server.
## Variables ## Basic variables
### Général (*general*) ### Général
#### Reverse proxy (*general.revprox*) #### Reverse proxy
##### Point d'entrée des clients (*general.revprox.revprox_client*) ##### Point d'entrée des clients
This a family is a leadership. This a family is a leadership.
| Description | Type | Supplier | | Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|----------------------------| |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------|
| **Nom de domaine exterieur du serveur** (*[revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | ReverseProxy:external | | **[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 |
| **Nom de l'arborescence racine du site** (*[revprox_client_location](dictionaries/21_revprox_client.xml)*) | [filename](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | ReverseProxy:location | | **[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. |
| Taille maximum du corps (*[revprox_client_max_body_size](dictionaries/21_revprox_client.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | ReverseProxy:max_body_size |
- [+]: variable is multiple ## Variables for expert
- **bold**: variable is mandatory
### Général
#### Reverse proxy
##### Point d'entrée des clients
This a 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. |
## Used by ## Used by

4
seed/reverse-proxy-client/dictionaries/21_revprox_client.xml
View file

@ -11,8 +11,8 @@
<variable name="revprox_client_server_domainname" type="domainname" mandatory='True' supplier="ReverseProxy" hidden="True"/> <variable name="revprox_client_server_domainname" type="domainname" mandatory='True' supplier="ReverseProxy" hidden="True"/>
<variable name="revprox_client_server_ip" type="ip" hidden='True'/> <variable name="revprox_client_server_ip" type="ip" hidden='True'/>
<family name="revprox_client" description="Point d'entrée des clients" leadership="True"> <family name="revprox_client" description="Point d'entrée des clients" leadership="True">
<variable name="revprox_client_external_domainnames" type="domainname" description="Nom de domaine exterieur du serveur" mandatory='True' multi="True" unique="False" supplier="ReverseProxy:external"/> <variable name="revprox_client_external_domainnames" type="domainname" description="Nom de domaine exterieur du serveur" mandatory='True' multi="True" unique="False" supplier="ReverseProxy:external" test="service.example.net"/>
<variable name="revprox_client_location" type="filename" description="Nom de l'arborescence racine du site" mandatory="True" supplier="ReverseProxy:location"> <variable name="revprox_client_location" type="filename" description="Nom de l'arborescence racine du site" mandatory="True" supplier="ReverseProxy:location" mode="basic">
<value>/</value> <value>/</value>
</variable> </variable>
<variable name="revprox_client_is_websocket" type="boolean" mandatory="True" supplier="ReverseProxy:websocket" hidden="True"> <variable name="revprox_client_is_websocket" type="boolean" mandatory="True" supplier="ReverseProxy:websocket" hidden="True">

9
seed/reverse-proxy-client/funcs/revprox_client.py
View file

@ -16,12 +16,3 @@ def calc_web_address(domain_name: str=None,
if local_location: if local_location:
web_address += local_location web_address += local_location
return web_address return web_address
def get_first_value(lst: list):
if lst:
if isinstance(lst[0], list):
if lst[0] and lst[0][0]:
return lst[0][0]
else:
return lst[0]

216
seed/roundcube/README.md
View file

@ -5,18 +5,137 @@ include_toc: true
# roundcube # roundcube
## Description ## Synopsis
Roundcube, a webmail. Roundcube, a webmail.
[For more informations](https://roundcube.net/) [More informations about this software.](https://roundcube.net/)
## Examples ## Basic variables
### Général
#### Interface web de consultation des courriels Roundcube
##### roundcube_domain
This a family is a leadership.
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------|
| **[general.roundcube.roundcube_domain.roundcube_domains](dictionaries/31_roundcube.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 domaines d'accès à Roundcube.<br/>**Example:** webmail.example.net |
| **[general.roundcube.roundcube_domain.roundcube_mail_domain](dictionaries/31_roundcube.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 domaines des courriels.<br/>**Example:** mail.example.net |
## Variables
### Général
#### Interface web de consultation des courriels Roundcube
##### roundcube_domain
This a family is a leadership.
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
| **[general.roundcube.roundcube_domain.roundcube_family](dictionaries/31_roundcube.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. |
## 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
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
| **[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* |
#### 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
| Parameter | Comments |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|
| **[general.oauth2_client.oauth2_client_name](dictionaries/31_roundcube.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:** Courriel<br/>**Example:** example |
| **[general.oauth2_client.oauth2_client_description](dictionaries/31_roundcube.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:** Consulter ces courriels avec Roundcube<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. |
##### external
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|
| **[general.oauth2_client.external.oauth2_client_external](dictionaries/31_roundcube.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/31_roundcube.xml)**<br/>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:** *calculated* |
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|
| **[general.oauth2_client.oauth2_client_category](dictionaries/31_roundcube.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_roundcube.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 |
## Requirements services
- **LocalDNS**
- Journald
- **IMAP**
- **LDAP**
- **ReverseProxy**
- **Postgresql**
- **Redis**
- **OAuth2**
**bold**: provider is mandatory
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
roundcube: roundcube:
applicationservice: roundcube applicationservice: roundcube
@ -28,22 +147,11 @@ roundcube:
- redis - redis
- oauth2 - oauth2
- postgresql - postgresql
``` values:
general.roundcube.roundcube_domain.roundcube_domains:
With all providers: - webmail.example.net
general.roundcube.roundcube_domain.roundcube_mail_domain:
``` '0': mail.example.net
roundcube:
applicationservice: roundcube
zones_name:
- journald
- ldap
- localdns
- reverseproxy
- imap
- redis
- oauth2
- postgresql
``` ```
## Dependances ## Dependances
@ -69,70 +177,4 @@ roundcube:
- [php](../php/README.md) - [php](../php/README.md)
- [ldap-client](../ldap-client/README.md) - [ldap-client](../ldap-client/README.md)
## Variables
### Général (*general*)
#### Interface web de consultation des courriels Roundcube (*general.roundcube*)
##### roundcube_domain (*general.roundcube.roundcube_domain*)
This a family is a leadership.
| Description | Type |
|----------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
| **Nom de domaines d'accès à Roundcube** (*[roundcube_domains](dictionaries/31_roundcube.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **Nom de domaines des courriels** (*[roundcube_mail_domain](dictionaries/31_roundcube.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| Nom de la famille (*[roundcube_family](dictionaries/31_roundcube.xml)*) | [unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
#### oauth2_client (*general.oauth2_client*)
| Description | Values |
|---------------------------------------------------------------------|----------------------------------------|
| *[**oauth2_is_client_application**](dictionaries/31_roundcube.xml)* | True |
| *[**oauth2_client_name**](dictionaries/31_roundcube.xml)* | Courriel |
| *[**oauth2_client_description**](dictionaries/31_roundcube.xml)* | Consulter ces courriels avec Roundcube |
| *[**oauth2_client_category**](dictionaries/31_roundcube.xml)* | Diffusion |
| *[**oauth2_client_logo**](dictionaries/31_roundcube.xml)* | silique_email.png |
##### external (*general.oauth2_client.external*)
| Description | Values |
|---------------------------------------------------------------|--------------|
| *[oauth2_client_external](dictionaries/31_roundcube.xml)* [+] | |
| *[oauth2_client_family](dictionaries/31_roundcube.xml)* [+] | <calculated> |
#### nginx (*general.nginx*)
| Description | Values |
|---------------------------------------------------|---------------------------|
| *[**nginx_root**](dictionaries/31_roundcube.xml)* | /usr/share/roundcubemail/ |
#### revprox (*general.revprox*)
##### revprox_client (*general.revprox.revprox_client*)
| Description | Values |
|----------------------------------------------------------------------|----------|
| *[**revprox_client_local_location**](dictionaries/31_roundcube.xml)* | / |
#### imap (*general.imap*)
| Description | Values |
|--------------------------------------------------------|----------|
| *[**imap_cert_owner**](dictionaries/31_roundcube.xml)* | nginx |
### Machine (*machine*)
| Description | Values |
|---------------------------------------------------|----------|
| *[**var_size**](extras/machine/20_roundcube.xml)* | 256 |
| *[**add_tmp**](extras/machine/20_roundcube.xml)* | False |
| *[**add_srv**](extras/machine/20_roundcube.xml)* | False |
| *[**add_swap**](extras/machine/20_roundcube.xml)* | False |
- [+]: variable is multiple
- **bold**: variable is mandatory
[All applications services for this dataset.](../README.md) [All applications services for this dataset.](../README.md)

4
seed/roundcube/dictionaries/31_roundcube.xml
View file

@ -15,8 +15,8 @@
<variable name="roundcube_des_key" type="secret" auto_save="False" hidden="True"/> <variable name="roundcube_des_key" type="secret" auto_save="False" hidden="True"/>
<variable name="roundcube_config" type="filename" hidden="True" multi="True"/> <variable name="roundcube_config" type="filename" hidden="True" multi="True"/>
<family name="roundcube_domain" leadership="True"> <family name="roundcube_domain" leadership="True">
<variable name="roundcube_domains" type="domainname" description="Nom de domaines d'accès à Roundcube" multi="True" mandatory="True"/> <variable name="roundcube_domains" type="domainname" description="Nom de domaines d'accès à Roundcube" multi="True" mandatory="True" test="webmail.example.net"/>
<variable name="roundcube_mail_domain" type="domainname" description="Nom de domaines des courriels" mandatory="True"/> <variable name="roundcube_mail_domain" type="domainname" description="Nom de domaines des courriels" mandatory="True" test="mail.example.net"/>
<variable name="roundcube_family" type="unix_user" description="Nom de la famille"/> <variable name="roundcube_family" type="unix_user" description="Nom de la famille"/>
</family> </family>
</family> </family>

83
seed/speedtest-rs/README.md
View file

@ -5,35 +5,63 @@ include_toc: true
# speedtest-rs # speedtest-rs
## Description ## Synopsis
Speedtest-rs, a very lightweight Speedtest. Speedtest-rs, a very lightweight Speedtest.
[For more informations](https://cloud.silique.fr/gitea/Silique/speedtest-rs) [More informations about this software.](https://cloud.silique.fr/gitea/Silique/speedtest-rs)
## Examples ## Basic variables
### Général
#### Reverse proxy
##### Point d'entrée des clients
This a 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 for expert
### Général
#### Reverse proxy
##### Point d'entrée des clients
This a 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
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
speedtest-rs: speedtest-rs:
applicationservice: speedtest-rs applicationservice: speedtest-rs
zones_name: zones_name:
- localdns - localdns
- reverseproxy - reverseproxy
``` values:
general.revprox.revprox_client.revprox_client_external_domainnames:
With all providers: - service.example.net
```
speedtest-rs:
applicationservice: speedtest-rs
zones_name:
- journald
- localdns
- reverseproxy
``` ```
## Dependances ## Dependances
@ -49,27 +77,4 @@ speedtest-rs:
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md)
- [reverse-proxy-client](../reverse-proxy-client/README.md) - [reverse-proxy-client](../reverse-proxy-client/README.md)
## Variables
### Général (*general*)
#### revprox (*general.revprox*)
| Description | Values |
|---------------------------------------------------------------------|-----------|
| *[**revprox_client_cert_owner**](dictionaries/40_speedtest-rs.xml)* | speedtest |
### Machine (*machine*)
| Description | Values |
|------------------------------------------------------|----------|
| *[**var_size**](extras/machine/20_speedtest-rs.xml)* | 256 |
| *[**add_tmp**](extras/machine/20_speedtest-rs.xml)* | False |
| *[**add_srv**](extras/machine/20_speedtest-rs.xml)* | False |
| *[**add_swap**](extras/machine/20_speedtest-rs.xml)* | False |
- [+]: variable is multiple
- **bold**: variable is mandatory
[All applications services for this dataset.](../README.md) [All applications services for this dataset.](../README.md)

4
seed/systemd/README.md
View file

@ -5,11 +5,11 @@ include_toc: true
# systemd # systemd
## Description ## Synopsis
Systemd, a system and service manager. Systemd, a system and service manager.
[For more informations](https://systemd.io/) [More informations about this software.](https://systemd.io/)
## Dependances ## Dependances

2
seed/tls/manual/image/postinstall/x509.py
View file

@ -30,7 +30,7 @@ def gen_certificates():
authority_cn = authority_name + '+' + authority_server authority_cn = authority_name + '+' + authority_server
if '.' in authority_name: if '.' in authority_name:
raise Exception(f'dot is not allowed in authority_name "{authority_name}"') raise Exception(f'dot is not allowed in authority_name "{authority_name}"')
if certificate['provider'] == 'autosigne': if certificate['provider'] == 'self-signed':
func = autosign_certif func = autosign_certif
elif certificate['provider'] == 'letsencrypt': elif certificate['provider'] == 'letsencrypt':
func = letsencrypt_certif func = letsencrypt_certif

81
seed/unbound/README.md
View file

@ -5,36 +5,44 @@ include_toc: true
# unbound # unbound
## Description ## Synopsis
Unbound, a validating, recursive, caching DNS resolver. Unbound, a validating, recursive, caching DNS resolver.
[For more informations](https://www.nlnetlabs.nl/projects/unbound/about/) [More informations about this software.](https://www.nlnetlabs.nl/projects/unbound/about/)
## Examples ## Basic variables
### Général
#### Résolveur DNS
| Parameter | Comments |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|
| **[general.dns_resolver.unbound_default_forwards](dictionaries/20_unbound.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) | Serveur résolveur DNS par défaut.<br/>**Example:** 9.9.9.9 |
## Requirements services
- **ExternalDNS**
- Journald
**bold**: provider is mandatory
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
unbound: unbound:
applicationservice: unbound applicationservice: unbound
provider_zone: externaldns provider_zone: externaldns
zones_name: zones_name:
- localdns - localdns
``` values:
general.dns_resolver.unbound_default_forwards:
With all providers: - 9.9.9.9
```
unbound:
applicationservice: unbound
provider_zone: externaldns
zones_name:
- journald
- externaldns
- localdns
``` ```
## Dependances ## Dependances
@ -50,45 +58,6 @@ unbound:
- [journald](../journald/README.md) - [journald](../journald/README.md)
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md)
## Variables
### Général (*general*)
#### network (*general.network*)
| Description | Values |
|---------------------------------------------------------|----------------|
| *[ip_dns](dictionaries/20_unbound.xml)* | <calculated> |
| *[**outgoing_ports**](dictionaries/20_unbound.xml)* [+] | udp:53<br />53 |
#### Résolveur DNS (*general.dns_resolver*)
| Description |
|------------------------------------------------------------------------------------------------------|
| **Serveur résolveur DNS par défaut** (*[unbound_default_forwards](dictionaries/20_unbound.xml)*) [+] |
##### Serveur DNS faisant autorité sur une zone particulière (*general.dns_resolver.forward_zones*)
This a family is a leadership.
| Description | Provider | Type |
|----------------------------------------------------------------------------------------------------|-------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
| Adresse du serveur faisant autorité (*[unbound_forward_address](dictionaries/20_unbound.xml)*) [+] | ExternalDNS | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| Nom de domaine de la zone (*[unbound_forward_zones](dictionaries/20_unbound.xml)*) [+] | ExternalDNS:authority_zones | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| Nom de domaine de la zone (*[unbound_forward_reverse_zones](dictionaries/20_unbound.xml)*) [+] | ExternalDNS:reverse_authority_zones | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
### Machine (*machine*)
| Description | Values |
|-------------------------------------------------|----------|
| *[**var_size**](extras/machine/20_unbound.xml)* | 256 |
| *[**add_tmp**](extras/machine/20_unbound.xml)* | False |
| *[**add_swap**](extras/machine/20_unbound.xml)* | False |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Suppliers ## Suppliers
- [dns-external](../dns-external/README.md) - [dns-external](../dns-external/README.md)

2
seed/unbound/dictionaries/20_unbound.xml
View file

@ -31,7 +31,7 @@
<variable name="unbound_forward_reverse_zones" type="domainname" description="Nom de domaine de la zone" multi="True" provider="ExternalDNS:reverse_authority_zones"/> <variable name="unbound_forward_reverse_zones" type="domainname" description="Nom de domaine de la zone" multi="True" provider="ExternalDNS:reverse_authority_zones"/>
<variable name="unbound_allowed_client" type="ip" hidden="True"/> <variable name="unbound_allowed_client" type="ip" hidden="True"/>
</family> </family>
<variable name="unbound_default_forwards" description="Serveur résolveur DNS par défaut" multi="True" mandatory="True"/> <variable name="unbound_default_forwards" description="Serveur résolveur DNS par défaut" multi="True" mandatory="True" test="9.9.9.9"/>
</family> </family>
</variables> </variables>
<constraints> <constraints>

101
seed/vaultwarden/README.md
View file

@ -5,18 +5,63 @@ include_toc: true
# vaultwarden # vaultwarden
## Description ## Synopsis
Vaultwarden, a password manager. Vaultwarden, a password manager.
[For more informations](https://github.com/dani-garcia/vaultwarden) [More informations about this software.](https://github.com/dani-garcia/vaultwarden)
## Examples ## Basic variables
### Général
#### Vaultwarden
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|
| **[general.vaultwarden.vaultwarden_domainname](dictionaries/40_vaultwarden.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 d'accès à Vaultwarden.<br/>**Example:** vault.example.net |
| **[general.vaultwarden.vaultwarden_admin_email](dictionaries/40_vaultwarden.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'utilisateur Risotto.<br/>**Example:** admin@example.net |
## Variables
### Général
#### Vaultwarden
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|
| **[general.vaultwarden.password_admin_username](dictionaries/40_vaultwarden.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'utilisateur Risotto de Vaultwarden.<br/>**Default:** risotto |
| **[general.vaultwarden.vaultwarden_length](dictionaries/40_vaultwarden.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 par défaut du mot de passe.<br/>**Default:** 20 |
| **[general.vaultwarden.vaultwarden_org_name](dictionaries/40_vaultwarden.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'organisation lors de l'envoi des invitations.<br/>**Default:** Vaultwarden |
## 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* |
## Requirements services
- **LocalDNS**
- Journald
- **SMTP**
- **ReverseProxy**
- **Postgresql**
**bold**: provider is mandatory
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
vaultwarden: vaultwarden:
applicationservice: vaultwarden applicationservice: vaultwarden
@ -25,19 +70,9 @@ vaultwarden:
- reverseproxy - reverseproxy
- smtp - smtp
- postgresql - postgresql
``` values:
general.vaultwarden.vaultwarden_domainname: vault.example.net
With all providers: general.vaultwarden.vaultwarden_admin_email: admin@example.net
```
vaultwarden:
applicationservice: vaultwarden
zones_name:
- journald
- localdns
- reverseproxy
- smtp
- postgresql
``` ```
## Dependances ## Dependances
@ -55,34 +90,4 @@ vaultwarden:
- [relay-mail-client](../relay-mail-client/README.md) - [relay-mail-client](../relay-mail-client/README.md)
- [reverse-proxy-client](../reverse-proxy-client/README.md) - [reverse-proxy-client](../reverse-proxy-client/README.md)
## Variables
### Général (*general*)
#### revprox (*general.revprox*)
| Description | Values |
|--------------------------------------------------------------------|-------------|
| *[**revprox_client_cert_owner**](dictionaries/40_vaultwarden.xml)* | vaultwarden |
#### Vaultwarden (*general.vaultwarden*)
| Description | Type | Values |
|-----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|-------------|
| **Nom de domaine d'accès à Vaultwarden** (*[vaultwarden_domainname](dictionaries/40_vaultwarden.xml)*) | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | |
| **Nom de l'utilisateur Risotto de Vaultwarden** (*[password_admin_username](dictionaries/40_vaultwarden.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | risotto |
| **Adresse courriel de l'utilisateur Risotto** (*[vaultwarden_admin_email](dictionaries/40_vaultwarden.xml)*) | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | |
| **Taille par défaut du mot de passe** (*[vaultwarden_length](dictionaries/40_vaultwarden.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 20 |
| **Nom de l'organisation lors de l'envoi des invitations** (*[vaultwarden_org_name](dictionaries/40_vaultwarden.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Vaultwarden |
#### PostgreSQL (*general.postgresql*)
| Description | Values |
|--------------------------------------------------------------|-------------|
| *[**pg_client_key_owner**](dictionaries/40_vaultwarden.xml)* | vaultwarden |
- [+]: variable is multiple
- **bold**: variable is mandatory
[All applications services for this dataset.](../README.md) [All applications services for this dataset.](../README.md)

4
seed/vaultwarden/dictionaries/40_vaultwarden.xml
View file

@ -18,11 +18,11 @@
</variable> </variable>
</family> </family>
<family name="vaultwarden" description="Vaultwarden"> <family name="vaultwarden" description="Vaultwarden">
<variable name="vaultwarden_domainname" type="domainname" description="Nom de domaine d'accès à Vaultwarden" mandatory="True"/> <variable name="vaultwarden_domainname" type="domainname" description="Nom de domaine d'accès à Vaultwarden" mandatory="True" test="vault.example.net"/>
<variable name="password_admin_username" description="Nom de l'utilisateur Risotto de Vaultwarden" auto_save="False"> <variable name="password_admin_username" description="Nom de l'utilisateur Risotto de Vaultwarden" auto_save="False">
<value>risotto</value> <value>risotto</value>
</variable> </variable>
<variable name="vaultwarden_admin_email" type="mail" description="Adresse courriel de l'utilisateur Risotto" mandatory="True"/> <variable name="vaultwarden_admin_email" type="mail" description="Adresse courriel de l'utilisateur Risotto" mandatory="True" test="admin@example.net"/>
<variable name="vaultwarden_admin_password" type="password" description="Mot de passe de l'utilisateur Risotto" auto_save="False" hidden="True"/> <variable name="vaultwarden_admin_password" type="password" description="Mot de passe de l'utilisateur Risotto" auto_save="False" hidden="True"/>
<variable name="vaultwarden_length" type="number" description="Taille par défaut du mot de passe"> <variable name="vaultwarden_length" type="number" description="Taille par défaut du mot de passe">
<value>20</value> <value>20</value>

48
seed/vector/README.md
View file

@ -5,18 +5,24 @@ include_toc: true
# vector # vector
## Description ## Synopsis
Vector, a lightweight, ultra-fast tool for building observability pipelines. Vector, a lightweight, ultra-fast tool for building observability pipelines.
[For more informations](https://vector.dev/) [More informations about this software.](https://vector.dev/)
## Examples ## Requirements services
- **LocalDNS**
- Journald
- **Loki**
**bold**: provider is mandatory
## Example
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
vector: vector:
applicationservice: vector applicationservice: vector
@ -26,18 +32,6 @@ vector:
- loki - loki
``` ```
With all providers:
```
vector:
applicationservice: vector
provider_zone: journald
zones_name:
- journald
- localdns
- loki
```
## Dependances ## Dependances
- [base-fedora-38](../base-fedora-38/README.md) - [base-fedora-38](../base-fedora-38/README.md)
@ -51,26 +45,6 @@ vector:
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md)
- [journald_remote](../journald_remote/README.md) - [journald_remote](../journald_remote/README.md)
## Variables
### Général (*general*)
#### loki (*general.vector*)
| Description | Type | Provider |
|------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------|
| *[client_addresses](dictionaries/20_vector.xml)* [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Vector |
#### loki (*general.loki*)
| Description | Type | Supplier |
|-------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|------------|
| *[**server_domainname**](dictionaries/20_vector.xml)* | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Loki |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Supplier ## Supplier
[host-systemd-machined](../host-systemd-machined/README.md) [host-systemd-machined](../host-systemd-machined/README.md)

115
seed/znc/README.md
View file

@ -5,34 +5,75 @@ include_toc: true
# znc # znc
## Description ## Synopsis
ZNC, a bouncer IRC. ZNC, a bouncer IRC.
[For more informations](https://wiki.znc.in/) [More informations about this software.](https://wiki.znc.in/)
## Examples ## Basic variables
### Général
#### IRC Bouncer ZNC
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| **[general.znc.external_domain_name](dictionaries/40_znc.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 externe de ZNC.<br/>**Example:** irc.example.net |
| **[general.znc.user_name](dictionaries/40_znc.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) | Utilisateur IRC et ZNC.<br/>**Example:** jdoe |
| **[general.znc.user_password](dictionaries/40_znc.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 l'utilisateur ZNC.<br/>**Example:** JD0eP@ss |
| **[general.znc.real_name](dictionaries/40_znc.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 réel.<br/>**Example:** John Doe |
##### Serveurs IRC
This a family is a leadership.
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------|
| **[general.znc.servers.server_names](dictionaries/40_znc.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) | Adresse du serveur IRC.<br/>**Example:** irc.oftc.net |
| **[general.znc.servers.password](dictionaries/40_znc.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 l'utilisateur sur le serveur IRC.<br/>**Example:** p@ssw0rd |
| **[general.znc.servers.channels](dictionaries/40_znc.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 des salons du serveur IRC.<br/>**Example:** example |
## Variables
### Général
#### IRC Bouncer ZNC
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.znc.znc_crt_provider](dictionaries/40_znc.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
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file. Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
``` ```
znc: znc:
applicationservice: znc applicationservice: znc
zones_name: zones_name:
- localdns - localdns
``` values:
general.znc.external_domain_name: irc.example.net
With all providers: general.znc.user_name: jdoe
general.znc.user_password: JD0eP@ss
``` general.znc.real_name: John Doe
znc: general.znc.servers.server_names:
applicationservice: znc - irc.oftc.net
zones_name: general.znc.servers.password:
- journald '0': p@ssw0rd
- externaldns general.znc.servers.channels:
- localdns '0': example
``` ```
## Dependances ## Dependances
@ -48,46 +89,4 @@ znc:
- [resolved](../resolved/README.md) - [resolved](../resolved/README.md)
- [dns-external](../dns-external/README.md) - [dns-external](../dns-external/README.md)
## Variables
### Général (*general*)
#### network (*general.network*)
| Description | Values |
|-------------------------------------------------|----------|
| *[**incoming_ports**](dictionaries/40_znc.xml)* | 5535 |
#### IRC Bouncer ZNC (*general.znc*)
| Description | Type | Values | Choices |
|--------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|-----------|----------------------------|
| **Nom de domaine externe de ZNC** (*[external_domain_name](dictionaries/40_znc.xml)*) | [domainname](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** (*[znc_crt_provider](dictionaries/40_znc.xml)*) | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | autosigne | autosigne<br />letsencrypt |
| **Utilisateur IRC et ZNC** (*[user_name](dictionaries/40_znc.xml)*) | [unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
| **Mot de passe de l'utilisateur ZNC** (*[user_password](dictionaries/40_znc.xml)*) | [password](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
| **Nom d'utilisateur réel** (*[real_name](dictionaries/40_znc.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | |
##### Serveurs IRC (*general.znc.servers*)
This a family is a leadership.
| Description | Type |
|----------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
| **Adresse du serveur IRC** (*[server_names](dictionaries/40_znc.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **Mot de passe de l'utilisateur sur le serveur IRC** (*[password](dictionaries/40_znc.xml)*) | [password](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **Nom des salons du serveur IRC** (*[channels](dictionaries/40_znc.xml)*) [+] | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
### Machine (*machine*)
| Description | Values |
|-------------------------------------------------|----------|
| *[**var_size**](extras/machine/20_unbound.xml)* | 256 |
| *[**add_tmp**](extras/machine/20_unbound.xml)* | False |
| *[**add_swap**](extras/machine/20_unbound.xml)* | False |
- [+]: variable is multiple
- **bold**: variable is mandatory
[All applications services for this dataset.](../README.md) [All applications services for this dataset.](../README.md)

18
seed/znc/dictionaries/40_znc.xml
View file

@ -17,22 +17,22 @@
</variable> </variable>
</family> </family>
<family name="znc" description="IRC Bouncer ZNC"> <family name="znc" description="IRC Bouncer ZNC">
<variable name="external_domain_name" type="domainname" description="Nom de domaine externe de ZNC" mandatory="True"/> <variable name="external_domain_name" type="domainname" description="Nom de domaine externe de ZNC" mandatory="True" test="irc.example.net"/>
<variable name="znc_crt_provider" type="choice" description="Autorité de certification signant le certificat du domaine extérieur" mandatory="True"> <variable name="znc_crt_provider" type="choice" description="Autorité de certification signant le certificat du domaine extérieur" mandatory="True">
<value>autosigne</value> <value>self-signed</value>
<choice>autosigne</choice> <choice>self-signed</choice>
<choice>letsencrypt</choice> <choice>letsencrypt</choice>
</variable> </variable>
<variable name="user_name" type="unix_user" description="Utilisateur IRC et ZNC" mandatory="True"/> <variable name="user_name" type="unix_user" description="Utilisateur IRC et ZNC" mandatory="True" test="jdoe"/>
<variable name="user_password" type="password" description="Mot de passe de l'utilisateur ZNC" mandatory="True"/> <variable name="user_password" type="password" description="Mot de passe de l'utilisateur ZNC" mandatory="True" test="JD0eP@ss"/>
<variable name="real_name" description="Nom d'utilisateur réel" mandatory="True"/> <variable name="real_name" description="Nom d'utilisateur réel" mandatory="True" test="John Doe"/>
<family name="servers" description="Serveurs IRC" leadership="True"> <family name="servers" description="Serveurs IRC" leadership="True">
<variable name="server_names" type="domainname" description="Adresse du serveur IRC" multi="True" mandatory="True"/> <variable name="server_names" type="domainname" description="Adresse du serveur IRC" multi="True" mandatory="True" test="irc.oftc.net"/>
<variable name="password" type="password" description="Mot de passe de l'utilisateur sur le serveur IRC" mandatory="True"/> <variable name="password" type="password" description="Mot de passe de l'utilisateur sur le serveur IRC" mandatory="True" test="p@ssw0rd"/>
<variable name="port" type="port" description="Port TLS du serveur IRC" mandatory="True" hidden="True"> <variable name="port" type="port" description="Port TLS du serveur IRC" mandatory="True" hidden="True">
<value>6697</value> <value>6697</value>
</variable> </variable>
<variable name="channels" description="Nom des salons du serveur IRC" multi="True" mandatory="True"/> <variable name="channels" description="Nom des salons du serveur IRC" multi="True" mandatory="True" test="example"/>
</family> </family>
</family> </family>
</variables> </variables>