Immich-Kiosk
Immich-Kiosk
Docker app from grtgbln's Repository
Overview
Requirements
Requires a separate Immich server. Container requires a "config.yaml" file at the "Config File" path BEFORE starting if using config file; otherwise use environmental variables. See the project page for more information: https://github.com/damongolding/immich-kiosk?tab=readme-ov-file#configuration
Runtime arguments
- Web UI
http://[IP]:[PORT:3000]- Network
bridge- Privileged
- false
Template configuration
Container Port: 3000
- Target
- 3000
- Default
- 3000
- Value
- 3000
Config file for application. Remove this if using environmental variables instead.
- Target
- /config.yaml
- Default
- /mnt/user/appdata/immich_kiosk/config.yaml
- Value
- /mnt/user/appdata/immich_kiosk/config.yaml
The URL to the Immich Server
- Target
- KIOSK_IMMICH_URL
The API for your Immich server
- Target
- KIOSK_IMMICH_API_KEY
A shortcut to set KIOSK_SHOW_TIME, KIOSK_SHOW_DATE, KIOSK_SHOW_IMAGE_TIME and KIOSK_SHOW_IMAGE_DATE
- Target
- KIOSK_DISABLE_UI
- Default
- false|true
Display current time
- Target
- KIOSK_SHOW_TIME
- Default
- true|false
Display current time in either 12-hour or 24-hour format
- Target
- KIOSK_TIME_FORMAT
- Default
- 12|24
Display the current date
- Target
- KIOSK_SHOW_DATE
- Default
- true|false
The format of the current date. Any GO date string is valid
- Target
- KIOSK_DATE_FORMAT
- Default
- DD/MM/YYYY
- Value
- DD/MM/YYYY
The amount in seconds a image will be displayed for
- Target
- KIOSK_REFRESH
- Default
- 60
- Value
- 60
The ID(s) of a specific album or albums you want to display. See FAQ: How do I set multiple albums? to see how to implement this
- Target
- KIOSK_ALBUM
The ID(s) of a specific person or people you want to display. See FAQ: How do I set multiple people? to see how to implement this
- Target
- KIOSK_PERSON
How your image will fit on the screen. Default is contain. See Image fit for more info
- Target
- KIOSK_IMAGE_FIT
- Default
- contain|cover|none
Display a blurred version of the image as a background
- Target
- KIOSK_BACKGROUND_BLUR
- Default
- true|false
Which transition to use when changing images
- Target
- KIOSK_TRANSITION
- Default
- none|fade|cross-fade
Display a progress bar for when image will refresh
- Target
- KIOSK_SHOW_PROGRESS
- Default
- true|false
Display image time from metadata (if available)
- Target
- KIOSK_SHOW_IMAGE_TIME
- Default
- true|false
Display image time in either 12-hour or 24-hour format
- Target
- KIOSK_IMAGE_TIME_FORMAT
- Default
- 12|24
Display the image date from metadata (if available)
- Target
- KIOSK_SHOW_IMAGE_DATE
- Default
- true|false
The format of the image date. default is day/month/year. Any GO date string is valid.
- Target
- KIOSK_IMAGE_DATE_FORMAT
- Default
- DD/MM/YYYY
- Value
- DD/MM/YYYY
See FAQs for more info. If set, requests must contain the password in the GET parameters e.g. http://192.168.0.123:3000?password=PASSWORD.
- Target
- KIOSK_PASSWORD
Cache selective Immich api calls to reduce unnecessary calls
- Target
- KIOSK_CACHE
- Default
- true|false
Categories
Download Statistics
Total Downloads Over Time
Details
damongolding/immich-kiosk:latestRun Immich-Kiosk on Unraid.
Immich-Kiosk is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.