Référence du thème de connexion
Structure attendue, limites, nommage des versions, états, délais et messages d'erreur à l'import d'un thème de connexion.
RéférenceDéveloppeur
Valeurs de référence pour préparer et suivre un thème de connexion Keycloak.
Sources acceptées
| Source | Emplacement du thème | Particularités |
|---|---|---|
| Dépôt GitHub | dossier keycloak-theme/ à la racine du dépôt, ou sous le root directory de la définition de service | provenance enregistrée : dépôt, branche, commit résolu |
Fichier .jar | dossier theme/<nom>/ à la racine de l'archive, un seul thème | le nom du dossier est remplacé par le nom de version |
Limites
| Élément | Valeur |
|---|---|
| Taille de l'archive | 50 Mo |
| Taille décompressée | 50 Mo |
| Nombre d'entrées | 5 000 |
| Types reconnus | login, email, account, admin, welcome (au moins un) |
| Compression | stored ou deflate, sans chiffrement |
parent= / import= | ne doivent pas citer le thème lui-même |
Nom de version
<slug>-<WID>-<empreinte> : slug du nom de l'application (20 caractères au plus), WID de l'application, 8 caractères d'empreinte du contenu. Exemple : clinique-exemple-EXAPP1-a3f9c1d2.
États par environnement
Les états se lisent environnement par environnement, après avoir choisi l'environnement dans la section Thème Keycloak. La liste Thèmes de l'app ne montre que la bibliothèque de cet environnement.
| État | Signification |
|---|---|
| Appliqué | version servie par Keycloak |
| Publication en cours | application en cours, 1 à 3 minutes |
| Disponible | version déposée sur l'environnement, non appliquée |
| Non publiée | version absente de l'environnement |
| État inconnu | Keycloak injoignable |
Délais
| Élément | Valeur |
|---|---|
| Publication avec redémarrage de Keycloak | 1 à 3 minutes en général |
| Vérifications avant de déclarer le thème chargé | 3 consécutives, espacées d'au moins 10 secondes |
| Durée jugée normale / longue / bloquée | < 5 min / 5 à 15 min / > 15 min |
| Versions conservées | celles en service, plus les 2 plus récentes, dans la bibliothèque de chaque environnement |
Messages d'erreur à l'import
| Message | Cause |
|---|---|
| « Structure invalide : dossier 'theme/' absent à la racine du JAR. » | le .jar n'a pas de dossier theme/ à sa racine |
| « Le JAR doit contenir un seul thème ; N trouvés : … » | plusieurs dossiers sous theme/ |
| « Aucun type de thème reconnu sous theme/… » | aucun sous-dossier login, email, account, admin ou welcome |
| « Aucun type de thème reconnu sous keycloak-theme/ (attendus : login, email, account, admin, welcome). » | idem, pour un import depuis un dépôt |
| « theme.properties référence le thème renommé ; utiliser 'base' ou 'keycloak'. » | parent= ou import= cite le thème lui-même |
| « Archive illisible : le fichier n'est pas un JAR valide. » | fichier corrompu ou qui n'est pas une archive ZIP |
| « Entrée chiffrée non supportée : … » | archive protégée par mot de passe |
| « Archive refusée : plus de 5000 entrées. » | trop de fichiers |
| « Le JAR dépasse la taille maximale autorisée (50 Mo). » | archive trop lourde |
| « Non importable : seul GitHub est pris en charge. » | le dépôt est hébergé ailleurs que sur GitHub |
| « Cette version n'existe pas dans la bibliothèque … : téléversez-la d'abord dans cet environnement. » | la version n'a pas été ajoutée dans la bibliothèque de l'environnement où elle doit être appliquée |