v0.13.1

Original images

If use_original_image is set to true but the original image format is not natively supported by browsers, Kiosk will automatically fall back to using the preview image.

What's Changed

⚡ Fixes

• Only use supported image types when use_original_image is set to true by @damongolding in #205

Other changes

• Typo in left/right arrows shortcuts by @Tyree in #184

New Contributors

• @Tyree made their first contribution in #184

Full Changelog: v0.13.0...v0.13.1

v0.13.0

Navigation Controls

You can interact with Kiosk in three ways: touch, mouse, or keyboard.

Touch & Click Zones

Kiosk's display is divided into interactive zones:

1. Left Side: Previous image(s)
2. Center top: Pause/Play and Toggle Menu
3. Right Side: Next image(s)

Keyboard Shortcuts

Key	Action
_ Spacebar	Play/Pause and Toggle Menu
← Left Arrow	Previous Image(s)
→ Right Arrow	Next Image(s)

---

show_image_description

Display image description from METADATA (if available).

---

use_original_image

Use the original image rather then the preview. NOTE: This will mostly likely cause kiosk to use more CPU and RAM resources.

---

fetched_assets_size

The number of assets (data) requested from Immich per api call. min=1 max=1000.

---

http_timeout

The number of seconds before an http request will time out.

---

frameless

Remove borders and rounded corners around images.

---

Clock screensaver in sleep mode

The clock will now change position periodically while on sleep mode (if enabled) to prevent screen burn.

---

What's Changed

🚀 New Features

• added image metadata description option by @damongolding in #175
• Added next/prev image navigation by @damongolding in #176
• added clock screensaver in sleep mode by @damongolding in #177
• added use_original_image setting by @damongolding in #179
• added option to limit fetched asset(s) data by @damongolding in #180

⚡ Fixes

• http request pooling by @damongolding in #161
• automatically lowercase config values by @damongolding in #162
• remove seconds from image metadata time (24hr) by @damongolding in #165
• remove prefixed comma in image metadata location by @damongolding in #166
• moved next/prev/control hit areas by @damongolding in #178
• portrait image displaying in splitview-landscape layout by @damongolding in #182

🔨 Maintenance

• http request improvements by @damongolding in #170

Full Changelog: v0.12.0...v0.13.0

v0.12.0

Warning

image_zoom has been deprecated.

---

image_effect

image_effect has replace image_zoom.

image_effect currently has two options. zoom and smart-zoom.

Zoom

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

Smart zoom

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

Docs for image_effect

---

Weather

Single view with weather

Splitview with weather

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

# config.yaml
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

Docs for weather

---

Hiding countries from image metadata.

This is useful if you don't want to display certain country names after setting show_image_location to true.

Example
I live in the UK, so most image location metadata looks something like Islington, London, United Kingdom. Adding the below to my config.yaml file would change that to Islington, London

hide_countries:
  - United Kingdom
  - United States of America

What's Changed

⚠️ Breaking Changes

• image_zoom has been replace with image_effect
• smart zoom by @damongolding in #146

🚀 New Features

• add weather data by @damongolding in #151

🔨 Maintenance

• Kiosk now gracefully shuts down

Other changes

• config watch fix by @damongolding in #142
• Hide Country Name by @contagon in #144
• Added some documentation for installation

New Contributors

• @contagon made their first contribution in #144

Full Changelog: v0.11.4...v0.12.0

v0.11.4

Quick fix for cases where using password would cause a 401 error on the refresh endpoint.

What's Changed

###⚡ Fixes

• refresh endpoint auth with password

📓 Documentation

• cleanup README for file mount and TZ by @mmomjian in #143

New Contributors

• @mmomjian made their first contribution in #143

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