Skip to content

Multiple Users

Immich Kiosk supports multiple user API keys.

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

Settings

Key Value
CONFIG undefined
ENV N/A
URL N/A
VALUE map[string]string
DEFAULT ""
Using with config.yaml file
immich_users_api_keys:
damon: "api_key_here"
laura: "api_key_here"
  1. Configure multiple users by adding their API keys to the immich_users_api_keys field in your config.yaml:

    immich_users_api_keys:
    damon: "api_key_here"
    laura: "api_key_here"
  2. Append the @username to the asset ID to use a specific user’s API key:

    people:
    - 1234 # This will the default API key
    - 5678@damon # This will use Damon's API key
    - 9101@laura # This will use Laura's API key
    album:
    - 4321 # This will the default API key
    - 8765@damon # This will use Damon's API key
    - 1019@laura # This will use Laura's API key

    or

    # URL
    https://KIOSK_URL?person=1234@damon

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