Immich Kiosk

[](https://github.com/awesome-selfhosted/awesome-selfhosted#photo-and-video-galleries)

[!IMPORTANT] This project is not affiliated with Immich

[!WARNING] Like the Immich project, this project is currently in beta and may experience breaking changes.

Table of Contents

• What is Immich Kiosk?
  • Requirements
  • Key features
  • Example 1: Raspberry Pi
• Installation
• Docker Compose
• Configuration
  • Changing settings via URL
  • Albums
  • People
  • Image fit
  • Image effects
  • Date format
  • Themes
  • Layouts
  • Sleep mode
  • Cusom CSS
  • Weather
• PWA
• Home Assistant
• FAQ
• TODO / Roadmap
• Support
• Help

What is Immich Kiosk?

Immich Kiosk is a lightweight slideshow for running on kiosk devices and browsers that uses Immich as a data source.

Requirements

• A reachable Immich server that is running version v1.117.0 or above.
• A browser from this supported list or higher.

Key features

• Simple installation and updates via Docker.
• Lightweight, responsive frontend for smooth performance.
• Display random images from your Immich collection, or curate specific albums and people.
• Fully customizable appearance with flexible transitions.
• Add a live clock with adjustable formats.
• Define default settings for all devices through environment variables or YAML config files.
• Configure device-specific settings using URL parameters.

Image shot by Damon Golding

Example 1

You have a two Raspberry Pi's. One hooked up to a LCD screen and the other you connect to your TV. You install a fullscreen browser OS or service on them (I use DietPi).

You want the pi connected to the LCD screen to only show images from your recent holiday, which are stored in a album on Immich. It's an older pi so you want to disable CSS transitions, also we don't want to display the time of the image.

Using this URL http://{URL}?album={ALBUM_ID}&transtion=none&show_time=false would achieve what we want.

On the pi connected to the TV you want to display a random image from your library but only images of two specific people. We want the image to cover the whole screen (knowing some cropping will happen) and we want to use the fade transition.

Using this URL http://{URL}?image_fit=cover&transition=fade&person=PERSON_1_ID&person=PERSON_2_ID would achieve what we want.

Installation

There are two main ways to install Kiosk.

Docker (recommended)

Option 1: Add Kiosk to your exsiting Immich compose stack.

1. Add the kiosk service to your Immich docker-compose.yaml file.

   Follow from step 3 in option 2 to create the config.yaml file.

Option 2: Create a seprate compose file for Kiosk.

1. Create a directory of your choice (e.g. ./immich-kiosk) to hold the docker-compose.yaml and config file.

    mkdir ./immich-kiosk
    cd ./immich-kiosk

2. Download docker-compose.yaml.

    wget -O docker-compose.yaml https://raw.githubusercontent.com/damongolding/immich-kiosk/refs/heads/main/docker-compose.yaml

   Set TZ to a TZ identifier from this list

3. Create the config.yaml file.

   You may use environment variables if preferred.

   Create config dir and download config.yaml file.

    mkdir ./config
    wget -O ./config/config.yaml https://raw.githubusercontent.com/damongolding/immich-kiosk/refs/heads/main/config.example.yaml

4. Modify config.yaml file.

   Only the immich_url and immich_api_key are required fields.

5. Start the container

    docker compose up -d

Binary

[!TIP] Use something like systemd to automate starting the Kiosk binary.

1. Download the binary file Vist the latest release and scroll to the assets at the bottom of the release notes. Download the archive file that matches your machines architecture and unarchive.

2. Create config dir and download config.yaml file.

   mkdir ./config
   wget -O ./config/config.yaml url

3. Modify config.yaml file.

   Only the immich_url and immich_api_key are required fields.

4. Start Kiosk

   ./kiosk

Docker Compose

[!NOTE] You can use both a yaml file and environment variables but environment variables will overwrite settings from the yaml file Set TZ to a TZ identifier from this list

When using a config.yaml config file

services:
  immich-kiosk:
    image: damongolding/immich-kiosk:latest
    container_name: immich-kiosk
    environment:
      TZ: "Europe/London"
    volumes:
      # Mount the directory with config.yaml inside
      - ./config:/config
    restart: always
    ports:
      - 3000:3000

When using environment variables

[!TIP] You do not need to specifiy all of these. If you want the default behaviour/value you can omit it from you compose file.

services:
  immich-kiosk:
    image: damongolding/immich-kiosk:latest
    container_name: immich-kiosk
    environment:
      TZ: "Europe/London"
      # Required settings
      KIOSK_IMMICH_API_KEY: "****"
      KIOSK_IMMICH_URL: "****"
      # Clock
      KIOSK_SHOW_TIME: FALSE
      KIOSK_TIME_FORMAT: 24
      KIOSK_SHOW_DATE: FALSE
      KIOSK_DATE_FORMAT: YYYY/MM/DD
      # Kiosk behaviour
      KIOSK_REFRESH: 60
      KIOSK_DISABLE_SCREENSAVER: FALSE
      # Asset sources
      KIOSK_SHOW_ARCHIVED: FALSE
      KIOSK_ALBUM: "ALBUM_ID,ALBUM_ID,ALBUM_ID"
      KIOSK_PERSON: "PERSON_ID,PERSON_ID,PERSON_ID"
      # UI
      KIOSK_DISABLE_UI: FALSE
      KIOSK_HIDE_CURSOR: FALSE
      KIOSK_FONT_SIZE: 100
      KIOSK_BACKGROUND_BLUR: TRUE
      KIOSK_THEME: FADE
      KIOSK_LAYOUT: SINGLE
      # Sleep mode
      KIOSK_SLEEP_START: 22
      KIOSK_SLEEP_END: 7
      # Transistion options
      KIOSK_TRANSITION: NONE
      KIOSK_FADE_TRANSITION_DURATION: 1
      KIOSK_CROSS_FADE_TRANSITION_DURATION: 1
      # Image display settings
      KIOSK_SHOW_PROGRESS: FALSE
      KIOSK_IMAGE_FIT: CONTAIN
      KIOSK_IMAGE_EFFECT: SMART-ZOOM
      KIOSK_IMAGE_EFFECT_AMOUNT: 120
      # Image metadata
      KIOSK_SHOW_IMAGE_TIME: FALSE
      KIOSK_IMAGE_TIME_FORMAT: 24
      KIOSK_SHOW_IMAGE_DATE: FALSE
      KIOSK_IMAGE_DATE_FORMAT: YYYY-MM-DD
      KIOSK_SHOW_IMAGE_EXIF: FALSE
      KIOSK_SHOW_IMAGE_LOCATION: FALSE
      KIOSK_HIDE_COUNTRIES: "HIDDEN_COUNTRY,HIDDEN_COUNTRY"
      KIOSK_SHOW_IMAGE_ID: FALSE
      # Kiosk settings
      KIOSK_WATCH_CONFIG: FALSE
      KIOSK_PASSWORD: ""
      KIOSK_CACHE: TRUE
      KIOSK_PREFETCH: TRUE
      KIOSK_ASSET_WEIGHTING: TRUE
      KIOSK_PORT: 3000
    ports:
      - 3000:3000
    restart: always

Configuration

See the file config.example.yaml for an example config file

Additional options

The below options are NOT configurable through URL params. In the config.yaml file they sit under kiosk (demo below and in example config.yaml)

immich_url: "****"
immich_api_key: "****"
// all your other config options

// 👇 Additional options
kiosk:
  password: ""
  cache: true
  prefetch: true

Changing settings via URL

You can configure settings for individual devices through the URL. This feature is particularly useful when you need different settings for different devices, especially if the only input option available is a URL, such as with kiosk devices.

example:

https://{URL}?refresh=120&background_blur=false&transition=none

The above would set refresh to 120 seconds (2 minutes), turn off the background blurred image and remove all transitions for this device/browser.

Albums

Getting an albums ID from Immich:

1. Open Immich's web interface and click on "Albums" in the left hand navigation.
2. Click on the album you want the ID of.
3. The url will now look something like this http://192.168.86.123:2283/albums/a04175f4-97bb-4d97-8d49-3700263043e5.
4. The album ID is everything after albums/, so in this example it would be a04175f4-97bb-4d97-8d49-3700263043e5.

How multiple albums work

When you specify multiple albums and/or people, Immich Kiosk creates a pool of all the requested person and album IDs. For each image refresh, Kiosk randomly selects one ID from this pool and fetches an image associated with that album or person.

There are three ways you can set multiple albums:

[!NOTE] These methods are applied in order of precedence. URL queries take highest priority, followed by environment variables, and finally the config.yaml file. Each subsequent method overwrites the settings from the previous ones.

1. via config.yaml file

   album:
   - ALBUM_ID
   - ALBUM_ID

2. via ENV in your docker-compose file use a , to separate IDs

   environment:
   KIOSK_ALBUM: "ALBUM_ID,ALBUM_ID,ALBUM_ID"

3. via url quires:

http://{URL}?album=ALBUM_ID&album=ALBUM_ID&album=ALBUM_ID

Special album keywords

all

Will use all albums. e.g. http://{URL}?album=all

shared

Will use only shared albums. e.g. http://{URL}?album=shared

favorites or favourites

Will use only favourited assets. e.g. http://{URL}?album=favorites or http://{URL}?album=favourites

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.

How multiple people work

When you specify multiple people and/or albums, Immich Kiosk creates a pool of all the requested album and person IDs. For each image refresh, Kiosk randomly selects one ID from this pool and fetches an image associated with that person or album.

There are three ways you can set multiple people ID's:

[!NOTE] These methods are applied in order of precedence. URL queries take highest priority, followed by environment variables, and finally the config.yaml file. Each subsequent method overwrites the settings from the previous ones.

1. via config.yaml file

person:
  - PERSON_ID
  - PERSON_ID

2. via ENV in your docker-compose file use a , to separate IDs

environment:
  KIOSK_PERSON: "PERSON_ID,PERSON_ID,PERSON_ID"

3. via url quires

http://{URL}?person=PERSON_ID&person=PERSON_ID&person=PERSON_ID

Image fit

This controls how the image will fit on your screen. The options are:

Contain (the default)

The image keeps its aspect ratio, but is resized to fit the whole screen. If the image is smaller than your screen, there will be some fuzzyness to your image.

Cover

The image will cover the whole screen. To achieve this the image will mostly likely have some clipping/cropping and if the image is smaller than your screen, there will be some fuzzyness to your image.

None

The image is centered and displayed "as is". If the image is larger than your screen it will be scaled down to fit your screen.

Image effects

zoom

[!NOTE] Image fit is set to cover automatically when this effect is used.

This effect zooms in or out to add movement to your images, with the center of the image as the focal point.

smart-zoom

[!NOTE] Image fit is set to cover automatically when this effect is used. If the image has multiple faces, Kiosk calculates the center of all faces to use as the focal point.

Smart zoom works like the regular zoom but focuses on faces and includes both zooming and panning.

[!TIP] To achieve a "Ken Burns" style effect change the image_effect_amount to somewhere between 200-400.

Date format

[!NOTE] Some characters, such as / and : are not allowed in URL params. So while you can set the date layout via URL params, I would suggest setting them via config.yaml or environment variables.

You can use the below values to create your preferred date layout.

Date layout examples

These examples assume that today's date is the 22nd of August 2024.

• "YYYY-MM-DD" => "2024-08-22"
• "YYYY/MM/DD" => "2024/08/22"
• "YYYY:MM:DD" => "2024:08:22"
• "YYYY MM DD" => "2024 08 22"
• "YYYY MMM (DDD)" => "2024 Aug (Thur)"
• "DDDD DD MMMM YYYY" => "Thursday 22 August 2024"

Themes

Fade (the default)

Soft gradient background for the clock and image metadata.

Solid

Solid background for the clock and image metadata.

Layouts

Single (the default)

Display one image.

Splitview

[!NOTE] Kiosk attempts to determine the orientation of each image. However, if an image lacks EXIF data, it may be displayed in an incorrect orientation (e.g., a portrait image shown in landscape format).

When a portrait image is fetched, Kiosk automatically retrieves a second portrait image* and displays them side by side vertically. Landscape and square images are displayed individually.

* If Kiosk is unable to retrieve a second unique image, the first image will be displayed individually.

Splitview landscape

[!NOTE] Kiosk attempts to determine the orientation of each image. However, if an image lacks EXIF data, it may be displayed in an incorrect orientation (e.g., a portrait image shown in landscape format).

When a landscape image is fetched, Kiosk automatically retrieves a second landscape image* and displays them stacked horizontally. portrait and square images are displayed individually.

* If Kiosk is unable to retrieve a second unique image, the first image will be displayed individually.

Sleep mode

Enabling Sleep Mode:

Setting both sleep_start and sleep_end using the 24 hour format will enable sleep mode.

During Sleep Mode:

Kiosk will display a black screen and can optionally shows a faint clock if show_time or show_date and enabled.

Examples

• Setting sleep_start=22 and sleep_end=7 will enable sleep mode from 22:00 (10pm) to 07:00 (7am).
• Setting sleep_start=1332 and sleep_end=1508 will enable sleep mode from 13:32 (1:32pm) to 15:08 (3:08pm).

Custom CSS

[!NOTE] Custom CSS is applied after all other styles, allowing you to override any default styles.

[!WARNING] Be cautious when using custom CSS, as it may interfere with the normal functioning of Kiosk if not implemented correctly. While I'm happy to help with general Kiosk issues, I may not be able to provide specific support for problems related to custom CSS implementations.

Custom CSS allows you to further customize Kiosk's appearance beyond the built-in themes and settings.

To use custom CSS:

1. Create a file named custom.css in the same directory as your docker-compose.yml file.
2. Add your custom CSS rules to this file.
3. Mount the custom.css file in your container by adding the following line to the volumes section of your docker-compose.yml:

   volumes:
   - ./config:/config
   - ./custom.css:/custom.css

4. Restart your Kiosk container for the changes to take effect.

[!TIP] Ensure that the path to your custom.css file is relative to your docker-compose.yml file.

There is a custom.example.css file included that contains all the CSS selectors used by Kiosk, which you can use as a reference for your customizations.

The custom CSS will apply to all devices connected to Kiosk by default.

To disable custom CSS for a specific device, add custom_css=false to the URL parameters e.g. http://{URL}?custom_css=false

Weather

[!NOTE] To use the weather feature, you’ll need an API key from OpenWeatherMap.

[!TIP] OpenWeatherMap limits API usage to 60 calls per hour. Since the kiosk refreshes weather data every 10 minutes, you can monitor up to 6 locations with a single API key.

Setting Up Weather Locations

You can configure multiple locations in the config.yaml file, and choose which one to display using the URL query weather=NAME.

Weather Location Configuration Options:

Example Configuration

Here’s an example of how to add London and New York to the config.yaml file. These locations would be selectable via the URL, like this: http://{URL}?weather=london or http://{URL}?weather=new-york.

 weather:
  - name: london
    lat: 51.5285262
    lon: -0.2663999
    api: API_KEY
    unit: metric
    lang: en

  - name: new-york
    lat: 40.6973709
    lon: -74.1444838
    api: API_KEY
    unit: imperial
    lang: en

PWA

[!NOTE] IOS does not allow PWA's to prevent the screen from going to sleep. A work around is to lauch Kiosk then enable the guided access feature.

IOS

1. Open Safari and navigate to Kiosk.
2. Tap on the share icon in Safari's navigation bar.
3. Scroll till you see "Add to Home Screen" and tap it.
4. Tap on the newly added Kiosk icon on your home screen!

Home Assistant

[!NOTE] These examples are community Kiosk implementations. I am unable to provide support for Home Assistant via issues.

While I did not create Kiosk with Home Assistant in mind. I thought it would be useful to add Kiosk implementations I have come across.

Using Kiosk to add a slideshow in Home Assistant.

1. Open up the dahsboard you want to add the slideshow to in edit mode.
2. Hit "add card" and search "webpage".
3. Enter the your Immich Kiosk url in the URL field e.g. http://192.168.0.123:3000
4. If you want to have some specific settings for the slideshow you can add them to the *URL

* I would suggest disabling all the UI i.e. http://192.168.0.123:3000?disable_ui=true

Using Immich Kiosk as an image source for Wallpanel in HomeAssistant:

  wallpanel:
    enabled: true
    image_fit: cover
    idle_time: 10
    screensaver_entity: input_boolean.kiosk
    screensaver_stop_navigation_path: /dashboard-kiosk
    fullscreen: true
    display_time: 86400
    image_url: >-
      http://{immich-kiosk-url}/image?person=PERSON_1_ID&person=PERSON_2_ID
    cards:
      - type: vertical-stack
        cards:
          - type: custom:weather-card
            details: true
            forecast: true
            hourly_forecast: false
            name: Weather
            entity: weather.pirateweather
            current: true
            number_of_forecasts: '6'
          - type: custom:horizon-card
            darkMode: true
            showAzimuth: true
            showElevation: true

FAQ

Q: What is the difference between ImmichFrame and ImmichKiosk?\ A:The main differences between ImmichFrame and ImmichKiosk are in how they are set up and how they interact with Immich:

• ImmichFrame: For individual devices

  • Installed on each device you want to use.
  • The device connects directly to Immich.
  • Data is processed on the device itself.

• ImmichKiosk: For multiple devices

  • Installed once on a central server.
  • Devices connect to it via a web browser, and it connects to Immich.
  • Data is processed by the Kiosk server.

In short, ImmichFrame is a 'one device, one installation, direct connection' setup, while ImmichKiosk is 'one installation, multiple devices, indirect connection.'"

\ Q: What is the no wifi icon?\ A: This icon shows when the front end can't connect to the back end.

\ Q: What is this icon in the menu?\ A: Clicking this icon tells Kiosk to delete all cached data and refresh the current device.

Q: Can I use this to set Immich images as my Home Assistant dashboard background?\ A: Yes! Just navigate to the dashboard with the view you wish to add the image background to. Enter edit mode and click the ✏ next to the view you want to add the image to. Then select the "background" tab and toggle on "Local path or web URL" and enter your url with path /image e.g. http://192.168.0.123:3000/image. If you want to specify an album or a person you can also add that to the url e.g. http://192.168.0.123:3000/image?album=ALBUM_ID

Q: Do I need to a docker service for each client?\ A: You only need one docker service (or binary running) that your devices(s) will connect to.

Q: Do I have to use port 3000?\ A: Nope. Just change the host port in your docker compose file i.e. - 3000:3000 to - PORT_YOU_WANT:3000

Q: How do I set/use a password?\ A: 👇

[!WARNING] This feature is meant for edgecase scenarios and offers very little in terms of protection. If you are aiming to expose Kiosk beyond your local network, please investigate more secure alternatives.

via config.yaml file

kiosk:
  password: 12345

via ENV in your docker-compose file

environment:
  KIOSK_PASSWORD: "12345"

Then to access Kiosk you MUST add the password param in your URL e.g. http://{URL}?password=12345

TODO / Roadmap

• Whitelist for people and albums
• Exclude list
• PWA (✔ basic implimetion)
• Splitview related images
• Docker/immich healthcheck?

Support

If this project has been helpful to you and you wish to support me, you can do so with the button below 🙂.

Help

If you have found a bug or have an issue you can submit it here.

If you'd like to chat or need some informal help, feel free to find me in the Kiosk channel on the Immich discord server.