Metadata

Show rating

Display the asset rating stars.

Settings

Key	Value
CONFIG	show_image_rating
ENV	KIOSK_SHOW_IMAGE_RATING
URL	show_image_rating
VALUE	bool
DEFAULT	false

Using with config.yaml file

show_image_rating: false

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_IMAGE_RATING: false

Using with url queries

http://{URL}?show_image_rating=false

Show Owner

Display the asset owner. Useful for shared albums.

Settings

Key	Value
CONFIG	show_owner
ENV	KIOSK_SHOW_OWNER
URL	show_owner
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}?show_owner=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	show_album_name
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}?show_album_name=false

Show Person Name

Display person name(s).

Settings

Key	Value
CONFIG	show_person_name
ENV	KIOSK_SHOW_PERSON_NAME
URL	show_person_name
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}?show_person_name=false

Show Person Age

Display person age.

Settings

Key	Value
CONFIG	show_person_age
ENV	KIOSK_SHOW_PERSON_AGE
URL	show_person_age
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}?show_person_age=false

Switch to years after

Switch to years after a certain age.

Settings

Key	Value
CONFIG	age_switch_to_years_after
ENV	KIOSK_AGE_SWITCH_TO_YEARS_AFTER
URL	age_switch_to_years_after
VALUE	number
DEFAULT	1

Using with config.yaml file

age_switch_to_years_after: 1

Using with ENV in your docker-compose file

environment:
  KIOSK_AGE_SWITCH_TO_YEARS_AFTER: 1

Using with url queries

http://{URL}?age_switch_to_years_after=1

Example with age_switch_to_years_after: 10

| 9 years and 4 months | 10 years 2 months | | -------------------- | ----------------- | | NAME (9y 4m) | NAME (10) |

Always display year unit

Settings

Key	Value
CONFIG	show_age_year_unit
ENV	KIOSK_SHOW_AGE_YEAR_UNIT
URL	show_age_year_unit
VALUE	bool
DEFAULT	false

Using with config.yaml file

show_age_year_unit: false

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_AGE_YEAR_UNIT: false

Using with url queries

http://{URL}?show_age_year_unit=false

Set to true if you would prefer to always display the year unit e.g. NAME (24y).

Show Image Time

Display image time from METADATA (if available).

Settings

Key	Value
CONFIG	show_image_time
ENV	KIOSK_SHOW_IMAGE_TIME
URL	show_image_time
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}?show_image_time=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	image_time_format
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}?image_time_format=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	show_image_date
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}?show_image_date=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	image_date_format
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}?image_date_format=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	show_image_description
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}?show_image_description=false

Show Image Camera

Display camera make and model from METADATA (if available).

Settings

Key	Value
CONFIG	show_image_camera
ENV	KIOSK_SHOW_IMAGE_CAMERA
URL	show_image_camera
VALUE	bool
DEFAULT	false

Using with config.yaml file

show_image_camera: false

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_IMAGE_CAMERA: false

Using with url queries

http://{URL}?show_image_camera=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	show_image_exif
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}?show_image_exif=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	show_image_location
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}?show_image_location=false

Hide image location parts

Settings

Key	Value
CONFIG	See below
ENV	See below
URL	See below
VALUE	map[string]string
DEFAULT	""

Using with config.yaml file

image_location:
  hide_city: false
  hide_state: false
  hide_country: false

Using with ENV in your docker-compose file

environment:
  KIOSK_IMAGE_LOCATION_HIDE_CITY: false
  KIOSK_IMAGE_LOCATION_HIDE_STATE: false
  KIOSK_IMAGE_LOCATION_HIDE_COUNTRY: false

Using with url queries

http://{URL}?image_location_hide_city=false&image_location_hide_state=false&image_location_hide_country=false

Hide Countries

List of countries to hide from image_location

Settings

Key	Value
CONFIG	hide_countries
ENV	KIOSK_HIDE_COUNTRIES
URL	N/A
VALUE	[]string
DEFAULT	[]

Using with config.yaml file

hide_countries: []

Using with ENV in your docker-compose file

environment:
  KIOSK_HIDE_COUNTRIES: []

Show Image QR

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	show_image_qr
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}?show_image_qr=false