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

238 lines
21 KiB
Markdown
Raw Normal View History

docs for application services
2022-12-24 13:01:51 +01:00
---
gitea: none
include_toc: true
---
# piwigo
update doc
2023-08-02 09:26:54 +02:00
## Synopsis
docs for application services
2022-12-24 13:01:51 +01:00
Piwigo, a photo management software.
[For more informations](http://piwigo.org/)
update doc
2023-08-02 09:26:54 +02:00
## Basic variables
### Général (*general*)
#### Reverse proxy (*general.revprox*)
##### Point d'entrée des clients (*general.revprox.revprox_client*)
This a family is a leadership.
| Description | Type | Example | Supplier |
|----------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|---------------------|-----------------------|
| **Nom de domaine exterieur du serveur** (*[general.revprox.revprox_client.revprox_client_external_domainnames](dictionaries/21_revprox_client.xml)*) [+] | [domainname](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | service.example.net | ReverseProxy:external |
#### Piwigo (*general.piwigo*)
##### external (*general.oauth2_client.external*)
| Description | Type | Example |
|---------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|-------------------|
| **Adresse courriel de l'administrateur Piwigo** (*[general.piwigo.piwigo_admin_email](dictionaries/31_piwigo.xml)*) | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | admin@example.net |
##### Piwigo users (*general.piwigo.users*)
This a family is a leadership.
| Description | Type | Example |
|--------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|---------------------|
| **Utilisateur ayant un album** (*[general.piwigo.users.piwigo_users](dictionaries/31_piwigo.xml)*) [+] | [unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | jdoe |
| **Adresse courriel** (*[general.piwigo.users.piwigo_email](dictionaries/31_piwigo.xml)*) | [mail](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | johndoe@example.net |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Variables
### Général (*general*)
#### NGINX (*general.nginx*)
Paramétrage global de NGINX.
| Description | Type | Values |
|-------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|----------|
| *[**php_fpm_user**](dictionaries/25_nginx.xml)* | [unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | nginx |
| *[**php_fpm_installed**](dictionaries/20_phpfpm.xml)* | [boolean](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | True |
#### Annuaire OpenLDAP (*general.ldap*)
##### Client (*general.ldap.client*)
| Description | Type | Supplier | Values |
|------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|--------------|--------------|
| Nom de la famille LDAP (*[general.ldap.client.ldapclient_family](dictionaries/21_ldap-client.xml)*) | [unix_user](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | LDAP:family | |
| **Base DN de l'annuaire** (*[general.ldap.client.ldapclient_base_dn](dictionaries/21_ldap-client.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | LDAP:base_dn | <calculated> |
| **Base DN de l'annuaire des utilisateurs** (*[general.ldap.client.ldapclient_search_dn](dictionaries/21_ldap-client.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | <calculated> |
| **Base DN de l'annuaire des groupes** (*[general.ldap.client.ldapclient_group_dn](dictionaries/21_ldap-client.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | <calculated> |
| **Base DN de l'annuaire des utilisateurs n'appartenant à une famille** (*[general.ldap.client.ldapclient_user_dn](dictionaries/21_ldap-client.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | | <calculated> |
#### Reverse proxy (*general.revprox*)
##### Point d'entrée des clients (*general.revprox.revprox_client*)
This a family is a leadership.
| Description | Type | Supplier |
|-------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|----------------------------|
| **Nom de l'arborescence racine du site** (*[general.revprox.revprox_client.revprox_client_location](dictionaries/21_revprox_client.xml)*) | [filename](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | ReverseProxy:location |
| Taille maximum du corps (*[general.revprox.revprox_client.revprox_client_max_body_size](dictionaries/21_revprox_client.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | ReverseProxy:max_body_size |
#### Redis (*general.redis*)
| Description | Values | Supplier | Type |
|----------------------------------------------------------------------------------------------------|--------------|----------------|--------------------------------------------------------------------------------------------------------------------------|
| **Nom d'utilisateur** (*[general.redis.redis_client_username](dictionaries/23_redis.xml)*) | <calculated> | Redis:username | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **Mot de passe de connexion** (*[general.redis.redis_client_password](dictionaries/23_redis.xml)*) | <calculated> | Redis:password | [password](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
#### OAuth2 client (*general.oauth2_client*)
| Description | Values | Example | Supplier | Type |
|-----------------------------------------------------------------------------------------------------------------|-----------------------------|---------------------|--------------------|-----------------------------------------------------------------------------------------------------------------------------|
| **OAuth2 client name** (*[general.oauth2_client.oauth2_client_name](dictionaries/31_piwigo.xml)*) | Album | example | OAuth2:name | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **OAuth2 client description** (*[general.oauth2_client.oauth2_client_description](dictionaries/31_piwigo.xml)*) | Album photographique Piwigo | Example description | OAuth2:description | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| OAuth2 URL to valid login (*[general.oauth2_client.oauth2_client_login](dictionaries/30_oauth2_client.xml)*) | | | OAuth2:login | [web_address](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **OAuth2 category** (*[general.oauth2_client.oauth2_client_category](dictionaries/31_piwigo.xml)*) | Diffusion | | OAuth2:category | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
| **OAuth2 logo** (*[general.oauth2_client.oauth2_client_logo](dictionaries/31_piwigo.xml)*) | silique_image.png | | OAuth2:logo | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) |
##### external (*general.oauth2_client.external*)
| Description | Type | Values | Supplier |
|-------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|--------------|-----------------|
| **OAuth2 client external** (*[general.oauth2_client.external.oauth2_client_external](dictionaries/30_oauth2_client.xml)*) [+] | [web_address](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | <calculated> | OAuth2:external |
| **OAuth2 family** (*[general.oauth2_client.external.oauth2_client_family](dictionaries/30_oauth2_client.xml)*) | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | users | OAuth2:family |
#### Piwigo (*general.piwigo*)
| Description | Values |
|------------------------------------------------------------------------------------|----------------------|
| **Titre de l'album** (*[general.piwigo.piwigo_title](dictionaries/31_piwigo.xml)*) | Album photographique |
- [+]: variable is multiple
- **bold**: variable is mandatory
## Variables for expert
### Général (*general*)
#### PHP (*general.php*)
Paramètrage avancé de PHP.
| Description | Help | Type | Values |
|-----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|--------------|
| **Taille maximale des données reçues par la méthode POST** (*[general.php.php_post_max_size](dictionaries/20_php.xml)*) | Valeur en Mo | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 32 |
| **Taille maximale d'un fichier à charger** (*[general.php.php_upload_max_filesize](dictionaries/20_php.xml)*) | Valeur en Mo | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 16 |
| **Temps maximal d'exécution d'un script** (*[general.php.php_max_execution_time](dictionaries/20_php.xml)*) | Valeur en secondes | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 30 |
| **Durée maximale pour analyser les données d'entrée** (*[general.php.php_max_input_time](dictionaries/20_php.xml)*) | Valeur en secondes | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 60 |
| **Taille mémoire maximale qu'un script est autorisé à allouer** (*[general.php.php_memory_limit](dictionaries/20_php.xml)*) | Valeur en Mo | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 512 |
| **Affichage des erreurs à l'écran** (*[general.php.php_display_errors](dictionaries/20_php.xml)*) | | [boolean](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | False |
| **Durée de vie des données sur le serveur** (*[general.php.php_session_gc_maxlifetime](dictionaries/20_php.xml)*) | Valeur en secondes | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 3600 |
| **Activer la directive de configuration browscap** (*[general.php.php_browscap](dictionaries/20_php.xml)*) | La directive de configuration browscap permet d'obtenir plus d'information sur les capacités du navigateur client grâce à la fonction get_browser() | [boolean](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | False |
| **Fuseau horaire** (*[general.php.time_zone](dictionaries/20_php.xml)*) | | [string](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Europe/Paris |
| **Activer les tampons de sortie** (*[general.php.php_enable_output_buffering](dictionaries/20_php.xml)*) | | [boolean](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | True |
| **Désactiver PCNTL** (*[general.php.php_disable_pcntl](dictionaries/20_php.xml)*) | | [boolean](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | True |
#### NGINX (*general.nginx*)
Paramétrage global de NGINX.
| Description | Type | Values | Choices |
|---------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|----------|---------------------|
| **Longueur maximum pour un nom de domaine** (*[general.nginx.nginx_hash_bucket_size](dictionaries/21_nginx.xml)*) | [choice](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 128 | 128<br />64<br />32 |
| **Taille maximale des données reçues par la méthode POST (en Mo)** (*[general.nginx.nginx_post_max_size](dictionaries/21_nginx.xml)*) | [number](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | 32 | |
- [+]: variable is multiple
- **bold**: variable is mandatory
update doc
2023-08-01 15:13:17 +02:00
## Examples
Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.
With minimum providers:
```
piwigo:
applicationservice: piwigo
zones_name:
- ldap
- localdns
- mariadb
- reverseproxy
- smtp
- redis
- oauth2
update doc
2023-08-02 09:26:54 +02:00
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
general.piwigo.piwigo_admin_email: admin@example.net
general.piwigo.users.piwigo_users:
- jdoe
general.piwigo.users.piwigo_email:
'0': johndoe@example.net
update doc
2023-08-01 15:13:17 +02:00
```
With all providers:
```
piwigo:
applicationservice: piwigo
zones_name:
- journald
- ldap
- localdns
- mariadb
- reverseproxy
- smtp
- redis
- oauth2
update doc
2023-08-02 09:26:54 +02:00
values:
general.revprox.revprox_client.revprox_client_external_domainnames:
- service.example.net
general.piwigo.piwigo_admin_email: admin@example.net
general.piwigo.users.piwigo_users:
- jdoe
general.piwigo.users.piwigo_email:
'0': johndoe@example.net
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
- [mariadb-client](../mariadb-client/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
- [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)
- [relay-mail-client](../relay-mail-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)
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