damongolding/immich-kiosk v0.22.0 on GitHub

⚠ Breaking Changes ⚠

With 0.22.0 some of Kiosk's variable names have changed. This is to improve consistency, clarity and to be more semantic.

Below you will find a list of changes for both Config.yaml and ENVs. You can update these manually or use the provided migration tool (attached to this release).

Migration Tool usage

To use the migration tool, first download it. Then run one of the following commands, replacing the path with your actual config.yaml or docker-compose.yaml file:

./kiosk-config-migration -in=PATH/TO/YOUR/config.yaml
# or
./kiosk-config-migration -in=PATH/TO/YOUR/docker-compose.yaml

Config.yaml

OLD	NEW
`refresh`	`duration`
`album`	`albums`
`person`	`people`
`tag`	`tags`
`date`	`dates`
`experimental_album_video`	`album_video`
`show_progress`	`show_progress_bar`
`progress_position`	`progress_bar_position`

ENVs

OLD	NEW
`KIOSK_REFRESH`	`KIOSK_DURATION`
`KIOSK_ALBUM`	`KIOSK_ALBUMS`
`KIOSK_PERSON`	`KIOSK_PEOPLE`
`KIOSK_TAG`	`KIOSK_TAGS`
`KIOSK_DATE`	`KIOSK_DATES`
`KIOSK_EXPERIMENTAL_ALBUM_VIDEO`	`KIOSK_ALBUM_VIDEO`
`KIOSK_SHOW_PROGRESS`	`KIOSK_SHOW_PROGRESS_BAR`
`KIOSK_PROGRESS_POSITION`	`KIOSK_PROGRESS_BAR_POSITION`

Live photos

You can now enable live photos to be displayed in Kiosk. Live photos will loop indefinitely. You can use the live_photo_loop_delay option to control the delay between each live photo replay.

live_photos: false # enable/disable live photos
live_photo_loop_delay: 0 # the delay in seconds between each live photo replay

Live photos docs

Bubble theme

Added a new theme called "Bubble" which uses the dominant colour from the image the metadata is over.

Custom navigation section

Added a new webhook (user.navigation.custom) which when used adds a new section to the navigation. This webhook replaces the user.interaction.click which is now deprecated.

Disable URL overrides

Warning

Enabling this will also disable redirects

Enabling this will disable URL overrides. This is useful if you do not want users to overwrite the base configuration. The password query parameter can still be used.

Config.yaml

kiosk:
  disable_url_queries: false

ENV

environment:
  KIOSK_DISABLE_URL_QUERIES: false

People age section

Reworked how the age is displayed.

OLD	NEW
`NAME (21 years)`	`NAME (21)`
`NAME (8 months)`	`NAME (8m)`

`age_switch_to_years_after`

age_switch_to_years_after has been updated to add months to an age until the year(s) is reached.

Example with age_switch_to_years_after: 10:

OLD	NEW
`NAME (112 months)`	`NAME (9y 4m)`

Offline mode Immich reachable validation

If you are using offline mode and your saved assets have expired (based on the expiration_hours setting), Kiosk will only delete the expired assets and try to fetch new ones if it can connect to Immich. If Immich is not reachable, your expired assets will continue to be displayed.

Config schema validation

Kiosk will now validate the given config.yaml file and display any validation errors.

TIP: Adding this comment to the top of your config.yaml file will allow IDEs to validate your config in real time

# yaml-language-server: $schema=https://raw.githubusercontent.com/damongolding/immich-kiosk/main/config.schema.json

What's Changed

⚠️ Breaking Changes

Chore/config-name-updates by @damongolding in #475

🚀 New Features

Feature/offline mode validation by @damongolding in #468
Feature/themes by @damongolding in #469
Feature/custom nav by @damongolding in #473
Feature/disable url overrides by @damongolding in #472
Feature/age update by @damongolding in #474
Feature/live photos by @damongolding in #471
Feature/config schema by @damongolding in #476

⚡ Fixes

Fix/image orientation by @damongolding in #467
Fix/person age on more info by @damongolding in #470
Fix/added / to redirect names by @damongolding in #481

🔨 Maintenance

retire click webhook by @damongolding in #482

Full Changelog: v0.21.6...v0.22.0