More Info Overlay

YAML Configuration

more_info:
  display: true # show the more info overlay
  like_button_action: favorite # album, favorite or both [album, favorite]
  hide_button_action: tag # tag, archive, or both [tag, archive]
  show:
    asset_link: true
    qr_code: true
    rating: true
    like_button: true
    hide_button: true

Show More Info

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

Settings

Key	Value
CONFIG	more_info.display
ENV	KIOSK_MORE_INFO_DISPLAY
URL	more_info_display
VALUE	bool
DEFAULT	true

Using with config.yaml file

more_info.display: true

Using with ENV in your docker-compose file

environment:
  KIOSK_MORE_INFO_DISPLAY: true

Using with url queries

http://{URL}?more_info_display=true

Like Button Action

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

Settings

Key	Value
CONFIG	more_info.like_button_action
ENV	KIOSK_MORE_INFO_LIKE_BUTTON_ACTION
URL	more_info_like_button_action
VALUE	[]string
DEFAULT	["favorite"]

Using with config.yaml file

more_info.like_button_action: ["favorite"]

Using with ENV in your docker-compose file

environment:
  KIOSK_MORE_INFO_LIKE_BUTTON_ACTION: ["favorite"]

Using with url queries

http://{URL}?more_info_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	more_info.hide_button_action
ENV	KIOSK_MORE_INFO_HIDE_BUTTON_ACTION
URL	more_info_hide_button_action
VALUE	[]string
DEFAULT	["tag"]

Using with config.yaml file

more_info.hide_button_action: ["tag"]

Using with ENV in your docker-compose file

environment:
  KIOSK_MORE_INFO_HIDE_BUTTON_ACTION: ["tag"]

Using with url queries

http://{URL}?more_info_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]

Show More Info Image Link

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

Settings

Key	Value
CONFIG	more_info.show.asset_link
ENV	KIOSK_MORE_INFO_SHOW_ASSET_LINK
URL	more_info_show_asset_link
VALUE	bool
DEFAULT	true

Using with config.yaml file

more_info.show.asset_link: true

Using with ENV in your docker-compose file

environment:
  KIOSK_MORE_INFO_SHOW_ASSET_LINK: true

Using with url queries

http://{URL}?more_info_show_asset_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	more_info.show.qr_code
ENV	KIOSK_MORE_INFO_SHOW_QR_CODE
URL	more_info_show_qr_code
VALUE	bool
DEFAULT	true

Using with config.yaml file

more_info.show.qr_code: true

Using with ENV in your docker-compose file

environment:
  KIOSK_MORE_INFO_SHOW_QR_CODE: true

Using with url queries

http://{URL}?more_info_show_qr_code=true

Show More Info Rating

Displays the rating of the asset in the additional information overlay

Settings

Key	Value
CONFIG	more_info.show.rating
ENV	KIOSK_MORE_INFO_SHOW_RATING
URL	more_info_show_rating
VALUE	bool
DEFAULT	true

Using with config.yaml file

more_info.show.rating: true

Using with ENV in your docker-compose file

environment:
  KIOSK_MORE_INFO_SHOW_RATING: true

Using with url queries

http://{URL}?more_info_show_rating=true

Show More Info Like Button

Displays the like button of the asset in the additional information overlay

Settings

Key	Value
CONFIG	more_info.show.like_button
ENV	KIOSK_MORE_INFO_SHOW_LIKE_BUTTON
URL	more_info_show_like_button
VALUE	bool
DEFAULT	true

Using with config.yaml file

more_info.show.like_button: true

Using with ENV in your docker-compose file

environment:
  KIOSK_MORE_INFO_SHOW_LIKE_BUTTON: true

Using with url queries

http://{URL}?more_info_show_like_button=true

Show More Info Hide Button

Displays the hide button of the asset in the additional information overlay

Settings

Key	Value
CONFIG	more_info.show.hide_button
ENV	KIOSK_MORE_INFO_SHOW_HIDE_BUTTON
URL	more_info_show_hide_button
VALUE	bool
DEFAULT	true

Using with config.yaml file

more_info.show.hide_button: true

Using with ENV in your docker-compose file

environment:
  KIOSK_MORE_INFO_SHOW_HIDE_BUTTON: true

Using with url queries

http://{URL}?more_info_show_hide_button=true