Multiple Users

Caution

This feature can only be configured using a config.yaml file.

Caution

It is not possible to mix assets from different accounts. The example below will not work.

http://{URL}?user=john&person=PERSON_ID&user=jane&person=PERSON_ID

Tip

You can remove specific asset sources that were previously set in your config.yaml or environment variables by using none in the URL query parameters.

Example:

https://{URL}?user=USER&person=none&album=none
This will disable both the 'person' and 'album' asset sources.

Immich Kiosk supports multiple user API keys.

Immich Users Api Keys

key:value mappings of Immich usernames to their corresponding API keys.

Settings

Key	Value
CONFIG	immich_users_api_keys
ENV	N/A
URL	N/A
VALUE	map[string]string
DEFAULT	""

Using with config.yaml file

immich_users_api_keys: ""

Configuration

1. Configure multiple users by adding their API keys to the immich_users_api_keys field in your config.yaml:

   immich_users_api_keys:
   john: "api_key_here"
   jane: "api_key_here"

2. Access a specific user’s content by including the user parameter in the URL:

   https://{URL}?user=john

   Note

   If no user is specified in the URL, Immich Kiosk will default to using the global API key defined in immich_api_key.

Show User

Display the user used to fetch the image.

Settings

Key	Value
CONFIG	show_user
ENV	KIOSK_SHOW_USER
URL	show_user
VALUE	bool
DEFAULT	false

Using with config.yaml file

show_user: false

Using with ENV in your docker-compose file

environment:
  KIOSK_SHOW_USER: false

Using with url queries

http://{URL}?show_user=false