People

Getting a person’s ID from Immich

1. Open Immich’s web interface and click on “Explore” in the left-hand navigation.
2. Click on the person you want the ID of (you may have to click “view all” if you don’t see them).
3. The url will now look something like this http://192.168.86.123:2283/people/a04175f4-97bb-4d97-8d49-3700263043e5.
4. The persons ID is everything after people/, so in this example it would be a04175f4-97bb-4d97-8d49-3700263043e5.

People

The ID(s) of a specific person or people you want to display.

Settings

Key	Value
CONFIG	people
ENV	KIOSK_PEOPLE
URL	person
VALUE	[]string
DEFAULT	[]

Using with config.yaml file

people:
  - PERSON_ID
  - PERSON_ID

Using with ENV in your docker-compose file

environment:
  KIOSK_PEOPLE: "PERSON_ID, PERSON_ID"

Using with url queries

http://{URL}?person=PERSON_ID

---

Require All People New

The require_all_people feature allows you to filter images to only show those where all specified people are present together in the same photo.

Settings

Key	Value
CONFIG	require_all_people
ENV	KIOSK_REQUIRE_ALL_PEOPLE
URL	require_all_people
VALUE	bool
DEFAULT	false

Using with config.yaml file

require_all_people: false

Using with ENV in your docker-compose file

environment:
  KIOSK_REQUIRE_ALL_PEOPLE: false

Using with url queries

http://{URL}?require_all_people=false

How It Works

When enabled:

• Only photos containing ALL specified people will be displayed
• Photos where only some of the specified people appear will be excluded

Example Use Cases

1. Family Photos:

   • Set multiple person IDs for family members
   • Enable require_all_people to only show assets where the whole family is together

2. Group Events:

   • Specify IDs for members of a group
   • See only photos where everyone was present

Important Notes

Note

• This setting only takes effect when multiple people are specified
• If no matching photos are found (where all people appear together), Kiosk will display an error message
• This feature cannot be combined with other source/buckets like date ranges or albums
• Setting to false returns to default behavior where photos containing ANY of the specified people will be shown

---

Excluded People

Caution

The person or people you want to exclude from the slideshow must be tagged for the exclusion to work.

This feature allows you to prevent specific people from being displayed in the slideshow.

Settings

Key	Value
CONFIG	excluded_people
ENV	KIOSK_EXCLUDED_PEOPLE
URL	exclude_person
VALUE	[]string
DEFAULT	[]

Using with config.yaml file

excluded_people:
  - PERSON_ID
  - PERSON_ID

Using with ENV in your docker-compose file

environment:
  KIOSK_EXCLUDED_PEOPLE: "PERSON_ID, PERSON_ID"

Using with url queries

http://{URL}?exclude_person=PERSON_ID

Tip

You can remove all excluded people settings (from your config.yaml or environment variables) by using none in the URL query parameters.

Example:

https://{URL}?album=ALBUM_ID&exclude_person=none

---

Special People Keywords

---

all

Will use all named people.

Settings

Using with config.yaml file

people:
  - all

Using with ENV in your docker-compose file

environment:
  KIOSK_PEOPLE: "all"

Using with url queries

http://{URL}?person=all