config.example.yaml

# yaml-language-server: $schema=https://raw.githubusercontent.com/damongolding/immich-kiosk/main/config.schema.json

## Required settings - move these to ENV if you want to check in this file
immich_api_key: ""
immich_url: ""

## Clock
show_time: false
time_format: 24 # 12 or 24
show_am_pm: true # show am/pm when using 12 hour format
show_date: false
date_format: YYYY/MM/DD
clock_source: client

## Kiosk behaviour
duration: 60 # The duration a slide will be displayed (seconds).
disable_screensaver: false # Ask the browser to request a lock that prevents device screens from dimming or locking.
optimize_images: false # Whether Kiosk should resize images to match your browser screen dimensions for better performance.
use_gpu: true # Enable GPU acceleration for improved performance.
burn_in_interval: 0 # The interval between burn-in protection cycles (minutes, 0 = disabled).
burn_in_duration: 30 # The duration of each burn-in protection cycle (seconds).
burn_in_opacity: 70 # The opacity the UI will dip to, as a percentage.

## Asset sources
show_archived: false # Allow assets marked as archived to be displayed.

## ID(s) of person or people to display
people:
  - "PERSON_ID"
require_all_people: false # When true, only show images containing all specified people together
excluded_people:
  - "PERSON_ID"

## ID(s) of album or albums to display
albums:
  - "ALBUM_ID"
album_order: random # random | newest | oldest
# Album IDs to exclude from being shown. Albums in this list will be filtered from
# appearing in the frame even if they are included in the 'album' list.
excluded_albums:
  - "ALBUM_ID"

## Date range or ranges to display
dates:
  - "YYYY-MM-DD_to_YYYY-MM-DD"

## Value(s) of tag(s) to display
tags:
  - "TAG_VALUE"
excluded_tags:
  - "TAG_VALUE"

# Include assets based on their rating
rating: -1 # 0 - 5 (-1 = disabled)

excluded_partners:
  - "PARTNER_ID"

memories: false # show memories

## Filters
# filter_date: last-30-days # Limit assets from sources to a given date range
# filter_newest: 0 # Limit asset sources to only the newest X assets.
# filter_exclude_faces: false # Excludes assets where Immich has detected a face

## UI
show_clear_cache_button: false # Show a menu button to clear the Kiosk server cache
show_progress_bar: false # display a progress bar
disable_ui: false # this is just a shortcut for all ui elements (show_time, show_date, show_image_time, show_image_date)
frameless: false # remove border around image and rounded corners.
frame_padding: 0 # padding (px) around the edge of Kiosk; accepts integer or array [top, right, bottom, left]
hide_cursor: false # Hide cursor/mouse via CSS.
font_size: 100 # the base font size as a percentage. OMIT the % character
background_blur: true # display a blurred version of image as background
background_blur_amount: 10 # amount of blur to apply to background image (sigma)
theme: fade # which theme to use. fade or solid
layout: single # which layout to use. single | splitview | splitview-landscape | portrait | landscape

## Sleep mode
# sleep_start: 22 # sleep mode start time
# sleep_end: 7 # sleep mode end time
# sleep_dim_screen: false # dim screen when sleep mode is active (only works with Fully Kiosk Browser)
sleep_icon: true

## Transition options
transition: none # cross-fade, fade or none
fade_transition_duration: 1 # in seconds
cross_fade_transition_duration: 1 # in seconds

## Image display settings
image_fit: contain # none | contain | cover
image_effect: none # none | zoom | smart-zoom
image_effect_amount: 120
use_original_image: false # use the original file.

## Video
show_videos: false
live_photos: false
live_photo_loop_delay: 0
show_animated_gifs: false

## Image METADATA
show_image_rating: false
show_owner: false # show the owner of the image
show_album_name: false
show_person_name: false
show_person_age: false
show_image_time: false
image_time_format: 24 # 12 or 24
show_image_date: false
image_date_format: YYYY-MM-DD
show_image_description: false
show_image_camera: false
show_image_exif: false
show_image_location: false
show_image_qr: false
hide_countries:
  - "country to hide"
show_image_id: false
show_more_info: true
show_more_info_image_link: true
show_more_info_qr_code: true

like_button_action: favorite # album, favorite or both [album, favorite]
hide_button_action: tag # tag, archive, or both [tag, archive]

## Weather feature - you’ll need an API key from OpenWeatherMap
# weather:
#   rotation_interval: 60 # in seconds (minimum: 10); rotation must be enabled via URL parameter
#   locations:
#     - name: london
#       lat: 51.5285262
#       lon: -0.2663999
#       api: ""
#       unit: metric
#       lang: en
#       forecast: false
#       default: false
#       show:
#         humidity: false
#         wind: false
#         visibility: false
#         temperature_range: false

## Add iframes into Kiosk - you can use local files or remote URLs
#iframe:
# - https://iframe.immichkiosk.app/pokemon
# - ./iframes/pokemon.html

## Immich API keys for specific users
# immich_users_api_keys:
#   user1: ""
# show_user: false # show user name

## Offline mode
# offline_mode:
#   enabled: false
#   number_of_assets: 100
#   max_size: 0
#   parallel_downloads: 1
#   expiration_hours: 0

## Options that can NOT be changed via url params
kiosk:
  port: 3000
  behind_proxy: false
  disable_url_queries: false
  disable_config_endpoint: false
  enable_url_builder: false
  watch_config: false
  fetched_assets_size: 1000
  http_timeout: 20
  password: ""
  cache: true # cache select api calls
  prefetch: true # fetch assets in the background
  asset_weighting: true # use weighting when picking assets