Filters

Caution

Not all filters work on all asset source/buckets.

Filters allow you to filter asset buckets (people/albums/date etc.) by certain criteria.

Date filter

Limit assets from sources to a given date range.

filter_date accepts the same values as date range.

Settings

Key	Value
CONFIG	filter_date
ENV	KIOSK_FILTER_DATE
URL	filter_date
VALUE	string
DEFAULT	""

Using with config.yaml file

filter_date: ""

Using with ENV in your docker-compose file

environment:
  KIOSK_FILTER_DATE: ""

Using with url queries

http://{URL}?person=PERSON_ID&filter_date=2023-01-01_to_2023-02-01

Examples

• http://{URL}?filter_date=last-30-days will only show (random) assets from the last 30 days.
• http://{URL}?filter_date=2021-01-01_to_today will only show (random) assets between 2021-01-01 and today.

Newest filter

Limit asset sources to only the newest X assets.

Settings

Key	Value
CONFIG	filter_newest
ENV	KIOSK_FILTER_NEWEST
URL	filter_newest
VALUE	int
DEFAULT	""

Using with config.yaml file

filter_newest: ""

Using with ENV in your docker-compose file

environment:
  KIOSK_FILTER_NEWEST: ""

Using with url queries

http://{URL}?filter_newest=""

Examples

• http://{URL}?filter_newest=200 will only show (random) assets from the newest 200.
• http://{URL}?album=XXX&filter_newest=200 will only show the newest 200 (random) assets from supplied album.

Exclude faces filter

Note

Requires Immich to have already processed face detection on your assets.

Excludes assets where Immich has detected a face. Useful for slideshows focused on scenery, landscapes, or architecture.

Settings

Key	Value
CONFIG	filter_exclude_faces
ENV	KIOSK_FILTER_EXCLUDE_FACES
URL	filter_exclude_faces
VALUE	bool
DEFAULT	false

Using with config.yaml file

filter_exclude_faces: false

Using with ENV in your docker-compose file

environment:
  KIOSK_FILTER_EXCLUDE_FACES: false

Using with url queries

http://{URL}?filter_exclude_faces=false