Skip to main content

Réglages complets de config.yaml

Tous les paramètres expliqués

1. Paramètres requis

  • immich_api_key : « clé API » du serveur Immich.

  • immich_url : URL de ton serveur Immich, ex : "http://192.168.1.10:2283".

Remarque : seules ces deux valeurs sont absolument obligatoires pour que le Kiosk fonctionne. Immich Kiosk

2. Horloge / Date

Paramètre Valeur par défaut Description
show_time false Afficher l’heure à l’écran
time_format 24 Format 12 ou 24 heures
show_date false Afficher la date
date_format YYYY/MM/DD Format de la date
clock_source client Source de l’heure : client ou autre

3. Comportement du Kiosk (Kiosk behaviour)

Paramètre Valeur Description
duration 60 Temps d’affichage de chaque image (secondes)
disable_screensaver false Empêcher l’écran de s’éteindre ou de se mettre en veille
optimize_images false Redimensionner les images pour correspondre à l’écran pour de meilleures performances
use_gpu true Utiliser l’accélération GPU si disponible

4. Sources d’actifs / filtres

Paramètre Description
show_archived Autoriser les médias “archivés” à être affichés
people Liste d’IDs de personnes à afficher
require_all_people Si true, n’affiche que les médias qui contiennent toutes les personnes listées
excluded_people Liste de personnes à exclure
albums Liste d’IDs d’albums à afficher
album_video false ou true : afficher les vidéos des albums
album_order random, newest ou oldest : ordre d’affichage des albums
excluded_albums IDs d’albums à exclure
dates Plages de dates au format "YYYY-MM-DD_to_YYYY-MM-DD"
tags Liste de tags à inclure
excluded_tags Liste de tags à exclure
excluded_partners IDs de partenaires à exclure
memories false ou true : afficher la section “souvenirs”

5. Interface utilisateur (UI)

Paramètre Valeur par défaut Description
disable_ui false Cacher tous les éléments UI (horloge/date/…)
frameless false Enlever les bordures et coins arrondis autour de l’image
frame_padding 0 ou [top, right, bottom, left] Marges autour de l’image
hide_cursor false Cacher le curseur souris
font_size 100 Taille de police (en pourcentage)
background_blur true Flouter l’arrière-plan de l’image actuelle
background_blur_amount 10 Intensité du flou
theme fade ou solid Thème visuel
layout single, splitview, splitview-landscape, portrait, landscape Disposition de l’affichage

6. Transition & affichage des images

Paramètre Valeur Description
transition none, fade, cross-fade Type de transition entre images
fade_transition_duration 1 (s) Durée pour fade
cross_fade_transition_duration 1 (s) Durée pour cross-fade
show_progress_bar false Afficher ou non une barre de progression
image_fit none, contain, cover Comment l’image remplit l’écran
image_effect none, zoom, smart-zoom Effet visuel appliqué à l’image
image_effect_amount 120 Intensité de l’effet
use_original_image false Utiliser l’image originale sans optimisation

7. Métadonnées des images

Paramètre Description
show_owner Afficher le propriétaire de l’image
show_album_name Afficher le nom de l’album
show_person_name Afficher le nom de la personne identifiée
show_person_age Afficher l’âge de la personne
show_image_time Afficher l’heure de la prise de vue
image_time_format 12 ou 24 heures
show_image_date Afficher la date de prise
image_date_format Format de date
show_image_description Afficher la description de l’image
show_image_exif Afficher les données EXIF (focale, ISO, etc.)
show_image_location Afficher le lieu de prise
hide_countries Liste de pays à exclure de l’affichage
show_image_id Afficher l’ID de l’image
show_more_info Afficher un overlay “plus d’infos” sur l’image
show_more_info_image_link Mettre un lien vers l’image originale
show_more_info_qr_code Afficher un QR code vers l’image originale
like_button_action Action du bouton “J’aime” : album, favorite, ou les deux
hide_button_action Action du bouton “Masquer” : tag, archive, ou les deux

8. Fonction météo (Weather feature)

Paramètre Description
weather: Liste d’objets météo :
• name: nom de la ville
• lat, lon: coordonnées
• api: clé API OpenWeatherMap
• unit: metric ou imperial
• lang: langue
• forecast: false ou true

9. Iframes / contenu externe

Paramètre Description
iframe: Liste d’URLs ou de chemins d’accès local à intégrer
Ex : - https://example.com/page ou - ./local.html

10. Multi-utilisateurs / webhooks / mode hors ligne

Paramètre Description
immich_users_api_keys: Map utilisateur → clé API (permet plusieurs utilisateurs)
show_user Afficher le nom de l’utilisateur courant
offline_mode: Objet : enabled, number_of_assets, max_size, parallel_downloads, expiration_hours
Permet d’utiliser le Kiosk hors connexion
kiosk: Sous-objet non modifiable via URL :
• port : port d’écoute (ex : 3000)
• behind_proxy : `true

📝 Exemple complet minimal

immich_api_key: "TON_API_KEY"
immich_url: "http://192.168.1.10:2283"

# Horloge
show_time: true
time_format: 24
show_date: true
date_format: YYYY/MM/DD

# Kiosk behaviour
duration: 45
disable_screensaver: true
optimize_images: true
use_gpu: true

# Sources d’actifs
albums:
  - "ALBUM_ID_1"
people:
  - "PERSON_ID_1"
tags:
  - "famille"

# UI / image
layout: single
theme: fade
image_fit: cover
hide_cursor: true
frameless: true

# Métadonnées
show_album_name: true
show_person_name: true
show_image_date: true
image_date_format: DD/MM/YYYY

# Kiosk interne
kiosk:
  port: 3000
  cache: true
  prefetch: true


ℹ️ Bonnes pratiques

  • Garder le fichier config.yaml à jour et sauvegardé.

  • Pour tester un réglage, relancer le service : 

    systemctl restart immich-kiosk

  • Vérifier toujours la page : curl http://127.0.0.1:3000 pour s’assurer que le backend répond.

Back to top