github.com/damongolding/immich-kiosk

Minimum Immich version

The minimum Immich version has been raised to v3.2. This is to utilise the new API filter feature, allowing for more concise API calls.

Updated more info config

The more info config structure has been updated to be more self-contained and flexible. A few new options have also been added (rating, like_button and hide_button) to allow disabling interactive elements from the overlay.

OLD

show_more_info: true
show_more_info_image_link: true
show_more_info_qr_code: true

like_button_action: favorite # album, favorite or both [album, favorite]
hide_button_action: tag # tag, archive, or both [tag, archive]

NEW

more_info:
  display: true # show the more info overlay
  like_button_action: favorite # album, favorite or both [album, favorite]
  hide_button_action: tag # tag, archive, or both [tag, archive]
  show:
    asset_link: true
    qr_code: true
    rating: true
    like_button: true
    hide_button: true

Background album asset fetching

Albums with a large number of assets (1000+) are now fetched in the background. This improves Kiosk's initial startup/fetch times.

Improved auto reconnect

Kiosk's auto reconnect feature has been improved. Kiosk will use the existing system until a number of attempts have failed, then switch into the new auto-reconnecting mode, showing an overlay while it tries to reconnect in the background. If your browser supports service workers, this is cached too, so the reconnecting overlay will show even if Kiosk itself is offline.

For example: you take Kiosk down for server maintenance and happen to reload the browser tab that was displaying it. Previously you'd see the browser's default 404/offline page. Now you'll see the reconnecting page, which waits for Kiosk to come back online.

What's Changed

Other changes

• v0.44.0 by @damongolding in #890

Full Changelog: v0.43.2...v0.44.0

Improved visibility guards

Tighter guards to stop locked or hidden assets from showing

Fixed show_archive

This setting was silently broken by the switch to Immich v3

Non-blocking album fetch for redirects overlay

Album fetching for show_albums redirects now happens via a separate HTTP call, so it no longer blocks Kiosk's initial load

Fixed special album keywords

owned, shared, and all now work as they did in Immich v2

Improved related splitview assets when using multiple users

What's Changed

⚡ Fixes

• Fix/exclude hidden videos by @damongolding in #867
• fix/visibility by @damongolding in #871

Other changes

• chore/deps by @damongolding in #870
• task/delay album loading by @damongolding in #868
• Task/release by @damongolding in #874

Full Changelog: v0.43.1...v0.43.2

Fixed LANG reverting on config reload

Fixed the language from reverting to the default when using watch_config.

What's Changed

Other changes

• the fix by @damongolding in #865

Full Changelog: v0.43.0...v0.43.1

Redirect config update

The redirects object has been moved out of the kiosk object. The old config structure still works, but Kiosk will log a warning prompting you to migrate to the new structure.

Old

kiosk:
  redirects:
    - name: bubble
      url: /?theme=bubble

New

redirects:
  items:
    - name: bubble
      url: /?theme=bubble

Show albums on redirects

Setting show_albums to true displays all your albums in the redirect overlay. This is off by default.

redirects:
  show_albums: true
  items:
    - name: bubble
      url: /?theme=bubble

Redirect item categories

Redirects can now be grouped using categories.

Thanks to @itsvyle for this contribution!

redirects:
  show_albums: true
  items:
    - name: bubble
      url: /?theme=bubble
      category: themes

    - name: fade
      url: /?theme=fade
      category: themes

Fixed URL builder when using password

Thanks to @Vistalite for catching this!

Fixed star rating not saving in the more info overlay

Offline mode now allows URL overrides

Polish translations

Thanks to @kch789 for helping with Polish translations!

What's Changed

Other changes

• Update Polish translations in pl.toml by @kch789 in #843

New Contributors

• @kch789 made their first contribution in #843

Full Changelog: v0.42.0...v0.43.0

New transitions

• Added slide-up, slide-right, slide-down, slide-left and slide-random.
• Added push-up, push-right, push-down, push-left and push-random.

Slide left example

Push left example

All slide examples
All push examples

Fix memories

Restore memories functionality for Immich V3.

Fix exclude partner

Restore memories functionality for Immich V3.

What's Changed

🚀 New Features

• Feature/slide transition by @damongolding in #823
• Feature/push transition by @damongolding in #824
• update cover to be smarter by @damongolding in #826

⚡ Fixes

• fix/exclude-partner by @damongolding in #833
• fix/memories-date-fmt by @damongolding in #835
• fix pausing issue on prev asset by @damongolding in #837

🔨 Maintenance

• task/refine-push-slide-transitions by @damongolding in #836

Other changes

• Task/refine push slide by @damongolding in #841

Full Changelog: v0.41.0...v0.42.0

Custom weather provider

You can use any weather data provider by setting custom_weather_url on a weather location. Kiosk will expect the JSON payload to be structured in a specific way so you will most likely need to create a custom weather service/server that will fetch your weather data and provide it in the required format.

Example weather Location

weather:
  locations:
    - name: custom
      custom_weather_url: https://{CUSTOM_WEATHER_PROVIDER_URL}
      forecast: false
      show:
        temperature_range: false
        humidity: false
        wind: false
        visibility: false
      default: false

View the custom weather documentation for more information.

What's Changed

🚀 New Features

• feature/custom-weather by @damongolding in #817

Full Changelog: v0.40.2...v0.41.0

Added Immich version check

Kiosk now checks that your Immich server is running a supported version. If it's not, Kiosk logs an error and exits early. If Kiosk can't reach your Immich server, the version check is skipped.

Fix for smart-zoom

Restored image_effect: smart-zoom functionality.

Fix for album order

Restored album_order: oldest functionality.

What's Changed

⚡ Fixes

• Fix/smart-zoom by @damongolding in #813
• fix/album-order by @damongolding in #814

Full Changelog: v0.40.1...v0.40.2

Internal updates to the demo

New demo images.

Fixed a UI bug with metadata

Metadata would slowly fade out and in when viewing the more info overlay.

Full Changelog: v0.40.0...v0.40.1

⚠ Breaking Change: Support for Immich V3

v0.40.0 and above will only support Immich V3.

Filter favorites

Added the new filter filter_favorites, which limits all assets to only favorited assets.

Example

The below will limit assets from the given album and person to only favorited assets.
https://URL?album=XXX&person=XXX&filter_favorites=true

Memory title i18n

The memory title (X years ago) is now driven by year_ago and years_ago in the locale files.

Edit asset star rating

You can now edit an asset's star rating from the "more info" overlay.

Better asset retrieval on waking from sleep

Kiosk will grab a new asset immediately after waking from sleep mode.

Clear cache endpoint update

Updated the clear cache endpoint to allow it's usage in the Immich's V3 worflows.

https://docs.immichkiosk.app/guides/workflows/

What's Changed

⚠️ Breaking Changes

• Chore/immich v3 by @damongolding in #798

🚀 New Features

• Feature/filter fav by @damongolding in #790
• feature/memory title i18y by @damongolding in #800
• Feature/set rating by @damongolding in #803

⚡ Fixes

• Task/robust cursor hide by @damongolding in #785
• do not include other asset endpoint by @damongolding in #794
• trigger new asset fetch on wake by @damongolding in #796

🔨 Maintenance

• cleanup by @damongolding in #787
• deps by @damongolding in #795

Other changes

• Expose browser API for video mute state and control by @hyungyunlim in #780
• fix: harden hide_cursor CSS so the cursor reliably disappears by @mvanhorn in #801
• v0.40.0 by @damongolding in #804

Full Changelog: v0.39.3...v0.40.0

Restore support for Safari 12.1

Fix navigation on IOS/Safari 12.1

Full Changelog: v0.39.2...v0.39.3

Improved config path permission errors

When Kiosk cannot read the configuration file because of a permissions issue with the path (/config/config.yaml), it now displays a more helpful error message.

Weather URL queries

A select few weather options (UI elements) can be overridden via URL query parameters.
Documentation

What's Changed

⚡ Fixes

• fix: handle rejected video.play() on resume so slideshow recovers (#652) by @mvanhorn in #771

🔨 Maintenance

• better error mesg by @damongolding in #774

Other changes

• feat: support weather display URL overrides by @hyungyunlim in #773
• 0.39.2 by @damongolding in #775

New Contributors

• @mvanhorn made their first contribution in #771
• @hyungyunlim made their first contribution in #773

Full Changelog: v0.39.1...v0.39.2

Improved config file permission errors

When Kiosk cannot read the configuration file because of a permissions issue, it now displays a more helpful error message.

Binary build pipeline fix

Fixed broken build pipeline

Go version bump

Bumped to Go 1.26.4

What's Changed

🔨 Maintenance

• 0.39.1 by @damongolding in #770

Other changes

• update binary build by @damongolding in #768

Full Changelog: v0.39.0...v0.39.1

⚠ Breaking Change: Moved from Alpine to Distroless

With version 0.39.0 the docker base image has moved from Alpine to Distroless.

Why

I've moved Kiosk over to Distroless for size, speed and security. I've always tried to be as friendly to users hardware (and security conscience) as I can and a smaller docker image just makes sense.

• Smaller image (around 50% smaller then Alpine)
• No shell (bash etc) so it has a smaller attack surface
• Faster startups
• Runs as nonroot by default

Possible user actions

Healthcheck

With this change the current healthcheck will no longer work as distroless does not include CURL, so I built one into Kiosk.

# OLD
healthcheck:
  test: ["CMD", "curl", "-f", "http://localhost:3000/health"]
  interval: 30s
  timeout: 5s
  retries: 3
  start_period: 10s

# NEW
healthcheck:
  test: ["CMD", "/kiosk", "--healthcheck"] # 👈 This is the only change to the healthcheck
  interval: 30s
  timeout: 5s
  retries: 3
  start_period: 10s

Offline assets permissions

As Kiosk now runs as nonroot you may get permission errors when using offline mode. View the offline docs for a solution.

Fullscreen keyboard keybind

Pressing "f" will toggle the browser fullscreen mode.

What's Changed

🚀 New Features

• keybind for fullscreen by @damongolding in #757
• Feature/cache duration by @damongolding in #762

🔨 Maintenance

• Chore/remove bun slop by @damongolding in #752
• Chore/distroless by @damongolding in #759
• Chore/gofumpt by @damongolding in #760
• deps by @damongolding in #767

Full Changelog: v0.38.1...v0.39.0

Temp Range Indicators

Added a small indicator on the temp range values to add help visually distinguish between high and low temps.

The default wind direction is now compass directions

Changed the default wind direction to use compass directions (N, NE, E etc)

wind_direction

Added wind_direction to weather locations. Setting this to true will display the wind direction as degrees

weather:
  locations:
    - name: xxx
      lat: xxx
      lon: xxx
      api: xxx
      unit: metric
      lang: en
      show:
        wind: true
        wind_direction: false

Improved live photo handling

Fixed an issue where Kiosk could become stuck if a live photo failed to fetch.

What's Changed

🚀 New Features

• temp range indicators by @damongolding in #746
• feat: Added support for wind direction displayed as compass heading by @pengee in #742

⚡ Fixes

• Fix/forced-light-mode by @damongolding in #743
• Fix/live photo polling by @damongolding in #744

🔨 Maintenance

• deps by @damongolding in #747
• go v bump by @damongolding in #748

Other changes

• change default by @damongolding in #745
• Task/release by @damongolding in #749

New Contributors

• @pengee made their first contribution in #742

Full Changelog: v0.38.0...v0.38.1