Tags

Getting a tag value from Immich

Open Immich’s web interface and click on “Tags” in the left-hand navigation.
Click on the tag you want the value of.
The url will now look something like this http://192.168.86.123:2283/tags?path=cake.
The tag value is everything after path=, so in this example it would be cake.

Tags

A date range or ranges. See Date range for more information.

Settings

Key	Value
CONFIG	`tags`
ENV	`KIOSK_TAGS`
URL	`tag`
VALUE	`[]string`
DEFAULT	`[]`

Using with config.yaml file

tags:
  - TAG_VALUE
  - TAG_VALUE

Using with ENV in your docker-compose file

environment:
  KIOSK_TAGS: "TAG_VALUE, TAG_VALUE, TAG_VALUE"

Using with url queries

http://{URL}?tag=TAG_VALUE&tag=TAG_VALUE&tag=TAG_VALUE

How multiple tags work

When you specify multiple tags, Immich Kiosk creates a pool of all the requested tag values. For each asset refresh, Kiosk randomly selects one of the tag values from this pool and fetches an asset associated with it.

Excluded Tags

You can use this feature to hide assets with certain tags from appearing in the slideshow.

Settings

Key	Value
CONFIG	`excluded_tags`
ENV	`KIOSK_EXCLUDED_TAGS`
URL	`exclude_tag`
VALUE	`[]string`
DEFAULT	`[]`

Using with config.yaml file

excluded_tags:
  - TAG_VALUE
  - TAG_VALUE

Using with ENV in your docker-compose file

environment:
  KIOSK_EXCLUDED_TAGS: "TAG_VALUE, TAG_VALUE, TAG_VALUE"

Using with url queries

http://{URL}?exclude_tag=TAG_VALUE&exclude_tag=TAG_VALUE&exclude_tag=TAG_VALUE

Special tags

Skip

Tagging an asset with “kiosk-skip” will exclude it from displaying.