dataset/seed/piwigo/README.md
2023-08-29 10:37:29 +02:00

18 KiB

Table of Contents

Return to the list of application services.

piwigo

Synopsis

Piwigo, a photo management software.

Example

Zone names are provided as examples. Think about adapting with the value of provider_zone in configuration file.

piwigo:
  applicationservice: piwigo
  zones_name:
    - ldap
    - localdns
    - mariadb
    - oauth2
    - redis
    - reverseproxy
    - smtp
  values:
    general.revprox.revprox_client.revprox_client_external_domainnames:
      - service.example.net
    general.piwigo.piwigo_admin_email: admin@example.net
    general.piwigo.users.piwigo_users:
      - jdoe
    general.piwigo.users.piwigo_email:
      '0': johndoe@example.net

Basic variables

General

Reverse proxy

Clients configuration

This family is a leadership.

Parameter Comment
general.revprox.revprox_client.revprox_client_external_domainnames
mandatory, multiple
Type: domainname
Service external domain name.
Example: service.example.net
general.revprox.revprox_client.revprox_client_location
mandatory
Type: filename
URI to route request to the correct service.
Default: /

Piwigo

Parameter Comment
general.piwigo.piwigo_admin_email
mandatory
Type: mail
Adresse courriel de l'administrateur Piwigo.
Example: admin@example.net
Piwigo users

This family is a leadership.

Parameter Comments
general.piwigo.users.piwigo_users
mandatory, multiple
Type: unix_user
Utilisateur ayant un album.
Example: jdoe
general.piwigo.users.piwigo_email
mandatory
Type: mail
Adresse courriel.
Example: johndoe@example.net

Variables

General

OpenLDAP directory

Client
Parameter Comment
general.ldap.client.ldapclient_family
Type: unix_user
Restrict service configuration for a LDAP family.
"all" for all families.

Reverse proxy

Clients configuration

This family is a leadership.

Parameter Comment
general.revprox.revprox_client.revprox_client_max_body_size
Type: string
The maximum allowed size of the client request body.

OAuth2 client

Parameter Comment
general.oauth2_client.oauth2_client_name
mandatory
Type: string
OAuth2 client name.
Default: Album
Example: example
general.oauth2_client.oauth2_client_description
mandatory
Type: string
OAuth2 client description.
Default: Album photographique Piwigo
Example: Example description
general.oauth2_client.oauth2_client_login
Type: web_address
OAuth2 URL to valid login.
external
Parameter Comments
general.oauth2_client.external.oauth2_client_external
mandatory, multiple
Type: web_address
OAuth2 client external.
Default: calculated
general.oauth2_client.external.oauth2_client_family
mandatory
Type: string
OAuth2 family.
Default: users
Parameter Comment
general.oauth2_client.oauth2_client_category
mandatory
Type: string
OAuth2 category.
Default: Diffusion
general.oauth2_client.oauth2_client_logo
mandatory
Type: string
OAuth2 logo.
Default: silique_image.png

Piwigo

Parameter Comment
general.piwigo.piwigo_title
mandatory
Type: string
Titre de l'album.
Default: Album photographique

Variables for expert

General

PHP

Paramètrage avancé de PHP.

Parameter Comment
general.php.php_post_max_size
mandatory
Type: number
Maximum size of POST data that PHP will accept.
Value in Mb.
Default: 32
general.php.php_upload_max_filesize
mandatory
Type: number
Maximum allowed size for uploaded files.
Value in Mb.
Default: 16
general.php.php_max_execution_time
mandatory
Type: number
Maximum amount of time each script may spend parsing request data.
Value in seconds.
Default: 30
general.php.php_max_input_time
mandatory
Type: number
Maximum amount of time each script may spend parsing request data.
Value in seconds.
Default: 60
general.php.php_memory_limit
mandatory
Type: number
Maximum amount of memory a script may consume.
Value in Mb.
Default: 512
general.php.php_session_gc_maxlifetime
mandatory
Type: number
Data will be seen as 'garbage' and potentially cleaned up after this delay.
Value in seconds.
Default: 3600

NGINX

Parameter Comment
general.nginx.nginx_hash_bucket_size
mandatory
Type: choice
The bucket size for the server names hash tables.
Choices:
- 128 ← default
- 64
- 32
general.nginx.nginx_post_max_size
mandatory
Type: number
The maximum allowed size of the client request body.
This value is in Mb.
Default: 32

Requirements services

Mandatories

  • LocalDNS: DNS forwarder for local domain name.
  • SMTP: Create a SMTP relay account and authorize sending email.
  • LDAP: Create account and connexion to a LDAP server.
  • ReverseProxy: Register to service to a reverse proxy server.
  • OAuth2: Remote clients needing to verify OAuth2 account.
  • Redis: Create account and connexion to a Redis server.
  • MariaDB: Create account and connexion to a MariaDB server.

Optionals

  • Journald: Concentrate journal messages on one host.

Dependances