Core

Immich API key

The API for your Immich server.

Settings

CONFIG	immich_api_key
ENV	KIOSK_IMMICH_API_KEY
URL	N/A
VALUE	string
DEFAULT	""

Using with config.yaml file

immich_api_key: ******

Using with ENV in your docker-compose file

environment:
  KIOSK_IMMICH_API_KEY: ******

Using with url queries

N/A

---

Immich URL

The URL of your Immich server. MUST include a port if one is needed e.g. http://192.168.1.123:2283.

Settings

CONFIG	immich_url
ENV	KIOSK_IMMICH_URL
URL	N/A
VALUE	string
DEFAULT	""

Using with config.yaml file

immich_url: http://192.168.1.123:2283

Using with ENV in your docker-compose file

environment:
  KIOSK_IMMICH_URL: http://192.168.1.123:2283

Using with url queries

N/A

---

Immich External URL

The public URL of your Immich server used for generating links and QR codes in the additional information overlay. Useful when accessing Immich through a reverse proxy or different external URL.

Example: https://photos.example.com.

If not set, falls back to immich_url.

Settings

CONFIG	immich_external_url
ENV	KIOSK_IMMICH_EXTERNAL_URL
URL	N/A
VALUE	string
DEFAULT	""

Using with config.yaml file

immich_external_url: https://photos.example.com

Using with ENV in your docker-compose file

environment:
  KIOSK_IMMICH_EXTERNAL_URL: https://photos.example.com

Using with url queries

N/A