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-11 09:38:05 +02:00
parent 772283e0a6
commit 93cafa78d8
91 changed files with 934 additions and 946 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

145
seed/README.md
View file

@ -1,6 +1,6 @@
# Application services
- [dovecot](dovecot/README.md): Postfix and Dovecot as mail servers (Submission and IMAP)
- [dovecot](dovecot/README.md): Postfix and Dovecot as mail servers (IMAP and submission)
- [forgejo](forgejo/README.md): Forgejo, a community managed lightweight code hosting solution
- [gitea](gitea/README.md): Transitional package for Gitea to Forgejo
- [grafana](grafana/README.md): Grafana is an analytics and interactive visualization web application
@ -77,50 +77,155 @@
- ExternalDNS:
- Provider: [unbound](unbound/README.md)
- Suppliers:
- [dns-external](dns-external/README.md)
- [postfix-relay](postfix-relay/README.md)
- [peertube](peertube/README.md)
- [znc](znc/README.md)
- [nsd-local](nsd-local/README.md)
- Host:
- Provider: [host-systemd-machined](host-systemd-machined/README.md)
- Supplier: [provider-systemd-machined](provider-systemd-machined/README.md)
- IMAP:
- Provider: [dovecot](dovecot/README.md)
- Supplier: [imap-client](imap-client/README.md)
- Supplier: [roundcube](roundcube/README.md)
- Journald:
- Provider: [journald_remote](journald_remote/README.md)
- Supplier: [journald](journald/README.md)
- Provider: [vector](vector/README.md)
- Suppliers:
- [odoo](odoo/README.md)
- [nginx-static](nginx-static/README.md)
- [grafana](grafana/README.md)
- [postgresql](postgresql/README.md)
- [postfix-relay](postfix-relay/README.md)
- [mailman](mailman/README.md)
- [peertube](peertube/README.md)
- [piwigo](piwigo/README.md)
- [vector](vector/README.md)
- [dovecot](dovecot/README.md)
- [unbound](unbound/README.md)
- [redis](redis/README.md)
- [loki](loki/README.md)
- [forgejo](forgejo/README.md)
- [nsd](nsd/README.md)
- [speedtest-rs](speedtest-rs/README.md)
- [nginx-reverse-proxy](nginx-reverse-proxy/README.md)
- [roundcube](roundcube/README.md)
- [znc](znc/README.md)
- [vaultwarden](vaultwarden/README.md)
- [prometheus](prometheus/README.md)
- [mariadb](mariadb/README.md)
- [nsd-local](nsd-local/README.md)
- [nextcloud](nextcloud/README.md)
- [lemonldap](lemonldap/README.md)
- [openldap](openldap/README.md)
- [gitea](gitea/README.md)
- LDAP:
- Provider: [openldap](openldap/README.md)
- Supplier: [ldap-client](ldap-client/README.md)
- Suppliers:
- [odoo](odoo/README.md)
- [piwigo](piwigo/README.md)
- [dovecot](dovecot/README.md)
- [roundcube](roundcube/README.md)
- [nextcloud](nextcloud/README.md)
- [lemonldap](lemonldap/README.md)
- LMTP:
- Provider: [postfix-lmtp-relay](postfix-lmtp-relay/README.md)
- Supplier: [relay-lmtp-client](relay-lmtp-client/README.md)
- Provider: [postfix-relay](postfix-relay/README.md)
- Suppliers:
- [mailman](mailman/README.md)
- [dovecot](dovecot/README.md)
- LocalDNS:
- Provider: [nsd-local](nsd-local/README.md)
- Supplier: [dns-local](dns-local/README.md)
- Suppliers:
- [odoo](odoo/README.md)
- [nginx-static](nginx-static/README.md)
- [grafana](grafana/README.md)
- [postgresql](postgresql/README.md)
- [mailman](mailman/README.md)
- [piwigo](piwigo/README.md)
- [vector](vector/README.md)
- [dovecot](dovecot/README.md)
- [redis](redis/README.md)
- [loki](loki/README.md)
- [forgejo](forgejo/README.md)
- [nsd](nsd/README.md)
- [speedtest-rs](speedtest-rs/README.md)
- [nginx-reverse-proxy](nginx-reverse-proxy/README.md)
- [roundcube](roundcube/README.md)
- [vaultwarden](vaultwarden/README.md)
- [prometheus](prometheus/README.md)
- [mariadb](mariadb/README.md)
- [nsd-local](nsd-local/README.md)
- [nextcloud](nextcloud/README.md)
- [lemonldap](lemonldap/README.md)
- [openldap](openldap/README.md)
- [gitea](gitea/README.md)
- Loki:
- Provider: [loki](loki/README.md)
- Supplier: [vector](vector/README.md)
- MariaDB:
- Provider: [mariadb](mariadb/README.md)
- Supplier: [mariadb-client](mariadb-client/README.md)
- Supplier: [piwigo](piwigo/README.md)
- OAuth2:
- Provider: [lemonldap](lemonldap/README.md)
- Supplier: [oauth2-client](oauth2-client/README.md)
- Suppliers:
- [odoo](odoo/README.md)
- [grafana](grafana/README.md)
- [mailman](mailman/README.md)
- [peertube](peertube/README.md)
- [piwigo](piwigo/README.md)
- [dovecot](dovecot/README.md)
- [forgejo](forgejo/README.md)
- [roundcube](roundcube/README.md)
- [nextcloud](nextcloud/README.md)
- [gitea](gitea/README.md)
- Postgresql:
- Provider: [postgresql](postgresql/README.md)
- Supplier: [postgresql-client](postgresql-client/README.md)
- Suppliers:
- [odoo](odoo/README.md)
- [grafana](grafana/README.md)
- [mailman](mailman/README.md)
- [peertube](peertube/README.md)
- [forgejo](forgejo/README.md)
- [roundcube](roundcube/README.md)
- [vaultwarden](vaultwarden/README.md)
- [nextcloud](nextcloud/README.md)
- [gitea](gitea/README.md)
- Prometheus:
- Provider: [prometheus](prometheus/README.md)
- Supplier: [host-systemd-machined](host-systemd-machined/README.md)
- Redis:
- Provider: [redis](redis/README.md)
- Supplier: [redis-client](redis-client/README.md)
- Suppliers:
- [peertube](peertube/README.md)
- [piwigo](piwigo/README.md)
- [forgejo](forgejo/README.md)
- [roundcube](roundcube/README.md)
- [nextcloud](nextcloud/README.md)
- [gitea](gitea/README.md)
- ReverseProxy:
- Provider: [nginx-reverse-proxy](nginx-reverse-proxy/README.md)
- Supplier: [reverse-proxy-client](reverse-proxy-client/README.md)
- Suppliers:
- [odoo](odoo/README.md)
- [nginx-static](nginx-static/README.md)
- [grafana](grafana/README.md)
- [mailman](mailman/README.md)
- [peertube](peertube/README.md)
- [piwigo](piwigo/README.md)
- [dovecot](dovecot/README.md)
- [forgejo](forgejo/README.md)
- [speedtest-rs](speedtest-rs/README.md)
- [roundcube](roundcube/README.md)
- [vaultwarden](vaultwarden/README.md)
- [nextcloud](nextcloud/README.md)
- [lemonldap](lemonldap/README.md)
- [gitea](gitea/README.md)
- SMTP:
- Provider: [postfix-relay](postfix-relay/README.md)
- Supplier: [relay-mail-client](relay-mail-client/README.md)
- Suppliers:
- [odoo](odoo/README.md)
- [grafana](grafana/README.md)
- [mailman](mailman/README.md)
- [peertube](peertube/README.md)
- [piwigo](piwigo/README.md)
- [dovecot](dovecot/README.md)
- [forgejo](forgejo/README.md)
- [vaultwarden](vaultwarden/README.md)
- [nextcloud](nextcloud/README.md)
- [lemonldap](lemonldap/README.md)
- [gitea](gitea/README.md)
- Vector:
- Provider: [vector](vector/README.md)
- Supplier: [host-systemd-machined](host-systemd-machined/README.md)

9
seed/apache/README.md
View file

@ -3,19 +3,20 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# apache
## Synopsis
Apache as web server.
[Software's website.](https://httpd.apache.org/)
[Apache as web server.](https://httpd.apache.org/)
## Variables for expert
### Général
### General
#### Apache
@ -33,5 +34,3 @@ Paramètrage avancé du serveur web Apache.
## Used by
[nextcloud](../nextcloud/README.md)
[All applications services for this dataset.](../README.md)

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

@ -3,13 +3,14 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# base-debian-bullseye
## Synopsis
Base information of a Debian Bulleye server.
[Software's website.](https://www.debian.org/)
[Base information of a Debian Bulleye server.](https://www.debian.org/)
## Dependances
@ -27,5 +28,3 @@ Base information of a Debian Bulleye server.
- [odoo](../odoo/README.md)
- [mailman](../mailman/README.md)
- [lemonldap](../lemonldap/README.md)
[All applications services for this dataset.](../README.md)

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

@ -3,13 +3,14 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# base-debian
## Synopsis
Base information of a Debian server.
[Software's website.](https://www.debian.org/)
[Base information of a Debian server.](https://www.debian.org/)
## Dependances
@ -24,5 +25,3 @@ Base information of a Debian server.
## Used by
[base-debian-bullseye](../base-debian-bullseye/README.md)
[All applications services for this dataset.](../README.md)

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

@ -3,13 +3,14 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# base-fedora-35
## Synopsis
Base information of a Fedora 35.
[Software's website.](https://getfedora.org/)
[Base information of a Fedora 35.](https://getfedora.org/)
## Dependances
@ -25,5 +26,3 @@ Base information of a Fedora 35.
## Used by
[postfix-relay](../postfix-relay/README.md)
[All applications services for this dataset.](../README.md)

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

@ -3,13 +3,14 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# base-fedora-36
## Synopsis
Base information of a Fedora 36.
[Software's website.](https://getfedora.org/)
[Base information of a Fedora 36.](https://getfedora.org/)
## Dependances
@ -32,5 +33,3 @@ Base information of a Fedora 36.
- [vaultwarden](../vaultwarden/README.md)
- [mariadb](../mariadb/README.md)
- [nextcloud](../nextcloud/README.md)
[All applications services for this dataset.](../README.md)

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

@ -3,13 +3,14 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# base-fedora-37
## Synopsis
Base information of a Fedora 37.
[Software's website.](https://getfedora.org/)
[Base information of a Fedora 37.](https://getfedora.org/)
## Dependances
@ -30,5 +31,3 @@ Base information of a Fedora 37.
- [nsd](../nsd/README.md)
- [nginx-reverse-proxy](../nginx-reverse-proxy/README.md)
- [openldap](../openldap/README.md)
[All applications services for this dataset.](../README.md)

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

@ -3,13 +3,14 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# base-fedora-38
## Synopsis
Base information of a Fedora 38.
[Software's website.](https://getfedora.org/)
[Base information of a Fedora 38.](https://getfedora.org/)
## Dependances
@ -31,5 +32,3 @@ Base information of a Fedora 38.
- [loki](../loki/README.md)
- [forgejo](../forgejo/README.md)
- [prometheus](../prometheus/README.md)
[All applications services for this dataset.](../README.md)

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

@ -3,13 +3,14 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# base-fedora
## Synopsis
Base information of a Fedora.
[Software's website.](https://getfedora.org/)
[Base information of a Fedora.](https://getfedora.org/)
## Dependances
@ -27,5 +28,3 @@ Base information of a Fedora.
- [base-fedora-35](../base-fedora-35/README.md)
- [base-fedora-38](../base-fedora-38/README.md)
- [base-fedora-37](../base-fedora-37/README.md)
[All applications services for this dataset.](../README.md)

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

@ -3,6 +3,8 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# base-machine
## Synopsis
@ -28,5 +30,3 @@ Base information for a machine.
## Used by
[systemd](../systemd/README.md)
[All applications services for this dataset.](../README.md)

4
seed/base/README.md
View file

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

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

@ -3,6 +3,8 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# dns-external
## Synopsis
@ -12,7 +14,7 @@ DNS client with resolution on all zones (especially outside).
## Variables
### Général
### General
#### network
@ -27,9 +29,3 @@ DNS client with resolution on all zones (especially outside).
- [peertube](../peertube/README.md)
- [unbound](../unbound/README.md)
- [znc](../znc/README.md)
## Provider
[unbound](../unbound/README.md)
[All applications services for this dataset.](../README.md)

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

@ -5,7 +5,7 @@
<variable name="dns_is_only_local" redefine="True">
<value>False</value>
</variable>
<variable name="dns_client_address" redefine="True" supplier="ExternalDNS"/>
<variable name="dns_client_address" redefine="True" supplier="ExternalDNS" hidden="True"/>
</family>
</variables>
</rougail>

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

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

77
seed/dovecot/README.md
View file

@ -3,71 +3,67 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# dovecot
## Synopsis
Postfix and Dovecot as mail servers (Submission and IMAP).
[Software's website.](https://www.dovecot.org/)
[Postfix and Dovecot as mail servers (IMAP and submission).](https://www.dovecot.org/)
This application service provides email server. Two servers are used: Dovecot as IMAP server and Postfix as submission server. In addition, an auto-detection file of the email configuration is set up.
## Basic variables
### Général
### General
#### Mail configuration
Configure IMAP servers and submission to access email accounts and send emails.
##### Mail domain
This family is a leadership.
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
| **[general.mail.domain.mail_domains](dictionaries/31_dovecot.xml)**<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 |
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.mail.domain.mail_domains](dictionaries/31_dovecot.xml)**<br/>mandatory, multiple<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Final destination email address.<br/>These domain names are the domain names for emails (user@*example.net*) and for auto configuration of email clients (https://*example.net*/.well-known/autoconfig/mail/config-v1.1.xml).<br/>**Example:** example.net |
| **[general.mail.domain.imap_domainname](dictionaries/31_dovecot.xml)**<br/>mandatory<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | External IMAP server address.<br/>Matches TLS connection’s SNI name, if it’s sent by the client. For some email clients, use in DNS configuration a line like "_submissions._tcp IN SRV 1 587 *imap.example.net*.".<br/>**Example:** imap.example.net |
| **[general.mail.domain.submission_domainname](dictionaries/31_dovecot.xml)**<br/>mandatory<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | External submission server address.<br/>Matches TLS connection’s SNI name, if it’s sent by the client. For some email clients, add in DNS configuration a line like "_imaps._tcp IN SRV 0 1 993 *submission.example.net*.".<br/>**Example:** submission.example.net |
## Variables
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.mail.mail_crt_provider](dictionaries/31_dovecot.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Type of certificate autority signing external IMAP and submission domain certificates.<br/>The certificate can be self-signed (therefore invalid by default for the client) or obtained via the Let's Encrypt service (generally valid for the client).<br/>**Choices:**<br/>- `self-signed` ← default<br/>- `letsencrypt` |
### Général
#### Mail configuration
##### Mail domain
This family is a leadership.
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.mail.mail_crt_provider](dictionaries/31_dovecot.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Autorité de certification signant les certificats des domaines extérieurs.<br/>**Choices:**<br/>- `self-signed` ← default<br/>- `letsencrypt` |
## Variables for expert
### Général
### General
#### Annuaire OpenLDAP
#### OpenLDAP directory
##### 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* |
| 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) | Restrict service configuration for a LDAP family.<br/>"all" for all families.<br/>**Default:** all |
## Requirements services
- **LocalDNS**
- Journald
- **SMTP**
- **LDAP**
- **ReverseProxy**
- **LMTP**
- **OAuth2**
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
- SMTP: [postfix-relay](../postfix-relay/README.md)
- LDAP: [openldap](../openldap/README.md)
- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md)
- OAuth2: [lemonldap](../lemonldap/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -82,10 +78,9 @@ dovecot:
zones_name:
- ldap
- localdns
- oauth2
- reverseproxy
- smtp
- lmtp
- oauth2
values:
general.mail.domain.mail_domains:
- example.net
@ -114,8 +109,6 @@ dovecot:
- [nginx-common](../nginx-common/README.md)
- [reverse-proxy-client](../reverse-proxy-client/README.md)
## Supplier
## Useful for service
[imap-client](../imap-client/README.md)
[All applications services for this dataset.](../README.md)
[roundcube](../roundcube/README.md): Roundcube, a webmail.

3
seed/dovecot/applicationservice.yml
View file

@ -1,5 +1,6 @@
format: '0.1'
description: Postfix and Dovecot as mail servers (Submission and IMAP)
description: Postfix and Dovecot as mail servers (IMAP and submission)
help: "This application service provides email server. Two servers are used: Dovecot as IMAP server and Postfix as submission server. In addition, an auto-detection file of the email configuration is set up."
website: https://www.dovecot.org/
depends:
- base-fedora-36

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

@ -63,21 +63,21 @@
</variable>
</family>
</family>
<family name="mail" description="Mail configuration">
<family name="mail" description="Mail configuration" help="Configure IMAP servers and submission to access email accounts and send emails">
<family name="domain" description="Mail domain" leadership="True">
<variable name="mail_domains" type="domainname" description="Domaine de courriel géré localement" mandatory="True" multi="True" supplier="LMTP:criteria" test="example.net"/>
<variable name="mail_domains" type="domainname" description="Final destination email address" mandatory="True" multi="True" supplier="LMTP:criteria" test="example.net"/>
<variable name="mail_domains_calc" type="domainname" hidden="True"/>
<variable name="imap_domainname" type="domainname" description="Domaine exterieur d'accès au serveur IMAP" mandatory="True" test="imap.example.net"/>
<variable name="submission_domainname" type="domainname" description="Domaine exterieur d'accès au serveur submission" mandatory="True" test="submission.example.net"/>
<variable name="imap_domainname" type="domainname" description="External IMAP server address" mandatory="True" test="imap.example.net" help="Matches TLS connection's SNI name, if it’s sent by the client"/>
<variable name="submission_domainname" type="domainname" description="External submission server address" mandatory="True" test="submission.example.net" help="Matches TLS connection's SNI name, if it’s sent by the client"/>
</family>
<variable name="mail_crt_provider" type="choice" description="Autorité de certification signant les certificats des domaines extérieurs" mandatory="True">
<variable name="mail_crt_provider" type="choice" description="Type of certificate autority signing external IMAP and submission domain certificates" mandatory="True" mode="basic" help="The certificate can be self-signed (therefore invalid by default for the client) or obtained via the Let's Encrypt service (generally valid for the client)">
<value>self-signed</value>
<choice>self-signed</choice>
<choice>letsencrypt</choice>
</variable>
</family>
<family name="dovecot" description="IMAP mail server">
<variable name="imap_internal_addresses" type="domainname" description="IMAP client address" mandatory="True" provider="IMAP" multi="True"/>
<variable name="imap_internal_addresses" type="domainname" description="IMAP client address" mandatory="True" provider="IMAP" multi="True" hidden="True"/>
<variable name="well_known_filenames" type="filename" hidden='True' multi="True"/>
</family>
<family name="revprox">

51
seed/forgejo/README.md
View file

@ -3,17 +3,18 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# forgejo
## Synopsis
Forgejo, a community managed lightweight code hosting solution.
[Software's website.](https://forgejo.org/)
[Forgejo, a community managed lightweight code hosting solution.](https://forgejo.org/)
## Basic variables
### Général
### General
#### Reverse proxy
@ -38,7 +39,7 @@ Git forge Forgejo.
## Variables for expert
### Général
### General
#### Reverse proxy
@ -50,21 +51,6 @@ This family is a leadership.
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|
| **[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 |
@ -89,13 +75,18 @@ This family is a leadership.
## Requirements services
- **LocalDNS**
- Journald
- **SMTP**
- **ReverseProxy**
- **Postgresql**
- **Redis**
- **OAuth2**
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
- SMTP: [postfix-relay](../postfix-relay/README.md)
- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md)
- Postgresql: [postgresql](../postgresql/README.md)
- OAuth2: [lemonldap](../lemonldap/README.md)
- Redis: [redis](../redis/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -108,11 +99,11 @@ forgejo:
applicationservice: forgejo
zones_name:
- localdns
- reverseproxy
- smtp
- redis
- oauth2
- postgresql
- redis
- reverseproxy
- smtp
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
@ -140,5 +131,3 @@ forgejo:
## Used by
[gitea](../gitea/README.md)
[All applications services for this dataset.](../README.md)

50
seed/gitea/README.md
View file

@ -3,6 +3,8 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# gitea
## Synopsis
@ -11,7 +13,7 @@ Transitional package for Gitea to Forgejo.
## Basic variables
### Général
### General
#### Reverse proxy
@ -36,7 +38,7 @@ Git forge Forgejo.
## Variables
### Général
### General
#### Forgejo
@ -54,7 +56,7 @@ Git forge Forgejo.
## Variables for expert
### Général
### General
#### Reverse proxy
@ -66,21 +68,6 @@ This family is a leadership.
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|
| **[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 |
@ -105,13 +92,18 @@ This family is a leadership.
## Requirements services
- **LocalDNS**
- Journald
- **SMTP**
- **ReverseProxy**
- **Postgresql**
- **Redis**
- **OAuth2**
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
- SMTP: [postfix-relay](../postfix-relay/README.md)
- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md)
- Postgresql: [postgresql](../postgresql/README.md)
- OAuth2: [lemonldap](../lemonldap/README.md)
- Redis: [redis](../redis/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -124,11 +116,11 @@ gitea:
applicationservice: gitea
zones_name:
- localdns
- reverseproxy
- smtp
- redis
- oauth2
- postgresql
- redis
- reverseproxy
- smtp
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
@ -152,5 +144,3 @@ gitea:
- [redis-client](../redis-client/README.md)
- [redis-common](../redis-common/README.md)
- [oauth2-client](../oauth2-client/README.md)
[All applications services for this dataset.](../README.md)

40
seed/grafana/README.md
View file

@ -3,17 +3,18 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# grafana
## Synopsis
Grafana is an analytics and interactive visualization web application.
[Software's website.](https://grafana.com/)
[Grafana is an analytics and interactive visualization web application.](https://grafana.com/)
## Basic variables
### Général
### General
#### Reverse proxy
@ -37,7 +38,7 @@ This family is a leadership.
## Variables for expert
### Général
### General
#### Reverse proxy
@ -49,14 +50,6 @@ This family is a leadership.
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|
| **[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 |
@ -79,12 +72,17 @@ This family is a leadership.
## Requirements services
- **LocalDNS**
- Journald
- **SMTP**
- **ReverseProxy**
- **Postgresql**
- **OAuth2**
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
- SMTP: [postfix-relay](../postfix-relay/README.md)
- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md)
- Postgresql: [postgresql](../postgresql/README.md)
- OAuth2: [lemonldap](../lemonldap/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -97,10 +95,10 @@ grafana:
applicationservice: grafana
zones_name:
- localdns
- reverseproxy
- smtp
- oauth2
- postgresql
- reverseproxy
- smtp
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
@ -122,5 +120,3 @@ grafana:
- [oauth2-client](../oauth2-client/README.md)
- [reverse-proxy-client](../reverse-proxy-client/README.md)
- [relay-mail-client](../relay-mail-client/README.md)
[All applications services for this dataset.](../README.md)

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

@ -3,17 +3,18 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# host-systemd-machined
## Synopsis
Host with machine started in Systemd Machined environment.
[Software's website.](https://www.freedesktop.org/wiki/Software/systemd/machined/)
[Host with machine started in Systemd Machined environment.](https://www.freedesktop.org/wiki/Software/systemd/machined/)
## Basic variables
### Général
### General
#### network
@ -34,7 +35,7 @@ This family is a leadership.
## Variables
### Général
### General
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|
@ -54,14 +55,3 @@ This family is a leadership.
## Dependances
- [base](../base/README.md)
## Supplier
[provider-systemd-machined](../provider-systemd-machined/README.md)
## Providers
- [prometheus](../prometheus/README.md)
- [vector](../vector/README.md)
[All applications services for this dataset.](../README.md)

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

@ -33,10 +33,10 @@
</service>
</services>
<variables>
<variable name="host_install_dir" type="filename" description="Nom du répertoire comprenant les descriptions d'installation" mandatory="True" provider="global:host_install_dir"/>
<variable name="host_install_dir" type="filename" mandatory="True" provider="global:host_install_dir" hidden="True"/>
<variable name="host_name" type="domainname" hidden="True" provider="global:server_name" mandatory="True"/>
<variable name="module_name" type="string" hidden="True" provider="global:module_name" mandatory="True"/>
<variable name="tls_server" type="domainname" description="tls domaine name" mandatory="True" provider="global:tls_server"/>
<variable name="tls_server" type="domainname" mandatory="True" provider="global:tls_server" hidden="True"/>
<variable name="systemd_zone_filename" type="filename" hidden="True" multi="True"/>
<variable name="systemd_netzone_filename" type="filename" hidden="True" multi="True"/>
<variable name="vm_swappiness" type="number" description="Ajustement de la mémoire virtuelle" mandatory="True">

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

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

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

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

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

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

11
seed/journald/README.md
View file

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

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

@ -9,7 +9,7 @@
</services>
<variables>
<family name="journald" description="systemd-journald">
<variable name="journal_client_server_domainname" type="domainname" supplier="Journald"/>
<variable name="journal_client_server_domainname" type="domainname" supplier="Journald" hidden="True"/>
<variable name="journal_host_name" type="domainname" supplier="Journald:host" hidden="True"/>
</family>
</variables>

11
seed/journald_remote/README.md
View file

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

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

@ -1,8 +1,8 @@
<?xml version='1.0' encoding='UTF-8'?>
<rougail version="0.10">
<variables>
<variable name="remotes" description="Remote journald" type="domainname" provider="Journald" mandatory="True" multi="True"/>
<family name="remote_" description="Account for " dynamic="accounts.remotes">
<variable name="remotes" description="Remote journald" type="domainname" provider="Journald" mandatory="True" multi="True" hidden="True"/>
<family name="remote_" description="Account for " dynamic="accounts.remotes" hidden="True">
<variable name="host_" description="Remote host" type="domainname" mandatory="True" provider="Journald:host"/>
<variable name="messages_" multi="True" provider="Journald:message" unique="False"/>
<variable name="services_" multi="True" provider="Journald:service" unique="False"/>

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

@ -3,6 +3,8 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# ldap-client
## Synopsis
@ -13,19 +15,15 @@ Application service needs interact with a LDAP server.
## Variables for expert
### Général
### General
#### Annuaire OpenLDAP
#### OpenLDAP directory
##### 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* |
| 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) | Restrict service configuration for a LDAP family.<br/>"all" for all families. |
## Used by
@ -35,9 +33,3 @@ Application service needs interact with a LDAP server.
- [roundcube](../roundcube/README.md)
- [nextcloud](../nextcloud/README.md)
- [lemonldap](../lemonldap/README.md)
## Provider
[openldap](../openldap/README.md)
[All applications services for this dataset.](../README.md)

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

@ -7,28 +7,28 @@
</service>
</services>
<variables>
<family name="ldap" description="Annuaire OpenLDAP">
<family name="server" description="Serveur">
<variable name='ldap_server_address' type='domainname' description="Nom DNS du serveur LDAP" mandatory='True' supplier="LDAP"/>
<family name="ldap" description="OpenLDAP directory">
<family name="server" description="Server">
<variable name='ldap_server_address' type='domainname' hidden="True" mandatory='True' supplier="LDAP"/>
<variable name="ldap_server_ip" type="ip" hidden="True"/>
<variable name='ldap_port' type='port' description='Port du serveur LDAP' hidden="True">
<variable name='ldap_port' type='port' hidden="True">
<value>636</value>
</variable>
<variable name='prefix_domain_name' hidden="True" mandatory="True" provider="global:prefix_domain_name"/>
</family>
<family name="client" description="Client">
<variable name='ldapclient_family' type='unix_user' description="Nom de la famille LDAP" supplier="LDAP:family"/>
<variable name='ldapclient_user' type='string' description="DN de l'utilisateur LDAP" mandatory='False' hidden="True" supplier="LDAP:dn"/>
<variable name='ldapclient_family' type='unix_user' description="Restrict service configuration for a LDAP family" supplier="LDAP:family"/>
<variable name='ldapclient_user' type='string' mandatory='False' hidden="True" supplier="LDAP:dn"/>
<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_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" mode="expert"/>
<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" 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='ldapclient_user_password' type='password' mandatory='True' hidden="True" supplier="LDAP:password"/>
<variable name='ldapclient_base_dn' type='string' mandatory="True" supplier="LDAP:base_dn" hidden="True"/>
<variable name='ldapclient_search_dn' type='string' mandatory="True" hidden="True"/>
<variable name='ldapclient_group_dn' type='string' mandatory="True" hidden="True"/>
<variable name='ldapclient_user_dn' type='string' mandatory="True" hidden="True"/>
<variable name="ldap_key_file_owner" type="unix_user" hidden="True">
<value>root</value>
</variable>
<variable name="ldap_client_file" type="filename" description="Nom du fichier du client LDAP" hidden="True"/>
<variable name="ldap_client_file" type="filename" hidden="True"/>
</family>
</family>
</variables>

61
seed/lemonldap/README.md
View file

@ -3,17 +3,18 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# lemonldap
## Synopsis
LemonLDAP, a Web Single Sign On and Access Management.
[Software's website.](https://lemonldap-ng.org/)
[LemonLDAP, a Web Single Sign On and Access Management.](https://lemonldap-ng.org/)
## Basic variables
### Général
### General
#### Reverse proxy
@ -37,28 +38,22 @@ Configuration de la solution d'authentification unique LemonLDAP::NG.
## Variables for expert
### Général
### General
#### Annuaire OpenLDAP
#### OpenLDAP directory
##### 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* |
| 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) | Restrict service configuration for a LDAP family.<br/>"all" for all families.<br/>**Default:** all |
#### 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 |
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The bucket size for the server names hash tables.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The maximum allowed size of the client request body.<br/>This value is in Mb.<br/>**Default:** 32 |
#### Reverse proxy
@ -80,11 +75,16 @@ Configuration de la solution d'authentification unique LemonLDAP::NG.
## Requirements services
- **LocalDNS**
- Journald
- **SMTP**
- **LDAP**
- **ReverseProxy**
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
- SMTP: [postfix-relay](../postfix-relay/README.md)
- LDAP: [openldap](../openldap/README.md)
- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -124,8 +124,15 @@ lemonldap:
- [journald](../journald/README.md)
- [resolved](../resolved/README.md)
## Supplier
## Useful for services
[oauth2-client](../oauth2-client/README.md)
[All applications services for this dataset.](../README.md)
- [dovecot](../dovecot/README.md): Postfix and Dovecot as mail servers (IMAP and submission).
- [forgejo](../forgejo/README.md): Forgejo, a community managed lightweight code hosting solution.
- [gitea](../gitea/README.md): Transitional package for Gitea to Forgejo.
- [grafana](../grafana/README.md): Grafana is an analytics and interactive visualization web application.
- [mailman](../mailman/README.md): GNU Mailman, managing electronic mail discussion and e-newsletter lists.
- [nextcloud](../nextcloud/README.md): Nextcloud, Online collaboration platform.
- [odoo](../odoo/README.md): Odoo, an ERP and CRM.
- [peertube](../peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform.
- [piwigo](../piwigo/README.md): Piwigo, a photo management software.
- [roundcube](../roundcube/README.md): Roundcube, a webmail.

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

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

20
seed/loki/README.md
View file

@ -3,18 +3,24 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# loki
## Synopsis
Loki, a log aggregation platform.
[Software's website.](https://grafana.com/)
[Loki, a log aggregation platform.](https://grafana.com/)
## Requirements services
- **LocalDNS**
- Journald
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -42,8 +48,6 @@ loki:
- [journald](../journald/README.md)
- [resolved](../resolved/README.md)
## Supplier
## Useful for service
[vector](../vector/README.md)
[All applications services for this dataset.](../README.md)
[vector](../vector/README.md): Vector, a lightweight, ultra-fast tool for building observability pipelines.

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

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

52
seed/mailman/README.md
View file

@ -3,17 +3,18 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# mailman
## Synopsis
GNU Mailman, managing electronic mail discussion and e-newsletter lists.
[Software's website.](https://www.list.org)
[GNU Mailman, managing electronic mail discussion and e-newsletter lists.](https://www.list.org)
## Basic variables
### Général
### General
#### Reverse proxy
@ -46,16 +47,14 @@ This a dynamic family generated from the variable "general.mailman.mailman_domai
## Variables for expert
### Général
### General
#### 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 |
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The bucket size for the server names hash tables.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The maximum allowed size of the client request body.<br/>This value is in Mb.<br/>**Default:** 32 |
#### Reverse proxy
@ -67,14 +66,6 @@ This family is a leadership.
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|
| **[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 |
@ -99,13 +90,17 @@ This family is a leadership.
## Requirements services
- **LocalDNS**
- Journald
- **SMTP**
- **ReverseProxy**
- **Postgresql**
- **LMTP**
- **OAuth2**
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
- SMTP: [postfix-relay](../postfix-relay/README.md)
- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md)
- Postgresql: [postgresql](../postgresql/README.md)
- OAuth2: [lemonldap](../lemonldap/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -118,11 +113,10 @@ mailman:
applicationservice: mailman
zones_name:
- localdns
- reverseproxy
- smtp
- lmtp
- oauth2
- postgresql
- reverseproxy
- smtp
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
@ -150,5 +144,3 @@ mailman:
- [nginx-common](../nginx-common/README.md)
- [reverse-proxy-client](../reverse-proxy-client/README.md)
- [oauth2-client](../oauth2-client/README.md)
[All applications services for this dataset.](../README.md)

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

@ -3,20 +3,15 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# mariadb-client
## Synopsis
Application service needs interact with a MariaDB server.
[Software's website.](https://mariadb.org/)
[Application service needs interact with a MariaDB server.](https://mariadb.org/)
## Used by
[piwigo](../piwigo/README.md)
## Provider
[mariadb](../mariadb/README.md)
[All applications services for this dataset.](../README.md)

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

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

20
seed/mariadb/README.md
View file

@ -3,18 +3,24 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# mariadb
## Synopsis
MariaDB, a relational database.
[Software's website.](https://mariadb.org/)
[MariaDB, a relational database.](https://mariadb.org/)
## Requirements services
- **LocalDNS**
- Journald
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -42,8 +48,6 @@ mariadb:
- [journald](../journald/README.md)
- [resolved](../resolved/README.md)
## Supplier
## Useful for service
[mariadb-client](../mariadb-client/README.md)
[All applications services for this dataset.](../README.md)
[piwigo](../piwigo/README.md): Piwigo, a photo management software.

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

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

65
seed/nextcloud/README.md
View file

@ -3,17 +3,18 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# nextcloud
## Synopsis
Nextcloud, Online collaboration platform.
[Software's website.](https://nextcloud.com/)
[Nextcloud, Online collaboration platform.](https://nextcloud.com/)
## Basic variables
### Général
### General
#### Reverse proxy
@ -35,7 +36,7 @@ This family is a leadership.
## Variables for expert
### Général
### General
#### PHP
@ -64,17 +65,13 @@ Paramètrage avancé du serveur web Apache.
| **[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
#### OpenLDAP directory
##### 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* |
| 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) | Restrict service configuration for a LDAP family.<br/>"all" for all families. |
#### Reverse proxy
@ -86,21 +83,6 @@ This family is a leadership.
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|
| **[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 |
@ -125,14 +107,19 @@ This family is a leadership.
## Requirements services
- **LocalDNS**
- Journald
- **SMTP**
- **LDAP**
- **ReverseProxy**
- **Postgresql**
- **Redis**
- **OAuth2**
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
- SMTP: [postfix-relay](../postfix-relay/README.md)
- LDAP: [openldap](../openldap/README.md)
- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md)
- Postgresql: [postgresql](../postgresql/README.md)
- OAuth2: [lemonldap](../lemonldap/README.md)
- Redis: [redis](../redis/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -146,11 +133,11 @@ nextcloud:
zones_name:
- ldap
- localdns
- reverseproxy
- smtp
- redis
- oauth2
- postgresql
- redis
- reverseproxy
- smtp
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
@ -178,5 +165,3 @@ nextcloud:
- [reverse-proxy-client](../reverse-proxy-client/README.md)
- [php-fpm](../php-fpm/README.md)
- [php](../php/README.md)
[All applications services for this dataset.](../README.md)

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

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

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

@ -3,13 +3,14 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# nginx-https
## Synopsis
Nginx as HTTPS web site.
[Software's website.](https://nginx.org/)
[Nginx as HTTPS web site.](https://nginx.org/)
## Dependances
@ -26,5 +27,3 @@ Nginx as HTTPS web site.
- [dovecot](../dovecot/README.md)
- [roundcube](../roundcube/README.md)
- [lemonldap](../lemonldap/README.md)
[All applications services for this dataset.](../README.md)

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

@ -3,45 +3,58 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# nginx-reverse-proxy
## Synopsis
Nginx as reverse proxy.
[Software's website.](https://nginx.org/)
[Nginx as reverse proxy.](https://nginx.org/)
The reverse proxy allows access to the internal services.
These internal services are integrated automatically.
## Basic variables
### General
#### NGINX
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_certificates_provider](dictionaries/25_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Type of certificate autority signing external certificates.<br/>The certificate can be self-signed (therefore invalid by default for the client) or obtained via the Let's Encrypt service (generally valid for the client).<br/>**Choices:**<br/>- `self-signed` ← default<br/>- `letsencrypt` |
## Variables
### Général
### General
#### 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` |
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_default](dictionaries/25_nginx.xml)**<br/>mandatory<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Default reverse proxy domaine name.<br/>If a client access to reverse proxy with an unknown domain name, the connexion is redirect to this domain name. By default this variable is the first associated service to this reverse proxy.<br/>**Default:** *calculated* |
## Variables for expert
### Général
### General
#### 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 |
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The bucket size for the server names hash tables.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The maximum allowed size of the client request body.<br/>This value is in Mb.<br/>**Default:** 32 |
## Requirements services
- **LocalDNS**
- Journald
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -70,8 +83,19 @@ nginx-reverse-proxy:
- [journald](../journald/README.md)
- [resolved](../resolved/README.md)
## Supplier
## Useful for services
[reverse-proxy-client](../reverse-proxy-client/README.md)
[All applications services for this dataset.](../README.md)
- [dovecot](../dovecot/README.md): Postfix and Dovecot as mail servers (IMAP and submission).
- [forgejo](../forgejo/README.md): Forgejo, a community managed lightweight code hosting solution.
- [gitea](../gitea/README.md): Transitional package for Gitea to Forgejo.
- [grafana](../grafana/README.md): Grafana is an analytics and interactive visualization web application.
- [lemonldap](../lemonldap/README.md): LemonLDAP, a Web Single Sign On and Access Management.
- [mailman](../mailman/README.md): GNU Mailman, managing electronic mail discussion and e-newsletter lists.
- [nextcloud](../nextcloud/README.md): Nextcloud, Online collaboration platform.
- [nginx-static](../nginx-static/README.md): Nginx as static web site.
- [odoo](../odoo/README.md): Odoo, an ERP and CRM.
- [peertube](../peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform.
- [piwigo](../piwigo/README.md): Piwigo, a photo management software.
- [roundcube](../roundcube/README.md): Roundcube, a webmail.
- [speedtest-rs](../speedtest-rs/README.md): Speedtest-rs, a very lightweight Speedtest.
- [vaultwarden](../vaultwarden/README.md): Vaultwarden, a password manager.

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

@ -20,7 +20,7 @@
</variable>
</family>
<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" mode="basic" help="The certificate can be self-signed (therefore invalid by default for the client) or obtained via the Let's Encrypt service (generally valid for the client)">
<value>self-signed</value>
<choice>self-signed</choice>
<choice>letsencrypt</choice>

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

@ -1,7 +1,7 @@
<?xml version='1.0' encoding='UTF-8'?>
<rougail version="0.10">
<variables>
<variable name="remotes" type="domainname" description="Nom des domaines dans le serveur mandataire inverse" multi="True" provider="ReverseProxy"/>
<variable name="remotes" type="domainname" multi="True" provider="ReverseProxy" hidden="True"/>
<family name="reverse_proxy_for_" description="Serveur mandataire inverse pour " dynamic="nginx.remotes">
<family name="reverse_proxy_" description="Reverse proxy " help="Paramètrage du proxy inverse" leadership="True">
<variable name="revprox_domainnames_" type="domainname" description="Nom des domaines auto-configurés dans le serveur mandataire inverse " multi="True" provider="ReverseProxy:external" hidden="True" mandatory="False"/>

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

@ -3,17 +3,18 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# nginx-static
## Synopsis
Nginx as static web site.
[Software's website.](https://nginx.org/)
[Nginx as static web site.](https://nginx.org/)
## Basic variables
### Général
### General
#### Reverse proxy
@ -28,12 +29,10 @@ This family is a leadership.
## Variables
### Général
### General
#### 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 |
@ -42,16 +41,14 @@ Paramétrage global de NGINX.
## Variables for expert
### Général
### General
#### 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 |
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The bucket size for the server names hash tables.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The maximum allowed size of the client request body.<br/>This value is in Mb.<br/>**Default:** 32 |
#### Reverse proxy
@ -65,9 +62,14 @@ This family is a leadership.
## Requirements services
- **LocalDNS**
- Journald
- **ReverseProxy**
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -100,5 +102,3 @@ nginx-static:
- [pki-tls](../pki-tls/README.md)
- [journald](../journald/README.md)
- [resolved](../resolved/README.md)
[All applications services for this dataset.](../README.md)

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

@ -3,19 +3,25 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# nsd-local
## Synopsis
NSD, an authoritative DNS name server for local resolution.
[Software's website.](https://www.nlnetlabs.nl/projects/nsd/about/)
[NSD, an authoritative DNS name server for local resolution.](https://www.nlnetlabs.nl/projects/nsd/about/)
## Requirements services
- **LocalDNS**
- Journald
- ExternalDNS
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
- ExternalDNS: [unbound](../unbound/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -28,6 +34,7 @@ nsd-local:
applicationservice: nsd-local
provider_zone: localdns
zones_name:
- externaldns
- localdns
```
@ -44,12 +51,28 @@ nsd-local:
- [journald](../journald/README.md)
- [resolved](../resolved/README.md)
## Supplier
## Useful for services
[dns-local](../dns-local/README.md)
## Provider
[unbound](../unbound/README.md)
[All applications services for this dataset.](../README.md)
- [dovecot](../dovecot/README.md): Postfix and Dovecot as mail servers (IMAP and submission).
- [forgejo](../forgejo/README.md): Forgejo, a community managed lightweight code hosting solution.
- [gitea](../gitea/README.md): Transitional package for Gitea to Forgejo.
- [grafana](../grafana/README.md): Grafana is an analytics and interactive visualization web application.
- [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-reverse-proxy](../nginx-reverse-proxy/README.md): Nginx as reverse proxy.
- [nginx-static](../nginx-static/README.md): Nginx as static web site.
- [nsd](../nsd/README.md): NSD, an authoritative DNS name server.
- [nsd-local](../nsd-local/README.md): NSD, an authoritative DNS name server for local resolution.
- [odoo](../odoo/README.md): Odoo, an ERP and CRM.
- [openldap](../openldap/README.md): OpenLDAP, the LDAP server.
- [piwigo](../piwigo/README.md): Piwigo, a photo management software.
- [postgresql](../postgresql/README.md): Postgresql, a database.
- [prometheus](../prometheus/README.md): Prometheus, an event monitoring.
- [redis](../redis/README.md): Redis, an in-memory data structure store.
- [roundcube](../roundcube/README.md): Roundcube, a webmail.
- [speedtest-rs](../speedtest-rs/README.md): Speedtest-rs, a very lightweight Speedtest.
- [vaultwarden](../vaultwarden/README.md): Vaultwarden, a password manager.
- [vector](../vector/README.md): Vector, a lightweight, ultra-fast tool for building observability pipelines.

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

@ -8,7 +8,7 @@
<variable name="nsd_dnssec_ds_" supplier="LocalDNS:DNSSEC_DS" hidden="True" multi="True"/>
</family>
<variable name="nsd_allowed_client_ip" type="ip" description="Clients" multi="True" hidden="True"/>
<variable name="nsd_resolver" redefine="True" supplier="ExternalDNS"/>
<variable name="nsd_resolver" redefine="True" supplier="ExternalDNS" hidden="True"/>
<variable name="nsd_resolve_ip" type="ip" hidden="True"/>
</family>
<family name="dns_zone">

18
seed/nsd/README.md
View file

@ -3,17 +3,18 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# nsd
## Synopsis
NSD, an authoritative DNS name server.
[Software's website.](https://www.nlnetlabs.nl/projects/nsd/about/)
[NSD, an authoritative DNS name server.](https://www.nlnetlabs.nl/projects/nsd/about/)
## Basic variables
### Général
### General
#### Serveur DNS
@ -61,8 +62,13 @@ This family is a leadership.
## Requirements services
- **LocalDNS**
- Journald
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -95,5 +101,3 @@ nsd:
## Used by
[nsd-local](../nsd-local/README.md)
[All applications services for this dataset.](../README.md)

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

@ -3,6 +3,8 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# oauth2-client
## Synopsis
@ -13,7 +15,7 @@ Application service needs interact with a Oauth2 server.
## Variables for expert
### Général
### General
#### OAuth2 client
@ -46,9 +48,3 @@ Application service needs interact with a Oauth2 server.
- [forgejo](../forgejo/README.md)
- [roundcube](../roundcube/README.md)
- [nextcloud](../nextcloud/README.md)
## Provider
[lemonldap](../lemonldap/README.md)
[All applications services for this dataset.](../README.md)

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

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

64
seed/odoo/README.md
View file

@ -3,17 +3,18 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# odoo
## Synopsis
Odoo, an ERP and CRM.
[Software's website.](https://www.odoo.com/fr)
[Odoo, an ERP and CRM.](https://www.odoo.com/fr)
## Basic variables
### Général
### General
#### Reverse proxy
@ -48,28 +49,22 @@ This family is a leadership.
## Variables for expert
### Général
### General
#### Annuaire OpenLDAP
#### OpenLDAP directory
##### 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* |
| 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) | Restrict service configuration for a LDAP family.<br/>"all" for all families. |
#### 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 |
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The bucket size for the server names hash tables.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The maximum allowed size of the client request body.<br/>This value is in Mb.<br/>**Default:** 32 |
#### Reverse proxy
@ -81,14 +76,6 @@ This family is a leadership.
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|
| **[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 |
@ -117,13 +104,18 @@ This family is a leadership.
## Requirements services
- **LocalDNS**
- Journald
- **SMTP**
- **LDAP**
- **ReverseProxy**
- **Postgresql**
- **OAuth2**
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
- SMTP: [postfix-relay](../postfix-relay/README.md)
- LDAP: [openldap](../openldap/README.md)
- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md)
- Postgresql: [postgresql](../postgresql/README.md)
- OAuth2: [lemonldap](../lemonldap/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -137,10 +129,10 @@ odoo:
zones_name:
- ldap
- localdns
- reverseproxy
- smtp
- oauth2
- postgresql
- reverseproxy
- smtp
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
@ -176,5 +168,3 @@ odoo:
- [nginx-https](../nginx-https/README.md)
- [nginx-common](../nginx-common/README.md)
- [reverse-proxy-client](../reverse-proxy-client/README.md)
[All applications services for this dataset.](../README.md)

28
seed/openldap/README.md
View file

@ -3,13 +3,14 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# openldap
## Synopsis
OpenLDAP, the LDAP server.
[Software's website.](https://www.openldap.org/)
[OpenLDAP, the LDAP server.](https://www.openldap.org/)
This service provides a LDAP server.
@ -22,7 +23,6 @@ initial password will be generated but never updated. You can modify them.
Other services may also require automatic user creation.
## Variables
### Accounts
@ -61,7 +61,7 @@ Management of manually created users. Those users are classified in a family. Th
## Variables for expert
### Général
### General
#### LDAP
@ -96,8 +96,13 @@ Management of manually created users. Those users are classified in a family. Th
## Requirements services
- **LocalDNS**
- Journald
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -125,8 +130,11 @@ openldap:
- [journald](../journald/README.md)
- [resolved](../resolved/README.md)
## Supplier
## Useful for services
[ldap-client](../ldap-client/README.md)
[All applications services for this dataset.](../README.md)
- [dovecot](../dovecot/README.md): Postfix and Dovecot as mail servers (IMAP and submission).
- [lemonldap](../lemonldap/README.md): LemonLDAP, a Web Single Sign On and Access Management.
- [nextcloud](../nextcloud/README.md): Nextcloud, Online collaboration platform.
- [odoo](../odoo/README.md): Odoo, an ERP and CRM.
- [piwigo](../piwigo/README.md): Piwigo, a photo management software.
- [roundcube](../roundcube/README.md): Roundcube, a webmail.

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

@ -1,7 +1,7 @@
<?xml version='1.0' encoding='UTF-8'?>
<rougail version="0.10">
<variables>
<variable name="remotes" description="Remote services with an account" type="domainname" multi="True" provider="LDAP"/>
<variable name="remotes" description="Remote services with an account" type="domainname" multi="True" provider="LDAP" hidden="True"/>
<family name="remote_" dynamic="accounts.remotes" hidden="True">
<variable name="family_" provider="LDAP:family"/>
<variable name="dn_" provider="LDAP:dn"/>

65
seed/peertube/README.md
View file

@ -3,17 +3,18 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# peertube
## Synopsis
Peertube, a federated (ActivityPub) video streaming platform.
[Software's website.](https://www.openldap.org/)
[Peertube, a federated (ActivityPub) video streaming platform.](https://www.openldap.org/)
## Basic variables
### Général
### General
#### Reverse proxy
@ -34,7 +35,7 @@ This family is a leadership.
## Variables
### Général
### General
#### peertube
@ -45,16 +46,14 @@ This family is a leadership.
## Variables for expert
### Général
### General
#### 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 |
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The bucket size for the server names hash tables.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The maximum allowed size of the client request body.<br/>This value is in Mb.<br/>**Default:** 32 |
#### Reverse proxy
@ -66,21 +65,6 @@ This family is a leadership.
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|
| **[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 |
@ -105,13 +89,18 @@ This family is a leadership.
## Requirements services
- **ExternalDNS**
- Journald
- **SMTP**
- **ReverseProxy**
- **Postgresql**
- **Redis**
- **OAuth2**
### Mandatories
- SMTP: [postfix-relay](../postfix-relay/README.md)
- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md)
- Postgresql: [postgresql](../postgresql/README.md)
- OAuth2: [lemonldap](../lemonldap/README.md)
- ExternalDNS: [unbound](../unbound/README.md)
- Redis: [redis](../redis/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -123,12 +112,12 @@ Zone names are provided as examples. Think about adapting with the value of prov
peertube:
applicationservice: peertube
zones_name:
- localdns
- reverseproxy
- smtp
- redis
- externaldns
- oauth2
- postgresql
- redis
- reverseproxy
- smtp
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
@ -156,5 +145,3 @@ peertube:
- [nginx-common](../nginx-common/README.md)
- [reverse-proxy-client](../reverse-proxy-client/README.md)
- [oauth2-client](../oauth2-client/README.md)
[All applications services for this dataset.](../README.md)

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

@ -3,6 +3,8 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# php-fpm
## Synopsis
@ -18,5 +20,3 @@ PHP FPM.
- [piwigo](../piwigo/README.md)
- [roundcube](../roundcube/README.md)
- [nextcloud](../nextcloud/README.md)
[All applications services for this dataset.](../README.md)

9
seed/php/README.md
View file

@ -3,19 +3,20 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# php
## Synopsis
PHP, a popular general-purpose scripting language.
[Software's website.](https://secure.php.net/)
[PHP, a popular general-purpose scripting language.](https://secure.php.net/)
## Variables for expert
### Général
### General
#### PHP
@ -38,5 +39,3 @@ Paramètrage avancé de PHP.
## Used by
[php-fpm](../php-fpm/README.md)
[All applications services for this dataset.](../README.md)

67
seed/piwigo/README.md
View file

@ -3,17 +3,18 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# piwigo
## Synopsis
Piwigo, a photo management software.
[Software's website.](http://piwigo.org/)
[Piwigo, a photo management software.](http://piwigo.org/)
## Basic variables
### Général
### General
#### Reverse proxy
@ -43,7 +44,7 @@ This family is a leadership.
## Variables
### Général
### General
#### Piwigo
@ -55,7 +56,7 @@ This family is a leadership.
## Variables for expert
### Général
### General
#### PHP
@ -77,24 +78,18 @@ Paramètrage avancé de PHP.
#### 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) | The bucket size for the server names hash tables.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The maximum allowed size of the client request body.<br/>This value is in Mb.<br/>**Default:** 32 |
| 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
#### OpenLDAP directory
##### 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* |
| 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) | Restrict service configuration for a LDAP family.<br/>"all" for all families. |
#### Reverse proxy
@ -106,13 +101,6 @@ This family is a leadership.
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|
| **[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 |
@ -137,14 +125,19 @@ This family is a leadership.
## Requirements services
- **LocalDNS**
- Journald
- **MariaDB**
- **SMTP**
- **LDAP**
- **ReverseProxy**
- **Redis**
- **OAuth2**
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
- SMTP: [postfix-relay](../postfix-relay/README.md)
- LDAP: [openldap](../openldap/README.md)
- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md)
- OAuth2: [lemonldap](../lemonldap/README.md)
- Redis: [redis](../redis/README.md)
- MariaDB: [mariadb](../mariadb/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -159,10 +152,10 @@ piwigo:
- ldap
- localdns
- mariadb
- oauth2
- redis
- reverseproxy
- smtp
- redis
- oauth2
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
@ -195,5 +188,3 @@ piwigo:
- [reverse-proxy-client](../reverse-proxy-client/README.md)
- [php-fpm](../php-fpm/README.md)
- [php](../php/README.md)
[All applications services for this dataset.](../README.md)

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

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

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

@ -3,20 +3,15 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# postfix-lmtp-relay
## Synopsis
Postfix, the mail server, as LMTP relay.
[Software's website.](http://www.postfix.org/)
[Postfix, the mail server, as LMTP relay.](http://www.postfix.org/)
## Used by
[postfix-relay](../postfix-relay/README.md)
## Supplier
[relay-lmtp-client](../relay-lmtp-client/README.md)
[All applications services for this dataset.](../README.md)

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

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="utf-8"?>
<rougail version="0.10">
<variables>
<variable name="server_lmtp" description="LMTP remote server" type="domainname" provider="LMTP" multi="True"/>
<family name="lmtp_" description="LMTP " dynamic="lmtp.server_lmtp">
<variable name="criteria_" description="transport criteria " type="string" multi="True" mandatory="True" hidden="True" provider="LMTP:criteria"/>
<variable name="server_lmtp" description="LMTP remote server" type="domainname" provider="LMTP" multi="True" hidden="True"/>
<family name="lmtp_" description="LMTP " dynamic="lmtp.server_lmtp" hidden="True">
<variable name="criteria_" type="string" multi="True" mandatory="True" provider="LMTP:criteria"/>
</family>
</variables>
<constraints>

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

@ -3,31 +3,40 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# postfix-relay
## Synopsis
Postfix, the mail server, as relay.
[Software's website.](http://www.postfix.org/)
[Postfix, the mail server, as relay.](http://www.postfix.org/)
The mail relay allows the various internal services to communicate with the other services.
It is also possible to receive from outside or send emails to the outside.
## Variables
## Basic variables
### Général
### General
#### Postfix mail server
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.postfix.postfix_mail_hostname](dictionaries/30_postfix.xml)**<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 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` |
| Parameter | Comments |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **[general.postfix.postfix_mail_hostname](dictionaries/30_postfix.xml)**<br/>**Type:** [`domainname`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | External email server domain name.<br/>This variable is mandatory if mail server needs to interact with external area. |
| **[general.postfix.postfix_crt_provider](dictionaries/30_postfix.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Autorité de certification signant le certificat du domaine extérieur.<br/>The certificate can be self-signed (therefore invalid by default for the client) or obtained via the Let's Encrypt service (generally valid for the client).<br/>**Choices:**<br/>- `self-signed` ← default<br/>- `letsencrypt` |
## Requirements services
- **ExternalDNS**
- Journald
### Mandatories
- ExternalDNS: [unbound](../unbound/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -40,7 +49,7 @@ postfix-relay:
applicationservice: postfix-relay
provider_zone: smtp
zones_name:
- localdns
- externaldns
```
## Dependances
@ -57,8 +66,16 @@ postfix-relay:
- [dns-external](../dns-external/README.md)
- [postfix-lmtp-relay](../postfix-lmtp-relay/README.md)
## Supplier
## Useful for services
[relay-mail-client](../relay-mail-client/README.md)
[All applications services for this dataset.](../README.md)
- [dovecot](../dovecot/README.md): Postfix and Dovecot as mail servers (IMAP and submission).
- [forgejo](../forgejo/README.md): Forgejo, a community managed lightweight code hosting solution.
- [gitea](../gitea/README.md): Transitional package for Gitea to Forgejo.
- [grafana](../grafana/README.md): Grafana is an analytics and interactive visualization web application.
- [lemonldap](../lemonldap/README.md): LemonLDAP, a Web Single Sign On and Access Management.
- [mailman](../mailman/README.md): GNU Mailman, managing electronic mail discussion and e-newsletter lists.
- [nextcloud](../nextcloud/README.md): Nextcloud, Online collaboration platform.
- [odoo](../odoo/README.md): Odoo, an ERP and CRM.
- [peertube](../peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform.
- [piwigo](../piwigo/README.md): Piwigo, a photo management software.
- [vaultwarden](../vaultwarden/README.md): Vaultwarden, a password manager.

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

@ -38,16 +38,16 @@
</family>
<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_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" mode="basic" help="The certificate can be self-signed (therefore invalid by default for the client) or obtained via the Let's Encrypt service (generally valid for the client)">
<value>self-signed</value>
<choice>self-signed</choice>
<choice>letsencrypt</choice>
</variable>
<variable name="postfix_relay_domains" type="domainname" description="Local LTMP domain" multi="True" hidden="True"/>
<variable name='postfix_relay_authentifications' description="Authentification sur le relai SMTP" multi="True" provider="SMTP"/>
<family name="local_authentification_" description="Local server authentification" dynamic='postfix_relay_authentifications'>
<variable name='postfix_relay_authentifications' multi="True" provider="SMTP" hidden="True"/>
<family name="local_authentification_" description="Local server authentification" dynamic='postfix_relay_authentifications' hidden="True">
<variable name="local_authentification_password_" type="secret" auto_save="False" provider="SMTP:password"/>
<variable name="postfix_relay_ip_" type="ip" hidden="True"/>
<variable name="postfix_relay_ip_" type="ip"/>
</family>
</family>
<family name="opendkim">

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

@ -3,27 +3,14 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# postgresql-client
## Synopsis
Application service needs interact with a Postgresql server.
[Software's website.](https://www.postgresql.org)
## 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* |
[Application service needs interact with a Postgresql server.](https://www.postgresql.org)
## Used by
@ -35,9 +22,3 @@ Application service needs interact with a Postgresql server.
- [roundcube](../roundcube/README.md)
- [vaultwarden](../vaultwarden/README.md)
- [nextcloud](../nextcloud/README.md)
## Provider
[postgresql](../postgresql/README.md)
[All applications services for this dataset.](../README.md)

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

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

40
seed/postgresql/README.md
View file

@ -3,18 +3,19 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# postgresql
## Synopsis
Postgresql, a database.
[Software's website.](https://www.postgresql.org)
[Postgresql, a database.](https://www.postgresql.org)
## Variables
### Général
### General
#### PostgreSQL
@ -39,21 +40,16 @@ Paramétrage du serveur de gestion de bases de données PostgreSQL.
| **[general.postgresql.pg_effective_cache_size](dictionaries/22_postgresql.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille du cache.<br/>Initialise l'estimation faite par le planificateur pour le nombre de bloc de 8ko réelle du cache disque disponible pour une requête.<br/>**Default:** 4 |
| **[general.postgresql.pg_effective_cache_size_unit](dictionaries/22_postgresql.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Unité de la taille du cache.<br/>**Choices:**<br/>- `MB`<br/>- `kB`<br/>- `GB` ← default |
### Accounts
#### Account for *suffix value*
This a dynamic family generated from the variable "accounts.remotes".
| Parameter | Comments |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------|
| **[accounts.remote_*suffix value*.remote_ip_*suffix value*](extras/accounts/00_accounts.xml)**<br/>mandatory<br/>**Type:** [`ip`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Remote IP .<br/>**Default:** *calculated* |
## Requirements services
- **LocalDNS**
- Journald
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -81,8 +77,14 @@ postgresql:
- [journald](../journald/README.md)
- [resolved](../resolved/README.md)
## Supplier
## Useful for services
[postgresql-client](../postgresql-client/README.md)
[All applications services for this dataset.](../README.md)
- [forgejo](../forgejo/README.md): 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.
- [mailman](../mailman/README.md): GNU Mailman, managing electronic mail discussion and e-newsletter lists.
- [nextcloud](../nextcloud/README.md): Nextcloud, Online collaboration platform.
- [odoo](../odoo/README.md): Odoo, an ERP and CRM.
- [peertube](../peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform.
- [roundcube](../roundcube/README.md): Roundcube, a webmail.
- [vaultwarden](../vaultwarden/README.md): Vaultwarden, a password manager.

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

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

20
seed/prometheus/README.md
View file

@ -3,18 +3,24 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# prometheus
## Synopsis
Prometheus, an event monitoring.
[Software's website.](https://prometheus.io/)
[Prometheus, an event monitoring.](https://prometheus.io/)
## Requirements services
- **LocalDNS**
- Journald
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -41,9 +47,3 @@ prometheus:
- [pki-tls](../pki-tls/README.md)
- [journald](../journald/README.md)
- [resolved](../resolved/README.md)
## Supplier
[host-systemd-machined](../host-systemd-machined/README.md)
[All applications services for this dataset.](../README.md)

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

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

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

@ -3,18 +3,19 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# provider-systemd-machined
## Synopsis
Machine started in Systemd Machined environment.
[Software's website.](https://www.freedesktop.org/wiki/Software/systemd/machined/)
[Machine started in Systemd Machined environment.](https://www.freedesktop.org/wiki/Software/systemd/machined/)
## Variables
### Général
### General
| Parameter | Comments |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
@ -28,7 +29,7 @@ Machine started in Systemd Machined environment.
## Variables for expert
### Général
### General
#### network
@ -45,9 +46,3 @@ Machine started in Systemd Machined environment.
- [pki-tls](../pki-tls/README.md)
- [journald](../journald/README.md)
- [resolved](../resolved/README.md)
## Provider
[host-systemd-machined](../host-systemd-machined/README.md)
[All applications services for this dataset.](../README.md)

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

@ -3,26 +3,14 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# redis-client
## Synopsis
Application service needs interact with a Redis server.
[Software's website.](https://redis.io/)
## 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* |
[Application service needs interact with a Redis server.](https://redis.io/)
## Dependances
@ -35,9 +23,3 @@ Application service needs interact with a Redis server.
- [forgejo](../forgejo/README.md)
- [roundcube](../roundcube/README.md)
- [nextcloud](../nextcloud/README.md)
## Provider
[redis](../redis/README.md)
[All applications services for this dataset.](../README.md)

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

@ -6,12 +6,12 @@
</service>
</services>
<variables>
<family name="redis" description="Redis">
<variable name="redis_client_server_domainname" type="domainname" description="Nom de domaine du serveur Redis" mandatory="True" supplier="Redis"/>
<variable name="redis_client_username" description="Nom d'utilisateur" mandatory="True" supplier="Redis:username"/>
<variable name="redis_client_password" type="password" description="Mot de passe de connexion" mandatory="True" supplier="Redis:password"/>
<variable name="redis_client_index" type="number" description="Redis index" mandatory='True' provider="Redis:index"/>
<variable name="redis_client_key_owner" type="unix_user" description="Key owner" mandatory="True" hidden="True">
<family name="redis" description="Redis" hidden="True">
<variable name="redis_client_server_domainname" type="domainname" mandatory="True" supplier="Redis"/>
<variable name="redis_client_username" mandatory="True" supplier="Redis:username"/>
<variable name="redis_client_password" type="password" mandatory="True" supplier="Redis:password"/>
<variable name="redis_client_index" type="number" mandatory='True' provider="Redis:index"/>
<variable name="redis_client_key_owner" type="unix_user" mandatory="True">
<value>apache</value>
</variable>
</family>

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

@ -3,17 +3,16 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# redis-common
## Synopsis
Redis, an in-memory data structure store.
[Software's website.](https://redis.io/)
[Redis, an in-memory data structure store.](https://redis.io/)
## Used by
- [redis](../redis/README.md)
- [redis-client](../redis-client/README.md)
[All applications services for this dataset.](../README.md)

27
seed/redis/README.md
View file

@ -3,18 +3,19 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# redis
## Synopsis
Redis, an in-memory data structure store.
[Software's website.](https://redis.io/)
[Redis, an in-memory data structure store.](https://redis.io/)
## Variables
### Général
### General
#### Redis
@ -42,8 +43,13 @@ This a dynamic family generated from the variable "accounts.remotes".
## Requirements services
- **LocalDNS**
- Journald
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -72,8 +78,11 @@ redis:
- [resolved](../resolved/README.md)
- [redis-common](../redis-common/README.md)
## Supplier
## Useful for services
[redis-client](../redis-client/README.md)
[All applications services for this dataset.](../README.md)
- [forgejo](../forgejo/README.md): Forgejo, a community managed lightweight code hosting solution.
- [gitea](../gitea/README.md): Transitional package for Gitea to Forgejo.
- [nextcloud](../nextcloud/README.md): Nextcloud, Online collaboration platform.
- [peertube](../peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform.
- [piwigo](../piwigo/README.md): Piwigo, a photo management software.
- [roundcube](../roundcube/README.md): Roundcube, a webmail.

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

@ -3,6 +3,8 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# relay-lmtp-client
## Synopsis
@ -17,9 +19,3 @@ Application service needs interact with a Postfix server with LMTP protocol.
- [mailman](../mailman/README.md)
- [dovecot](../dovecot/README.md)
## Provider
[postfix-lmtp-relay](../postfix-lmtp-relay/README.md)
[All applications services for this dataset.](../README.md)

2
seed/relay-lmtp-client/dictionaries/30_lmtp.xml
View file

@ -1,7 +1,7 @@
<?xml version='1.0' encoding='UTF-8'?>
<rougail version="0.10">
<variables>
<variable name="lmtp_relay_address" type="domainname" description="Nom de domaine du serveur LMTP" mandatory="True" supplier="LMTP"/>
<variable name="lmtp_relay_address" type="domainname" mandatory="True" supplier="LMTP" hidden="True"/>
</variables>
<constraints>
<fill name="calc_value">

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

@ -3,6 +3,8 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# relay-mail-client
## Synopsis
@ -20,9 +22,3 @@ Client SMTP.
- [relay-lmtp-client](../relay-lmtp-client/README.md)
- [nextcloud](../nextcloud/README.md)
- [lemonldap](../lemonldap/README.md)
## Provider
[postfix-relay](../postfix-relay/README.md)
[All applications services for this dataset.](../README.md)

6
seed/relay-mail-client/dictionaries/20_smtp_client.xml
View file

@ -7,11 +7,11 @@
</services>
<variables>
<family name="smtp" description="Client SMTP">
<variable name="smtp_relay_address" type="domainname" description="Nom de domaine du serveur SMTP" mandatory="True" supplier="SMTP"/>
<variable name="smtp_relay_address" type="domainname" mandatory="True" supplier="SMTP" hidden="True"/>
<variable name="smtp_relay_ip" type="ip" hidden="True"/>
<variable name="smtp_client_ip" type="ip" hidden="True" mandatory="True"/>
<variable name="smtp_relay_user" description="Relay username" mandatory="True" hidden="True"/>
<variable name="smtp_relay_password" type="secret" description="Relay password" mandatory="True" hidden="True" supplier="SMTP:password"/>
<variable name="smtp_relay_user" mandatory="True" hidden="True"/>
<variable name="smtp_relay_password" type="secret" mandatory="True" hidden="True" supplier="SMTP:password"/>
</family>
</variables>
<constraints>

7
seed/resolved/README.md
View file

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

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

@ -3,6 +3,8 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# reverse-proxy-client
## Synopsis
@ -11,7 +13,7 @@ Application service needs interact with a a reverse proxy server.
## Basic variables
### Général
### General
#### Reverse proxy
@ -27,7 +29,7 @@ This family is a leadership.
## Variables for expert
### Général
### General
#### Reverse proxy
@ -50,9 +52,3 @@ This family is a leadership.
- [nginx-https](../nginx-https/README.md)
- [vaultwarden](../vaultwarden/README.md)
- [apache](../apache/README.md)
## Provider
[nginx-reverse-proxy](../nginx-reverse-proxy/README.md)
[All applications services for this dataset.](../README.md)

76
seed/roundcube/README.md
View file

@ -3,17 +3,18 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# roundcube
## Synopsis
Roundcube, a webmail.
[Software's website.](https://roundcube.net/)
[Roundcube, a webmail.](https://roundcube.net/)
## Basic variables
### Général
### General
#### Interface web de consultation des courriels Roundcube
@ -28,7 +29,7 @@ This family is a leadership.
## Variables
### Général
### General
#### Interface web de consultation des courriels Roundcube
@ -42,7 +43,7 @@ This family is a leadership.
## Variables for expert
### Général
### General
#### PHP
@ -64,38 +65,10 @@ Paramètrage avancé de PHP.
#### 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* |
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| **[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`choice`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The bucket size for the server names hash tables.<br/>**Choices:**<br/>- `128` ← default<br/>- `64`<br/>- `32` |
| **[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)**<br/>mandatory<br/>**Type:** [`number`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | The maximum allowed size of the client request body.<br/>This value is in Mb.<br/>**Default:** 32 |
#### OAuth2 client
@ -121,14 +94,19 @@ Paramétrage global de NGINX.
## Requirements services
- **LocalDNS**
- Journald
- **IMAP**
- **LDAP**
- **ReverseProxy**
- **Postgresql**
- **Redis**
- **OAuth2**
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
- LDAP: [openldap](../openldap/README.md)
- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md)
- Postgresql: [postgresql](../postgresql/README.md)
- OAuth2: [lemonldap](../lemonldap/README.md)
- Redis: [redis](../redis/README.md)
- IMAP: [dovecot](../dovecot/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -140,13 +118,13 @@ Zone names are provided as examples. Think about adapting with the value of prov
roundcube:
applicationservice: roundcube
zones_name:
- imap
- ldap
- localdns
- reverseproxy
- imap
- redis
- oauth2
- postgresql
- redis
- reverseproxy
values:
general.roundcube.roundcube_domain.roundcube_domains:
- webmail.example.net
@ -176,5 +154,3 @@ roundcube:
- [php-fpm](../php-fpm/README.md)
- [php](../php/README.md)
- [ldap-client](../ldap-client/README.md)
[All applications services for this dataset.](../README.md)

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

@ -3,17 +3,18 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# speedtest-rs
## Synopsis
Speedtest-rs, a very lightweight Speedtest.
[Software's website.](https://cloud.silique.fr/gitea/Silique/speedtest-rs)
[Speedtest-rs, a very lightweight Speedtest.](https://cloud.silique.fr/gitea/Silique/speedtest-rs)
## Basic variables
### Général
### General
#### Reverse proxy
@ -29,7 +30,7 @@ This family is a leadership.
## Variables for expert
### Général
### General
#### Reverse proxy
@ -43,9 +44,14 @@ This family is a leadership.
## Requirements services
- **LocalDNS**
- Journald
- **ReverseProxy**
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -76,5 +82,3 @@ speedtest-rs:
- [journald](../journald/README.md)
- [resolved](../resolved/README.md)
- [reverse-proxy-client](../reverse-proxy-client/README.md)
[All applications services for this dataset.](../README.md)

7
seed/systemd/README.md
View file

@ -3,13 +3,14 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# systemd
## Synopsis
Systemd, a system and service manager.
[Software's website.](https://systemd.io/)
[Systemd, a system and service manager.](https://systemd.io/)
## Dependances
@ -25,5 +26,3 @@ Systemd, a system and service manager.
- [base-fedora](../base-fedora/README.md)
- [base-debian](../base-debian/README.md)
- [provider-systemd-machined](../provider-systemd-machined/README.md)
[All applications services for this dataset.](../README.md)

24
seed/unbound/README.md
View file

@ -3,17 +3,18 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# unbound
## Synopsis
Unbound, a validating, recursive, caching DNS resolver.
[Software's website.](https://www.nlnetlabs.nl/projects/unbound/about/)
[Unbound, a validating, recursive, caching DNS resolver.](https://www.nlnetlabs.nl/projects/unbound/about/)
## Basic variables
### Général
### General
#### Résolveur DNS
@ -25,8 +26,9 @@ Unbound, a validating, recursive, caching DNS resolver.
## Requirements services
- **ExternalDNS**
- Journald
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -38,8 +40,6 @@ Zone names are provided as examples. Think about adapting with the value of prov
unbound:
applicationservice: unbound
provider_zone: externaldns
zones_name:
- localdns
values:
general.dns_resolver.unbound_default_forwards:
- 9.9.9.9
@ -58,9 +58,9 @@ unbound:
- [journald](../journald/README.md)
- [resolved](../resolved/README.md)
## Suppliers
## Useful for services
- [dns-external](../dns-external/README.md)
- [nsd-local](../nsd-local/README.md)
[All applications services for this dataset.](../README.md)
- [nsd-local](../nsd-local/README.md): NSD, an authoritative DNS name server for local resolution.
- [peertube](../peertube/README.md): Peertube, a federated (ActivityPub) video streaming platform.
- [postfix-relay](../postfix-relay/README.md): Postfix, the mail server, as relay.
- [znc](../znc/README.md): ZNC, a bouncer IRC.

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

@ -17,7 +17,7 @@
</services>
<variables>
<family name="network">
<variable name="dns_client_address" redefine="True" disabled="True"/>
<variable name="dns_client_address" redefine="True" disabled="True" supplier=""/>
<variable name="ip_dns" redefine="True" remove_fill="True"/>
<variable name="outgoing_ports" redefine="True">
<value>udp:53</value>
@ -26,9 +26,9 @@
</family>
<family name='dns_resolver' description='Résolveur DNS'>
<family name="forward_zones" description="Serveur DNS faisant autorité sur une zone particulière" leadership="True" hidden="True">
<variable name="unbound_forward_address" description="Adresse du serveur faisant autorité" provider="ExternalDNS" multi="True"/>
<variable name="unbound_forward_zones" type="domainname" description="Nom de domaine de la zone" multi="True" provider="ExternalDNS: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_forward_address" provider="ExternalDNS" multi="True" hidden="True"/>
<variable name="unbound_forward_zones" type="domainname" multi="True" provider="ExternalDNS:authority_zones" hidden="True"/>
<variable name="unbound_forward_reverse_zones" type="domainname" multi="True" provider="ExternalDNS:reverse_authority_zones" hidden="True"/>
<variable name="unbound_allowed_client" type="ip" hidden="True"/>
</family>
<variable name="unbound_default_forwards" description="Serveur résolveur DNS par défaut" multi="True" mandatory="True" test="9.9.9.9"/>

41
seed/vaultwarden/README.md
View file

@ -3,17 +3,18 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# vaultwarden
## Synopsis
Vaultwarden, a password manager.
[Software's website.](https://github.com/dani-garcia/vaultwarden)
[Vaultwarden, a password manager.](https://github.com/dani-garcia/vaultwarden)
## Basic variables
### Général
### General
#### Vaultwarden
@ -24,7 +25,7 @@ Vaultwarden, a password manager.
## Variables
### Général
### General
#### Vaultwarden
@ -34,27 +35,19 @@ Vaultwarden, a password manager.
| **[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**
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
- SMTP: [postfix-relay](../postfix-relay/README.md)
- ReverseProxy: [nginx-reverse-proxy](../nginx-reverse-proxy/README.md)
- Postgresql: [postgresql](../postgresql/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -67,9 +60,9 @@ vaultwarden:
applicationservice: vaultwarden
zones_name:
- localdns
- postgresql
- reverseproxy
- smtp
- postgresql
values:
general.vaultwarden.vaultwarden_domainname: vault.example.net
general.vaultwarden.vaultwarden_admin_email: admin@example.net
@ -89,5 +82,3 @@ vaultwarden:
- [postgresql-client](../postgresql-client/README.md)
- [relay-mail-client](../relay-mail-client/README.md)
- [reverse-proxy-client](../reverse-proxy-client/README.md)
[All applications services for this dataset.](../README.md)

54
seed/vector/README.md
View file

@ -3,19 +3,25 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# vector
## Synopsis
Vector, a lightweight, ultra-fast tool for building observability pipelines.
[Software's website.](https://vector.dev/)
[Vector, a lightweight, ultra-fast tool for building observability pipelines.](https://vector.dev/)
## Requirements services
- **LocalDNS**
- Journald
- **Loki**
### Mandatories
- LocalDNS: [nsd-local](../nsd-local/README.md)
- Loki: [loki](../loki/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -26,7 +32,7 @@ Zone names are provided as examples. Think about adapting with the value of prov
```
vector:
applicationservice: vector
provider_zone: journald
provider_zone: vector
zones_name:
- localdns
- loki
@ -45,12 +51,32 @@ vector:
- [resolved](../resolved/README.md)
- [journald_remote](../journald_remote/README.md)
## Supplier
## Useful for services
[host-systemd-machined](../host-systemd-machined/README.md)
## Provider
[loki](../loki/README.md)
[All applications services for this dataset.](../README.md)
- [dovecot](../dovecot/README.md): Postfix and Dovecot as mail servers (IMAP and submission).
- [forgejo](../forgejo/README.md): Forgejo, a community managed lightweight code hosting solution.
- [gitea](../gitea/README.md): Transitional package for Gitea to Forgejo.
- [grafana](../grafana/README.md): Grafana is an analytics and interactive visualization web application.
- [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-reverse-proxy](../nginx-reverse-proxy/README.md): Nginx as reverse proxy.
- [nginx-static](../nginx-static/README.md): Nginx as static web site.
- [nsd](../nsd/README.md): NSD, an authoritative DNS name server.
- [nsd-local](../nsd-local/README.md): NSD, an authoritative DNS name server for local resolution.
- [odoo](../odoo/README.md): Odoo, an ERP and CRM.
- [openldap](../openldap/README.md): OpenLDAP, the LDAP server.
- [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.

6
seed/vector/dictionaries/20_vector.xml
View file

@ -9,11 +9,11 @@
</service>
</services>
<variables>
<family name="vector" description="loki">
<family name="vector" description="loki" hidden="True">
<variable name="client_addresses" type="domainname" provider="Vector" multi="True"/>
<variable name="listen_addresses" type="ip" hidden="True" multi="True" provider="Vector:address"/>
<variable name="listen_addresses" type="ip" multi="True" provider="Vector:address"/>
</family>
<family name="loki" description="loki">
<family name="loki" description="loki" hidden="True">
<variable name="server_domainname" type="domainname" supplier="Loki" mandatory="True"/>
</family>
</variables>

44
seed/znc/README.md
View file

@ -3,26 +3,28 @@ gitea: none
include_toc: true
---
[Return to the list of application services.](../README.md)
# znc
## Synopsis
ZNC, a bouncer IRC.
[Software's website.](https://wiki.znc.in/)
[ZNC, a bouncer IRC.](https://wiki.znc.in/)
## Basic variables
### Général
### General
#### 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 |
| 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.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/>The certificate can be self-signed (therefore invalid by default for the client) or obtained via the Let's Encrypt service (generally valid for the client).<br/>**Choices:**<br/>- `self-signed` ← default<br/>- `letsencrypt` |
| **[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
@ -34,23 +36,17 @@ This family is a leadership.
| **[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
### Mandatories
- ExternalDNS: [unbound](../unbound/README.md)
### Optionals
- Journald: [vector](../vector/README.md)
**bold**: provider is mandatory
@ -62,7 +58,7 @@ Zone names are provided as examples. Think about adapting with the value of prov
znc:
applicationservice: znc
zones_name:
- localdns
- externaldns
values:
general.znc.external_domain_name: irc.example.net
general.znc.user_name: jdoe
@ -89,5 +85,3 @@ znc:
- [journald](../journald/README.md)
- [resolved](../resolved/README.md)
- [dns-external](../dns-external/README.md)
[All applications services for this dataset.](../README.md)

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

@ -18,7 +18,7 @@
</family>
<family name="znc" description="IRC Bouncer ZNC">
<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" mode="basic" help="The certificate can be self-signed (therefore invalid by default for the client) or obtained via the Let's Encrypt service (generally valid for the client)">
<value>self-signed</value>
<choice>self-signed</choice>
<choice>letsencrypt</choice>