Skip to content
Immich Kiosk

Behavior

Duration

Section titled “Duration”

The amount of time in seconds an asset will be displayed for.

Settings

Key Value
CONFIG duration
ENV KIOSK_DURATION
URL duration
VALUE int
DEFAULT 60
Using with config.yaml file
duration: 60
Using with ENV in your docker-compose file
environment:
  KIOSK_DURATION: 60
Using with url queries
http://{URL}?duration=60

Transition

Section titled “Transition”

Which transition to use when changing images.

Settings

Key Value
CONFIG transition
ENV KIOSK_TRANSITION
URL transition
VALUE none | fade | cross-fade
DEFAULT none
Using with config.yaml file
transition: none
Using with ENV in your docker-compose file
environment:
  KIOSK_TRANSITION: none
Using with url queries
http://{URL}?transition=none

Fade Example

Section titled “Fade Example”

Fade Transition Duration

Section titled “Fade Transition Duration”

The duration of the fade (in seconds) transition.

Settings

Key Value
CONFIG fade_transition_duration
ENV KIOSK_TRANSITION
URL fade_transition_duration
VALUE float
DEFAULT 1
Using with config.yaml file
fade_transition_duration: 1
Using with ENV in your docker-compose file
environment:
  KIOSK_TRANSITION: 1
Using with url queries
http://{URL}?fade_transition_duration=1

Cross Fade Example

Section titled “Cross Fade Example”

Cross Fade Transition Duration

Section titled “Cross Fade Transition Duration”

The duration of the cross-fade (in seconds) transition.

Settings

Key Value
CONFIG cross_fade_transition_duration
ENV KIOSK_CROSS_FADE_TRANSITION_DURATION
URL cross_fade_transition_duration
VALUE float
DEFAULT 1
Using with config.yaml file
cross_fade_transition_duration: 1
Using with ENV in your docker-compose file
environment:
  KIOSK_CROSS_FADE_TRANSITION_DURATION: 1
Using with url queries
http://{URL}?cross_fade_transition_duration=1

Show Progress bar

Section titled “Show Progress bar”

Show a progress bar indicating the time remaining for the current asset.

Settings

Key Value
CONFIG show_progress_bar
ENV KIOSK_SHOW_PROGRESS_BAR
URL show_progress_bar
VALUE bool
DEFAULT false
Using with config.yaml file
show_progress_bar: false
Using with ENV in your docker-compose file
environment:
  KIOSK_SHOW_PROGRESS_BAR: false
Using with url queries
http://{URL}?show_progress_bar=false

Progress bar position

Section titled “Progress bar position”

Set the position of the progress bar.

Settings

Key Value
CONFIG progress_bar_position
ENV KIOSK_PROGRESS_BAR_POSITION
URL progress_bar_position
VALUE top | bottom
DEFAULT top
Using with config.yaml file
progress_bar_position: top
Using with ENV in your docker-compose file
environment:
  KIOSK_PROGRESS_BAR_POSITION: top
Using with url queries
http://{URL}?progress_bar_position=top

Disable Screensaver

Section titled “Disable Screensaver”

Ask browser to request a lock that prevents device screens from dimming or locking.

NOTE: I haven’t been able to get this to work constantly on IOS.

Settings

Key Value
CONFIG disable_screensaver
ENV KIOSK_DISABLE_SCREENSAVER
URL disable_screensaver
VALUE bool
DEFAULT false
Using with config.yaml file
disable_screensaver: false
Using with ENV in your docker-compose file
environment:
  KIOSK_DISABLE_SCREENSAVER: false
Using with url queries
http://{URL}?disable_screensaver=false

Optimize Images

Section titled “Optimize Images”

Whether Kiosk should resize images to match your browser screen dimensions for better performance.

NOTE: In most cases this is not necessary, but if you are accessing Kiosk on a low-powered device, this may help.

Settings

Key Value
CONFIG optimize_images
ENV KIOSK_OPTIMIZE_IMAGES
URL optimize_images
VALUE bool
DEFAULT false
Using with config.yaml file
optimize_images: false
Using with ENV in your docker-compose file
environment:
  KIOSK_OPTIMIZE_IMAGES: false
Using with url queries
http://{URL}?optimize_images=false

Use GPU

Section titled “Use GPU”

Enable GPU acceleration for improved performance (e.g., CSS transforms)

Settings

Key Value
CONFIG use_gpu
ENV KIOSK_USE_GPU
URL use_gpu
VALUE bool
DEFAULT true
Using with config.yaml file
use_gpu: true
Using with ENV in your docker-compose file
environment:
  KIOSK_USE_GPU: true
Using with url queries
http://{URL}?use_gpu=true

Burn-in protection

Section titled “Burn-in protection”

Burn-in protection helps reduce the risk of permanent image retention on displays that show static content for long periods of time. When enabled, Immich Kiosk periodically dims static interface elements such as the clock, icons, and image metadata. The dimming effect runs at a configurable interval, lasts for a short duration, and then smoothly returns to full opacity. This behaviour is subtle by design and is intended to protect OLED, AMOLED, and other long-running displays without distracting from the slideshow experience.

Burn-in interval

Section titled “Burn-in interval”

The interval (in minutes) between burn-in protection cycles (0 to disable).

Settings

Key Value
CONFIG burn_in_interval
ENV KIOSK_BURN_IN_INTERVAL
URL burn_in_interval
VALUE int
DEFAULT 0
Using with config.yaml file
burn_in_interval: 0
Using with ENV in your docker-compose file
environment:
  KIOSK_BURN_IN_INTERVAL: 0
Using with url queries
http://{URL}?burn_in_interval=0

Burn-in duration

Section titled “Burn-in duration”

The duration of each burn-in protection cycle (seconds).

Settings

Key Value
CONFIG burn_in_duration
ENV KIOSK_BURN_IN_DURATION
URL burn_in_duration
VALUE int
DEFAULT 30
Using with config.yaml file
burn_in_duration: 30
Using with ENV in your docker-compose file
environment:
  KIOSK_BURN_IN_DURATION: 30
Using with url queries
http://{URL}?burn_in_duration=30

Burn-in opacity New

Section titled “Burn-in opacity ”New

The opacity the UI will dip to, as a percentage.

Settings

Key Value
CONFIG burn_in_opacity
ENV KIOSK_BURN_IN_OPACITY
URL burn_in_opacity
VALUE int
DEFAULT 30
Using with config.yaml file
burn_in_opacity: 30
Using with ENV in your docker-compose file
environment:
  KIOSK_BURN_IN_OPACITY: 30
Using with url queries
http://{URL}?burn_in_opacity=30

Show Archived

Section titled “Show Archived”

Allow assets marked as archived to be displayed.

Settings

Key Value
CONFIG show_archived
ENV KIOSK_SHOW_ARCHIVED
URL show_archived
VALUE bool
DEFAULT false
Using with config.yaml file
show_archived: false
Using with ENV in your docker-compose file
environment:
  KIOSK_SHOW_ARCHIVED: false
Using with url queries
http://{URL}?show_archived=false

Use Original Image

Section titled “Use Original Image”

Use the original image.

Settings

Key Value
CONFIG use_original_image
ENV KIOSK_USE_ORIGINAL_IMAGE
URL use_original_image
VALUE bool
DEFAULT false
Using with config.yaml file
use_original_image: false
Using with ENV in your docker-compose file
environment:
  KIOSK_USE_ORIGINAL_IMAGE: false
Using with url queries
http://{URL}?use_original_image=false

Blacklist

Section titled “Blacklist”

The ID(s) of any specific assets you want Kiosk to skip/exclude from displaying. You can also tag assets in Immich with “kiosk-skip” to achieve the same.

Settings

Key Value
CONFIG blacklist
ENV KIOSK_BLACKLIST
URL blacklist
VALUE []string
DEFAULT ""
Using with config.yaml file
blacklist: ""
Using with ENV in your docker-compose file
environment:
  KIOSK_BLACKLIST: ""
Using with url queries
http://{URL}?blacklist=""