Behavior

Refresh

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

Settings

Key	Value
CONFIG	`refresh`
ENV	`KIOSK_REFRESH`
URL	`refresh`
VALUE	`int`
DEFAULT	`60`

Using with config.yaml file

refresh: 60

Using with ENV in your docker-compose file

environment:
  KIOSK_REFRESH: 60

Using with url queries

http://{URL}?refresh=60

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 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

Fade 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

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

Settings

Key	Value
CONFIG	`show_progress`
ENV	`KIOSK_SHOW_PROGRESS`
URL	`show_progress`
VALUE	`bool`
DEFAULT	`false`

Using with config.yaml file

show_progress: false

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_PROGRESS: false

Using with url queries

http://{URL}?show_progress=false

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

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

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

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

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

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=""