Version sous forme de variable + fichier definition.yml specifique pour openid devient optionnel

This commit is contained in:
Navas 2023-07-30 19:15:48 +02:00
parent 34323d3298
commit 27c7a7d48b
4 changed files with 49 additions and 14 deletions

View file

@ -14,25 +14,28 @@ Fournir les variables suivantes. Par exemple :
docker_wikijs_fqdn: wiki.libretic.fr docker_wikijs_fqdn: wiki.libretic.fr
docker_wikijs_data_dir: /data1 docker_wikijs_data_dir: /data1
docker_wikijs_service_id: wikijs docker_wikijs_service_id: wikijs
docker_wikijs_version: 2.5.299
docker_wikijs_db_name: wikijs docker_wikijs_db_name: wikijs
docker_wikijs_db_user: wikijsdbuser docker_wikijs_db_user: wikijsdbuser
docker_wikijs_db_password: mdp_de_wikijsdbuser docker_wikijs_db_password: mdp_de_wikijsdbuser
``` ```
| Option | Valeur par défaut | Description | | Option | Valeur par défaut | Description |
|--------------------------------|-------------------|-------------------------------------------------------------------------------------------| |---------------------------------|-------------------|-------------------------------------------------------------------------------------------|
| docker_wikijs_fqdn | | Le nom de domaine pour lequel le service wikijs répond | | docker_wikijs_fqdn | | Le nom de domaine pour lequel le service wikijs répond |
| docker_wikijs_data_dir | | L'emplacement dans lequel se trouvent les volumes de donnees docker pour le service | | docker_wikijs_data_dir | | L'emplacement dans lequel se trouvent les volumes de donnees docker pour le service |
| docker_wikijs_service_id | | Le nom de service souhaité : conditionne le nommage des volumes et le routage par traefik | | docker_wikijs_service_id | | Le nom de service souhaité : conditionne le nommage des volumes et le routage par traefik |
| docker_wikijs_version | | Version de wikijs souhaitée |
| docker_wikijs_db_name | | Nom de la base de données postgres pour wikijs | | docker_wikijs_db_name | | Nom de la base de données postgres pour wikijs |
| docker_wikijs_db_user | | Nom du user postgres propriétaire de la base de données | | docker_wikijs_db_user | | Nom du user postgres propriétaire de la base de données |
| docker_wikijs_db_password | | Mot du passe du user postgres | | docker_wikijs_db_password | | Mot du passe du user postgres |
| docker_wikijs_custom_definition | | Applique une version specifique du fichier definition.yml pour openid connect |
## Fichier definition.yml ## Fichier definition.yml
Le fichier definition.yml d'origine de wikijs est remplacé afin de modifier le nom des scopes openid. Surveiller les nouvelles versions de ce fichier dans les futures images et le corriger le cas échéant. Si docker_wikijs_custom_definition est true, le fichier definition.yml d'origine de wikijs est remplacé afin de modifier le nom des scopes openid. Surveiller les nouvelles versions de ce fichier dans les futures images et le corriger le cas échéant.
``` ```
scopes: scopes:

View file

@ -0,0 +1 @@
docker_wikijs_custom_definition: false

View file

@ -36,20 +36,46 @@ props:
title: User Info Endpoint URL title: User Info Endpoint URL
hint: User Info Endpoint URL hint: User Info Endpoint URL
order: 5 order: 5
skipUserProfile:
type: Boolean
default: false
title: Skip User Profile
hint: Skips call to the OIDC UserInfo endpoint
order: 6
issuer: issuer:
type: String type: String
title: Issuer title: Issuer
hint: Issuer URL hint: Issuer URL
order: 6 order: 7
emailClaim: emailClaim:
type: String type: String
title: Email Claim title: Email Claim
hint: Field containing the email address hint: Field containing the email address
default: email default: email
maxWidth: 500 maxWidth: 500
order: 7 order: 8
displayNameClaim:
type: String
title: Display Name Claim
hint: Field containing the user display name
default: displayName
maxWidth: 500
order: 9
mapGroups:
type: Boolean
title: Map Groups
hint: Map groups matching names from the groups claim value
default: false
order: 10
groupsClaim:
type: String
title: Groups Claim
hint: Field containing the group names
default: groups
maxWidth: 500
order: 11
logoutURL: logoutURL:
type: String type: String
title: Logout URL title: Logout URL
hint: (optional) Logout URL on the OAuth2 provider where the user will be redirected to complete the logout process. hint: (optional) Logout URL on the OAuth2 provider where the user will be redirected to complete the logout process.
order: 8 order: 12

View file

@ -10,6 +10,8 @@ services:
POSTGRES_PASSWORD: {{ docker_wikijs_db_password }} POSTGRES_PASSWORD: {{ docker_wikijs_db_password }}
POSTGRES_USER: {{ docker_wikijs_db_user }} POSTGRES_USER: {{ docker_wikijs_db_user }}
TZ: Europe/Paris TZ: Europe/Paris
healthcheck:
test: ['CMD', 'pg_isready', '-U', 'postgres']
logging: logging:
driver: "none" driver: "none"
restart: unless-stopped restart: unless-stopped
@ -21,13 +23,16 @@ services:
- wikijs - wikijs
wiki: wiki:
image: ghcr.io/requarks/wiki:2.5.277 image: requarks/wiki:{{ docker_wikijs_version }}
volumes: volumes:
{%- if docker_wikijs_custom_definition +%}
- ./definition.yml:/wiki/server/modules/authentication/oidc/definition.yml - ./definition.yml:/wiki/server/modules/authentication/oidc/definition.yml
{%- endif +%}
- /etc/timezone:/etc/timezone:ro - /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro - /etc/localtime:/etc/localtime:ro
depends_on: depends_on:
- db db:
condition: service_healthy
environment: environment:
DB_TYPE: postgres DB_TYPE: postgres
DB_HOST: db DB_HOST: db