v0.16.3

Fixed an issue where dates would be lowercase when not in English.

What's Changed

⚡ Fixes

• date titlecase by @damongolding in #309

Full Changelog: v0.16.2...v0.16.3

v0.16.2

Fixed a bug where the more info overlay wouldn’t show the asset date or time unless those options (show_image_date, show_image_time) were set to true.

What's Changed

⚡ Fixes

• more info overlay date and location by @damongolding in #307

Full Changelog: v0.16.1...v0.16.2

v0.16.1

Related Images in Splitview Layouts

When using splitview layouts (splitview and splitview-landscape), Kiosk now automatically displays related images side by side.

Here's how it works:

http://{URL}?person=PERSON_A&album=ALBUM_A&layout=splitview

When a portrait image is selected:

• If filtered by person (PERSON_A): Kiosk will fetch another image of the same person to display alongside it
• If filtered by album (ALBUM_A): Kiosk will fetch another image from the same album to display alongside it

---

What's Changed

🚀 New Features

• relative splitview images by @damongolding in #300

Full Changelog: v0.16.0...v0.16.1

v0.16.0

Icons

Added some icons to the Metadata overlay to help differentiate the data.

---

Album videos (experimental)

This feature is experimental and currently only supports album videos with certain limitations so please Read the docs.

---

Redirect(s) GUI

If you have any redirects configured in your config.yaml file, you will now see a button in the menu that displays them on the frontend for easy URL switching.

---

Date: last-xx-days

Added new format to the date asset bucket. last-xx-days e.g. date=last-30-days

Read the docs

---

Date filter

The date filter allow you to filter asset buckets (random and person/people) by date.

Example:
http://{URL}?person=PERSON_ID&date_filter=2023-01-01_to_2023-02-01 will only show assets of the supplied person between 2023-01-01 and 2023-02-01.

Read the docs

---

Multiple Users

You can now add multiple user API keys to access assets from their account. This is useful if you want to display different users assets on different devices without spinning up multiple Kiosk instances.

Shoutout to @tal-sitton for creating this feature.

Read the docs

---

Blacklist

Tip

You can also tag assets in Immich with "kiosk-skip" to achieve the same.

Add any asset ID you want Kiosk to skip/exclude from displaying.

Example:

blacklist:
  - ASSET_ID
  - ASSET_ID

---

Disable sleep mode via url

Add disable_sleep=true to your url to bypass sleep mode

---

Album and People names

show_album_name and show_person_name now work in any asset bucket random/album/person/date etc.

---

Clock translation

The date in the clock now respects your LANG setting.

---

Disable navigation

Added disable_navigation to remove all Kiosk interactivity (touch/click, keyboard and menu).

---

What's Changed

🚀 New Features

• bypass sleep mode via URL by @damongolding in #270
• redirect frontend GUI by @damongolding in #269
• album and people names by @damongolding in #283
• added translation for clock date by @damongolding in #287
• disable navigation by @damongolding in #288
• date: last-XX-days by @damongolding in #290
• support multiple users with multiple api keys by @tal-sitton in #231
• date_filter by @damongolding in #291
• experimental album videos by @damongolding in #279
• Feature/blacklist by @damongolding in #299

⚡ Fixes

• album people name missing fix by @damongolding in #286

📓 Documentation

• README hyperlink typo by @hockey6611 in #272

🔨 Maintenance

• deps and go bump by @damongolding in #271
• deps by @damongolding in #292

New Contributors

• @hockey6611 made their first contribution in #272

Full Changelog: v0.15.1...v0.16.0

v0.15.1

Fixed a rare case where API requests could enter an endless loop.

What's Changed

⚡ Fixes

• api recursion by @damongolding in #267

Full Changelog: v0.15.0...v0.15.1

v0.15.0

landscape and portrait layouts

You can now specify landscape or portrait as a layout value to display images with the desired aspect ratio.

Read the Docs

---

New asset "buckets"

You can now use date ranges and memories in addition to albums and people.

Date range

Tip

You can use today as an alias for the current date.
e.g. http://{URL}?date=2023-01-01_to_today

Define specific date ranges to filter images as a source:

1. via config.yaml file

date:
  - "YYYY-MM-DD_to_YYYY-MM-DD"

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

environment:
  KIOSK_DATE: "DATE_RANGE,DATE_RANGE,DATE_RANGE"

3. via url quires

http://{URL}?date=DATE_RANGE&date=DATE_RANGE&date=DATE_RANGE

Read the Docs

Memories

Enable image memories as a source:

1. via config.yaml file

memories: true

2. via ENV in your docker-compose file

environment:
  KIOSK_MEMORIES: true

3. via url quires

http://{URL}?memories=true

---

Album order

Choose in what order albums are displayed. random (default), newest or oldest.

1. via config.yaml file

album_order: random

2. via ENV in your docker-compose file

environment:
  KIOSK_ALBUM_ORDER: random

3. via url quires

http://{URL}?album_order=random

Read the Docs

---

local language for image metadata date

Set the LANG environment variable to one of the supported language codes to localize image metadata dates.

Example:

services:
  immich-kiosk:
    image: damongolding/immich-kiosk:latest
    container_name: immich-kiosk
    tty: true
    environment:
      LANG: "en_GB"
      TZ: "Europe/London"
    ports:
      - 3000:3000
    volumes:
      - ./config:/config
      # - ./custom.css:/custom.css
    restart: always

---

Per device cache

Each kiosk device now uses its own cache for API calls, significantly reducing duplicate images (especially within albums).

---

Dynamic manifest for PWA

On iOS, PWAs (Progressive Web Apps) cannot use URL queries directly. To address this limitation, Kiosk now supports dynamic manifest creation, enabling query overrides to function correctly when used in tandem with Kiosk's internal redirects.

How it works

kiosk:
  redirects:
    - name: pwa
      url: ?layout=portrait&album=ALBUM_ID
      type: internal

By configuring the above internal redirect and navigating to http://{URL}/pwa, you can set the start URL for the PWA. When added to the home screen, the app will respect the specified URL query overrides.

---

What's Changed

🚀 New Features

• linear transition for smoother zooming by @damongolding in #240
• add landscape and portrait layouts by @damongolding in #254
• add date range asset bucket by @damongolding in #251
• add memories asset bucket by @damongolding in #266
• disable gpu option by @damongolding in #257
• add local language for image meta date by @damongolding in #259
• per device cache and random album asset rework by @damongolding in #252
• dynamic manifest by @damongolding in #262
• album ordering by @damongolding in #265

⚡ Fixes

• fix clock/weather container height on older browsers by @damongolding in #258
• fix for clock when using disable_ui by @damongolding in #264

Full Changelog: v0.14.7...v0.15.0

v0.14.7

Weather

Fixed an issue where if the frontend requested weather data before Kiosk had received it (for the first time) it would cause an error. Now Kiosk will use a retry loop before throwing an error.

What's Changed

⚡ Fixes

• Fix/weather resilience by @damongolding in #243

🔨 Maintenance

• updated dependencies by @damongolding in #244

Full Changelog: v0.14.6...v0.14.7

v0.14.6

Displaying Album and People Names

Show names by setting show_album_name or show_person_name to true when using a person ID, album ID, or special album keywords.

Multiple People/Album URL Fix

Fixed bug where only one person/album was processed when multiple were specified in the URL.

What's Changed

🚀 New Features

• display album/person name by @damongolding in #233

⚡ Fixes

• fix for multiple albums and people in url queries by @damongolding in #236

🔨 Maintenance

• dependencies update by @damongolding in #232

Other changes

• Feature/docker best practices by @benlinton in #230

New Contributors

• @benlinton made their first contribution in #230

Full Changelog: v0.14.5...v0.14.6

v0.14.5

What's Changed

🚀 New Features

• None image content is now compressed and served via gzip

⚡ Fixes

• fix base config persisting when person/album url param set by @damongolding in #226
• fix mime type when using the raw image endpoint by @damongolding in #228

Other changes

• Documentation: Adding an example of using Google Cast provided by chris.burrow by @chris-burrow-apps in #229

New Contributors

• @chris-burrow-apps made their first contribution in #229

Full Changelog: v0.14.4...v0.14.5

v0.14.4

What's Changed

⚡ Fixes

• merge redirect queries with request queries for external redirects by @damongolding in #223

Full Changelog: v0.14.3...v0.14.4