stove/dataset
3
0
Fork 1
Code Issues 2 Pull requests Projects Releases Wiki Activity
dataset/seed/roundcube/README.md

171 lines
18 KiB
Markdown
Raw Normal View History

docs for application services
2022-12-24 13:01:51 +01:00
---
gitea: none
include_toc: true
---
# roundcube
update doc
2023-08-02 09:26:54 +02:00
## Synopsis
docs for application services
2022-12-24 13:01:51 +01:00
Roundcube, a webmail.
[For more informations](https://roundcube.net/)
update doc
2023-08-02 09:26:54 +02:00
## Basic variables
update doc
2023-08-01 15:13:17 +02:00
update doc
2023-08-02 09:26:54 +02:00
### Général
update doc
2023-08-01 15:13:17 +02:00
update doc
2023-08-02 09:26:54 +02:00
#### Interface web de consultation des courriels Roundcube
update doc
2023-08-01 15:13:17 +02:00
update doc
2023-08-02 09:26:54 +02:00
##### roundcube_domain
This a family is a leadership.
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------|
| *[general.roundcube.roundcube_domain.roundcube_domains](dictionaries/31_roundcube.xml)*<br/>mandatory,multiple<br/>[domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de domaines d'accès à Roundcube.<br/>**Example:** webmail.example.net |
| *[general.roundcube.roundcube_domain.roundcube_mail_domain](dictionaries/31_roundcube.xml)*<br/>mandatory<br/>[domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de domaines des courriels.<br/>**Example:** mail.example.net |
## Variables
### Général
#### Interface web de consultation des courriels Roundcube
##### roundcube_domain
This a family is a leadership.
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
| *[general.roundcube.roundcube_domain.roundcube_family](dictionaries/31_roundcube.xml)*<br/>[unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de la famille. |
## Variables for expert
### Général
#### PHP
Paramètrage avancé de PHP.
| Parameter | Comments |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *[general.php.php_post_max_size](dictionaries/20_php.xml)*<br/>mandatory<br/>[number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximale des données reçues par la méthode POST.<br/>Valeur en Mo.<br/>**Default:** 32 |
| *[general.php.php_upload_max_filesize](dictionaries/20_php.xml)*<br/>mandatory<br/>[number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille maximale d'un fichier à charger.<br/>Valeur en Mo.<br/>**Default:** 16 |
| *[general.php.php_max_execution_time](dictionaries/20_php.xml)*<br/>mandatory<br/>[number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Temps maximal d'exécution d'un script.<br/>Valeur en secondes.<br/>**Default:** 30 |
| *[general.php.php_max_input_time](dictionaries/20_php.xml)*<br/>mandatory<br/>[number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Durée maximale pour analyser les données d'entrée.<br/>Valeur en secondes.<br/>**Default:** 60 |
| *[general.php.php_memory_limit](dictionaries/20_php.xml)*<br/>mandatory<br/>[number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Taille mémoire maximale qu'un script est autorisé à allouer.<br/>Valeur en Mo.<br/>**Default:** 512 |
| *[general.php.php_display_errors](dictionaries/20_php.xml)*<br/>mandatory<br/>[boolean](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Affichage des erreurs à l'écran. |
| *[general.php.php_session_gc_maxlifetime](dictionaries/20_php.xml)*<br/>mandatory<br/>[number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Durée de vie des données sur le serveur.<br/>Valeur en secondes.<br/>**Default:** 3600 |
| *[general.php.php_browscap](dictionaries/20_php.xml)*<br/>mandatory<br/>[boolean](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Activer la directive de configuration browscap.<br/>La directive de configuration browscap permet d'obtenir plus d'information sur les capacités du navigateur client grâce à la fonction get_browser(). |
| *[general.php.time_zone](dictionaries/20_php.xml)*<br/>mandatory<br/>[string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Fuseau horaire.<br/>**Default:** Europe/Paris |
| *[general.php.php_enable_output_buffering](dictionaries/20_php.xml)*<br/>mandatory<br/>[boolean](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Activer les tampons de sortie.<br/>**Default:** True |
| *[general.php.php_disable_pcntl](dictionaries/20_php.xml)*<br/>mandatory<br/>[boolean](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Désactiver PCNTL.<br/>**Default:** True |
#### NGINX
Paramétrage global de NGINX.
| Parameter | Comments |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| *[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)*<br/>mandatory<br/>[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/>[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/>[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/>[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/>[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/>[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/>[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/>[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/>[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/>[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/>[password](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Mot de passe de connexion.<br/>**Default:** *calculated* |
#### OAuth2 client
| Parameter | Comments |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|
| *[general.oauth2_client.oauth2_client_name](dictionaries/31_roundcube.xml)*<br/>mandatory<br/>[string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client name.<br/>**Default:** Courriel<br/>**Example:** example |
| *[general.oauth2_client.oauth2_client_description](dictionaries/31_roundcube.xml)*<br/>mandatory<br/>[string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client description.<br/>**Default:** Consulter ces courriels avec Roundcube<br/>**Example:** Example description |
| *[general.oauth2_client.oauth2_client_login](dictionaries/30_oauth2_client.xml)*<br/>[web_address](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 URL to valid login. |
##### external
| Parameter | Comments |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|
| *[general.oauth2_client.external.oauth2_client_external](dictionaries/31_roundcube.xml)*<br/>mandatory,multiple<br/>[web_address](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 client external.<br/>**Default:** *calculated* |
| *[general.oauth2_client.external.oauth2_client_family](dictionaries/31_roundcube.xml)*<br/>multiple<br/>[string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 family.<br/>**Default:** *calculated* |
| *[general.oauth2_client.oauth2_client_category](dictionaries/31_roundcube.xml)*<br/>mandatory<br/>[string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 category.<br/>**Default:** Diffusion |
| *[general.oauth2_client.oauth2_client_logo](dictionaries/31_roundcube.xml)*<br/>mandatory<br/>[string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | OAuth2 logo.<br/>**Default:** silique_email.png |
## Requirements services
- **LocalDNS**
- Journald
- **IMAP**
- **LDAP**
- **ReverseProxy**
- **Postgresql**
- **Redis**
- **OAuth2**
**bold**: provider is mandatory
## Example
update doc
2023-08-01 15:13:17 +02:00
update doc
2023-08-02 09:26:54 +02:00
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
update doc
2023-08-01 15:13:17 +02:00
```
roundcube:
applicationservice: roundcube
zones_name:
- ldap
- localdns
- reverseproxy
- imap
- redis
- oauth2
- postgresql
update doc
2023-08-02 09:26:54 +02:00
values:
general.roundcube.roundcube_domain.roundcube_domains:
- webmail.example.net
general.roundcube.roundcube_domain.roundcube_mail_domain:
'0': mail.example.net
update doc
2023-08-01 15:13:17 +02:00
```
docs for application services
2022-12-24 13:01:51 +01:00
## Dependances
- [base-fedora-36](../base-fedora-36/README.md)
- [base-fedora](../base-fedora/README.md)
- [systemd](../systemd/README.md)
- [base-machine](../base-machine/README.md)
- [base](../base/README.md)
- [dns-local](../dns-local/README.md)
TLS
2023-02-14 14:24:16 +01:00
- [pki-tls](../pki-tls/README.md)
doc: update README files
2023-06-29 18:56:46 +02:00
- [journald](../journald/README.md)
update doc
2023-07-31 18:41:59 +02:00
- [resolved](../resolved/README.md)
docs for application services
2022-12-24 13:01:51 +01:00
- [postgresql-client](../postgresql-client/README.md)
- [imap-client](../imap-client/README.md)
- [redis-client](../redis-client/README.md)
doc: update README files
2023-06-29 18:56:46 +02:00
- [redis-common](../redis-common/README.md)
docs for application services
2022-12-24 13:01:51 +01:00
- [oauth2-client](../oauth2-client/README.md)
- [nginx-https](../nginx-https/README.md)
- [nginx-common](../nginx-common/README.md)
- [reverse-proxy-client](../reverse-proxy-client/README.md)
- [php-fpm](../php-fpm/README.md)
- [php](../php/README.md)
merge ldap-client-fedora and ldap-client-debian into ldap-client
2022-12-25 20:23:58 +01:00
- [ldap-client](../ldap-client/README.md)
docs for application services
2022-12-24 13:01:51 +01:00
used by external dataset
2023-02-14 14:43:41 +01:00
[All applications services for this dataset.](../README.md)
Reference in a new issue Copy permalink