Metadata

Show Owner

Display the asset owner. Useful for shared albums.

Settings

Key	Value
CONFIG	show_owner
ENV	KIOSK_SHOW_OWNER
URL	undefined
VALUE	bool
DEFAULT	false

Using with config.yaml file

show_owner: false

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_OWNER: false

Using with url queries

http://{URL}?undefined=false

Show Album Name

Display album name(s) that the asset appears in.

Settings

Key	Value
CONFIG	show_album_name
ENV	KIOSK_SHOW_ALBUM_NAME
URL	undefined
VALUE	bool
DEFAULT	false

Using with config.yaml file

show_album_name: false

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_ALBUM_NAME: false

Using with url queries

http://{URL}?undefined=false

Show Person Name

Display person name(s).

Settings

Key	Value
CONFIG	show_person_name
ENV	KIOSK_SHOW_PERSON_NAME
URL	undefined
VALUE	bool
DEFAULT	false

Using with config.yaml file

show_person_name: false

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_PERSON_NAME: false

Using with url queries

http://{URL}?undefined=false

Show Person Age

Display person age.

Settings

Key	Value
CONFIG	show_person_age
ENV	KIOSK_SHOW_PERSON_AGE
URL	undefined
VALUE	bool
DEFAULT	false

Using with config.yaml file

show_person_age: false

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_PERSON_AGE: false

Using with url queries

http://{URL}?undefined=false

Show Image Time

Display image time from METADATA (if available).

Settings

Key	Value
CONFIG	show_image_time
ENV	KIOSK_SHOW_IMAGE_TIME
URL	undefined
VALUE	bool
DEFAULT	false

Using with config.yaml file

show_image_time: false

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_IMAGE_TIME: false

Using with url queries

http://{URL}?undefined=false

Image Time Format

Display image time in either 12-hour or 24-hour format. This can either be 12 or 24.

Settings

Key	Value
CONFIG	image_time_format
ENV	KIOSK_IMAGE_TIME_FORMAT
URL	undefined
VALUE	12 | 24
DEFAULT	24

Using with config.yaml file

image_time_format: 24

Using with ENV in your docker-compose file

environment:
  KIOSK_IMAGE_TIME_FORMAT: 24

Using with url queries

http://{URL}?undefined=24

Show Image Date

Display the image date from METADATA (if available).

Settings

Key	Value
CONFIG	show_image_date
ENV	KIOSK_SHOW_IMAGE_DATE
URL	undefined
VALUE	bool
DEFAULT	false

Using with config.yaml file

show_image_date: false

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_IMAGE_DATE: false

Using with url queries

http://{URL}?undefined=false

Image Date Format

The format of the image date. default is day/month/year. See date format for more information.

Settings

Key	Value
CONFIG	image_date_format
ENV	KIOSK_IMAGE_DATE_FORMAT
URL	undefined
VALUE	string
DEFAULT	DD/MM/YYYY

Using with config.yaml file

image_date_format: DD/MM/YYYY

Using with ENV in your docker-compose file

environment:
  KIOSK_IMAGE_DATE_FORMAT: DD/MM/YYYY

Using with url queries

http://{URL}?undefined=DD/MM/YYYY

Date format

Note

Some characters, such as / and : are not allowed in URL params. So while you can set the date layout via URL params, I would suggest setting them via config.yaml or environment variables.

You can use the below values to create your preferred date layout.

Value	Example output
YYYY	2024
YY	24
MMMM	August
MMM	Aug
MM	08
M	8
DDDD	Monday
DDD	Mon
DD	04
D	4

Date layout examples

These examples assume that today’s date is the 22nd of August 2024.

• YYYY-MM-DD => 2024-08-22
• YYYY/MM/DD => 2024/08/22
• YYYY:MM:DD => 2024:08:22
• YYYY MM DD => 2024 08 22
• YYYY MMM (DDD) => 2024 Aug (Thur)
• DDDD DD MMMM YYYY => Thursday 22 August 2024

Show Image Description

Display image description from METADATA (if available).

Settings

Key	Value
CONFIG	show_image_description
ENV	KIOSK_SHOW_IMAGE_DESCRIPTION
URL	undefined
VALUE	bool
DEFAULT	false

Using with config.yaml file

show_image_description: false

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_IMAGE_DESCRIPTION: false

Using with url queries

http://{URL}?undefined=false

Show Image Exif

Display image Fnumber, Shutter speed, focal length, ISO from METADATA (if available).

Settings

Key	Value
CONFIG	show_image_exif
ENV	KIOSK_SHOW_IMAGE_EXIF
URL	undefined
VALUE	bool
DEFAULT	false

Using with config.yaml file

show_image_exif: false

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_IMAGE_EXIF: false

Using with url queries

http://{URL}?undefined=false

Show Image Location

Display the image location from METADATA (if available).

Settings

Key	Value
CONFIG	show_image_location
ENV	KIOSK_SHOW_IMAGE_LOCATION
URL	undefined
VALUE	bool
DEFAULT	false

Using with config.yaml file

show_image_location: false

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_IMAGE_LOCATION: false

Using with url queries

http://{URL}?undefined=false

Hide Countries

List of countries to hide from image_location

Settings

Key	Value
CONFIG	hide_countries
ENV	KIOSK_HIDE_COUNTRIES
URL	undefined
VALUE	[]string
DEFAULT	[]

Using with config.yaml file

hide_countries: []

Using with ENV in your docker-compose file

environment:
  KIOSK_HIDE_COUNTRIES: []

Using with url queries

http://{URL}?undefined=[]

Show Image QR New

Displays a QR code linking to the original image (in Immich) next to the image metadata.

Settings

Key	Value
CONFIG	show_image_qr
ENV	KIOSK_SHOW_IMAGE_QR
URL	undefined
VALUE	bool
DEFAULT	false

Using with config.yaml file

show_image_qr: false

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_IMAGE_QR: false

Using with url queries

http://{URL}?undefined=false