More Info Overlay

Show More Info

Enables the display of additional information about the current image(s)

Settings

Key	Value
CONFIG	show_more_info
ENV	KIOSK_SHOW_MORE_INFO
URL	show_more_info
VALUE	bool
DEFAULT	true

Using with config.yaml file

show_more_info: true

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_MORE_INFO: true

Using with url queries

http://{URL}?show_more_info=true

Show More Info Image Link

Shows a link to the original image (in Immich) in the additional information overlay

Settings

Key	Value
CONFIG	show_more_info_image_link
ENV	KIOSK_SHOW_MORE_INFO_IMAGE_LINK
URL	show_more_info_image_link
VALUE	bool
DEFAULT	true

Using with config.yaml file

show_more_info_image_link: true

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_MORE_INFO_IMAGE_LINK: true

Using with url queries

http://{URL}?show_more_info_image_link=true

Show More Info Qr Code

Displays a QR code linking to the original image (in Immich) in the additional information overlay

Settings

Key	Value
CONFIG	show_more_info_qr_code
ENV	KIOSK_SHOW_MORE_INFO_QR_CODE
URL	show_more_info_qr_code
VALUE	bool
DEFAULT	true

Using with config.yaml file

show_more_info_qr_code: true

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_MORE_INFO_QR_CODE: true

Using with url queries

http://{URL}?show_more_info_qr_code=true

Like Button Action

Action(s) to perform when the like button is clicked. Supported actions are [favorite, album].

Settings

Key	Value
CONFIG	like_button_action
ENV	KIOSK_LIKE_BUTTON_ACTION
URL	like_button_action
VALUE	[]string
DEFAULT	["favorite"]

Using with config.yaml file

like_button_action: ["favorite"]

Using with ENV in your docker-compose file

environment:
  KIOSK_LIKE_BUTTON_ACTION: ["favorite"]

Using with url queries

http://{URL}?like_button_action=["favorite"]

Favorite (the default)

Set asset as a favorite inside Immich.

Example:

like_button_action: favorite

Album

Add asset to the “Kiosk Favorites” albums, which will be created if it doesn’t exist.

Example:

like_button_action: album

Both

Marks the asset as a favourite and adds it to the ‘Kiosk Favorites’ album

Example:

like_button_action: [favorite, album]

Hide Button Action

Action(s) to perform when the hide button is clicked. Supported actions are [tag, archive].

Settings

Key	Value
CONFIG	hide_button_action
ENV	KIOSK_HIDE_BUTTON_ACTION
URL	hide_button_action
VALUE	[]string
DEFAULT	["tag"]

Using with config.yaml file

hide_button_action: ["tag"]

Using with ENV in your docker-compose file

environment:
  KIOSK_HIDE_BUTTON_ACTION: ["tag"]

Using with url queries

http://{URL}?hide_button_action=["tag"]

Tag (the default)

Tag asset with the “kiosk-skip” tag.

Example:

hide_button_action: tag

Archive

Set asset as archived inside Immich.

Example:

hide_button_action: archive

Both

Add tag and archive asset.

Example:

hide_button_action: [tag, archive]