damongolding/immich-kiosk v0.5.0 on GitHub

What's Changed

Note

I am still on paternity leave with my little one but I found a little time to finish these features off!
If you find any bugs, feel free to raise an issue 🙂

Password

You can now secure access to Kiosk using a password.

Q: How do I set a password?
A: 👇

via config.yaml file

kiosk:
  password: 12345

via ENV in your docker-compose file

environment:
  KIOSK_PASSWORD: "12345"

Then to access Kiosk you MUST add the password param in your URL e.g. http://{URL}?password=12345

Caching

Kiosk now uses caching for some of it's API calls. At the moment it will cache calls for people and album assets. The cache is stored/used for 5 minutes. This is on by default but you can disable it via the config.yaml file or via ENV.

config.yaml

kiosk:
  cache: false

ENV

environment:
  KIOSK_CACHE: FALSE

Multiple albums

You can now add multiple albums just like you can add multiple people.

Q: How do I set multiple albums?
A: 👇

via config.yaml file

album:
  - ALBUM_ID
  - ALBUM_ID

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

environment:
  KIOSK_ALBUM: "ALBUM_ID,ALBUM_ID,ALBUM_ID"

via url quires http://{URL}?album=ALBUM_ID&album=ALBUM_ID&album=ALBUM_ID

🚀 New Features

Adding authentication to front end (password) by @damongolding in #33
Person and Album Api endpoint caching by @damongolding in #34
Use multiple albums by @damongolding in #35

Full Changelog: v0.4.1...v0.5.0