v0.11.3

Config mount

I am moving the config.yaml mount from:

    volumes:
      # Mounting single file
      - ./config.yaml:/config.yaml

to

    volumes:
      # Mount the directory with config.yaml inside
      - ./config:/config

This is to fix permission issues when watch_config is set to true. At the moment you may use either of these.

Splitview Landscape

Added layout=splitview-landscape. Which works the same as splitview but with landscape images being stacked.

What's Changed

🚀 New Features

• added layout splitview-landscape by @damongolding in #132

⚡ Fixes

• better config.yaml watching and auto reload by @damongolding in #131
• trim whitespace from albumID and personID by @damongolding in #128
• fix duplicate images displaying in splitview layouts by @damongolding in #133
• Updated IOS wakelock by @damongolding in #134

Full Changelog: v0.11.2...v0.11.3

v0.11.2

Config 👀ing

If you're using the config.yaml file. Kiosk will not watch it for changes and will update the config and reload all connected clients.

API calls

Kiosk will now wait for 10 secs before deciding an api has failed. It will also retry 3 times before giving up and going for a walk on the beach.

YAML

If your config.yaml file is not valid, Kiosk will not let you know and tell you what the issue is.

Image ID

Added show_image_id just for Zeus because he asked nicely.

Port

Added kiosk.port option for more advanced configs.

What's Changed

🚀 New Features

• Immich API call improvements by @damongolding in #116
• auto config reload on change and refresh endpoint by @damongolding in #118
• better yaml error logging by @damongolding in #119

⚡ Fixes

• show_date not showing when show_time is false fix by @damongolding in #117
• Include exposure time by @damongolding in #121
• better yaml error handling by @damongolding in #122

Other changes

• add image ID to metadata by @damongolding in #123
• changeable kiosk port by @damongolding in #124

Full Changelog: v0.11.1...v0.11.2

v0.11.1

Pardon me, Guv'nor

Users can now use either "favorites" or "favourites" as an album keyword.

What's Changed

⚡ Fixes

• can use favorites or favourites for albums by @damongolding in #110

Full Changelog: v0.11.0...v0.11.1

v0.11.0

Warning

Breaking change

Kiosk now requires Immich version 1.117.0 or higher.

If you'd like to chat or need some informal help, feel free to find me on the Immich Discord! For any issues or suggestions, you can head over to GitHub.

---

UI themes

• The shadow behind the UI (now called the Fade theme) has been updated to be less intrusive.
• The "solid" theme has been added for those who would prefer a more standout UI.

Docs for themes

---

Layouts

• Added single layout that displays all images individually.
• Added splitview. Which displays 2 portrait images side by side vertically. Landscape and square images are displayed individually.

Docs for layouts

---

Sleep Mode

• Tell Kiosk to display a black screen and an optional clock (if show_time or show_date are enabled) between certain times.

Docs for sleep mode

---

Custom CSS

• Add your own CSS to Kiosk

Docs for custom css

---

Album keywords

• Added all keyword. A shortcut to uses all albums.
• Added shared keyword. A shortcut to uses all shared albums.
• Added favourites keyword. A shortcut to uses all favourited images.

Docs for albums keywords

---

Image Zoom effect

• Added image_zoom and image_zoom_amount.

Untitled.mp4

---

Clear Kiosk cache button

• Added a clear cache button to Kiosk's menu. Which will trigger a full clear of Kiosk cache and reload the current device.

---

What's Changed

⚠️ Breaking Changes

• Kiosk now requires Immich version 1.117.0 or higher
• Adding support for the new random API endpoint by @damongolding in #104

🚀 New Features

• UI themes by @damongolding in #97
• Layouts by @damongolding in #98
• Sleep mode by @damongolding in #100
• Layouts by @damongolding in #102
• Custom css feature by @damongolding in #103
• Album keyword favourites by @damongolding in #108
• Image zoom effect by @damongolding in #109

Full Changelog: v0.10.0...v0.11.0"

v0.10.0

What's Changed

Asset weighting

Kiosk now uses weighting when selecting assets. This means that if you have multiple sources, like different people or albums, the sources with fewer assets will appear less frequently.

Changing the base font size

You can now set the base font size for Kiosk using the font_size option. The default is 100 which equates to 16px, so setting font_size=200 sets the base font size to 32px. As all font sizing in Kiosk are relative to the base they will scale accordingly.

Kiosk is now on the Awesome self-hosted list

🚀 New Features

• Asset weighting by @damongolding
• Added base font size config options by @damongolding

⚡ Fixes

• Raw image endpoint fix by @damongolding
• Remove orphaned character in html causing scrollbars by @damongolding

Other changes

• Update README.md by @lennon101

New Contributors

• @lennon101 made their first contribution in #84

Full Changelog: v0.9.0...v0.10.0

v0.9.0

What's Changed

Pre fetch images

Kiosk now fetches images in the background, so when the refresh timer finishes Kiosk already has an image to serve. This makes Kiosk run much smoother. Can be turned off if desired.

Transition duration options

Added fade_transition_duration and cross_fade_transition_duration options so users can customise transition times.

🚀 New Features

• Added background image fetching by @damongolding in #80
• Transition duration config by @damongolding in #81
• Each device that connects to Kiosk now has a unique ID so Kiosk knows which device is.

🔨 Maintenance

• Updated licence from GNU to AGNU

Full Changelog: v0.8.1...v0.9.0

v0.8.1

What's Changed

🚀 New Features

• added show_archived option to config. Setting to true allows archived images to be displayed.

⚡ Fixes

• Refresh loop will only start once a image is fetched (this was causing the browser and server to be out of sync in some cases).
• Better support for older browsers (now uses Javascript ES6).

🔨 Maintenance

• Added Typescript for better type safety
• Added Esbuild to transpile down to ES6 and bundle JS and CSS

v0.8.0

What's Changed

Added show_image_exif option

Setting this to true will display the images f number, shutter speed, focal length, ISO if available.

Added show_image_location option

Setting this to true will display the images location if available.

Added a play/pause button to menu

For better UX

Moved refresh loop from Javascripts setInterval to requestAnimationFrame

The refresh loop and progress bar are now driven by requestAnimationFrame.
This is mainly for better control over the refresh loop and performance.

🚀 New Features

• Option to display image metadata (f number, shutter speed, focal length, ISO)
• Option to display location
• Play/pause button added to menu
• Refresh loop migrated from setInterval to animationFrame

⚡ Fixes

• Visible input on startup fix
• Fullscreen icon in menu no longer shows if browser does not support it
• Safari SVG not displaying fix

🔨 Maintenance

• UI is more friendly to smaller screens
• Setting KIOSK_DEBUG to true will add htmx event logs to the front end

v0.7.2

What's Changed

Fixed a error when using the password functionality after the move from a GET to a POST request in 0.7.0

⚡ Fixes

• look for password in correct data source

v0.7.1

What's Changed

Fix

This patch is mainly to fix the error shipped in 0.7.0 that caused the image refresh loop to stop working 😅

🚀 New Features

• Fullscreen icon now shows when Kiosk it paused (by clicking/tapping Kiosk) NOTE: This is mainly for desktop browsers and will most likely not work in mobile browsers.

⚡ Fixes

• Polling fix broken by 0.7.0 by @damongolding in #61

Other changes

• Add tag to enable fullscreen PWA on iOS by @njspix in #55
• Fixed typo in readme regarding docker env var for disabling screensaver by @rw15e in #56
• docs: update README.md by @eltociear in #58

New Contributors

• @njspix made their first contribution in #55
• @rw15e made their first contribution in #56
• @eltociear made their first contribution in #58