All apps · 0 apps
ImmichKiosk
Docker app from DamonGolding's Repository
Overview
Readme
View on GitHubImmich Kiosk
Links
What is Immich Kiosk?
Highly configurable slideshows for displaying Immich assets on browsers and devices.
[!IMPORTANT] This project is not affiliated with Immich
Support
If this project has been helpful to you and you wish to support me, you can do so with the button below 🙂.
Help
If you have found a bug or have an issue you can submit it here.
If you'd like to chat or need some informal help, feel free to find me in the Kiosk channel on the Immich discord server.
AI usage
Immich Kiosk is hand-curated without any direct AI assistance.
We use CodeRabbit to review code changes, but it is mainly used to provide feedback (which is often ignored), catch bugs, and fix my many typos.
Install ImmichKiosk on Unraid in a few clicks.
Find ImmichKiosk in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.
Requirements
Categories
Download Statistics
Total Downloads Over Time
Related apps
Explore more like this
Explore allDetails
ghcr.io/damongolding/immich-kiosk:latestRuntime arguments
- Web UI
http://[IP]:[PORT:3000]- Network
bridge- Shell
sh- Privileged
- false
Template configuration
The language code for Kiosk to use
- Target
- LANG
- Default
- en_US|en_GB|da_DK|nl_BE|nl_NL|fi_FI|fr_FR|fr_CA|de_DE|hu_HU|it_IT|nn_NO|nb_NO|pl_PL|pt_PT|pt_BR|ro_RO|ru_RU|es_ES|ca_ES|sv_SE|tr_TR|uk_UA|bg_BG|zh_CN|zh_TW|zh_HK|ko_KR|ja_JP|el_GR|id_ID|fr_GP|fr_LU|fr_MQ|fr_GF|fr_RE|cs_CZ|sl_SI|lt_LT|et_EE|hr_HR|lv_LV|sk_SK|th_TH|uz_UZ|kk_KZ
- Value
- en_GB
The timezone for Kiosk to use
- Target
- TZ
- Value
- Europe/London
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
The API for your Immich server.
- Target
- KIOSK_IMMICH_API_KEY
The URL of your Immich server. MUST include a port if one is needed e.g. `http://192.168.1.123:2283`.
- Target
- KIOSK_IMMICH_URL
The public URL of your Immich server used for generating links and QR codes.
- Target
- KIOSK_IMMICH_EXTERNAL_URL
Display clock.
- Target
- KIOSK_SHOW_TIME
- Default
- false|true
- Value
- false
Display clock time in either 12-hour or 24-hour format. This can either be 12 or 24.
- Target
- KIOSK_TIME_FORMAT
- Default
- 24|12
- Value
- 24
Display the date.
- Target
- KIOSK_SHOW_DATE
- Default
- false|true
- Value
- false
The format of the date. default is day/month/year.
- Target
- KIOSK_DATE_FORMAT
- Default
- DD/MM/YYYY
- Value
- DD/MM/YYYY
The source of the clock. Either client or server.
- Target
- KIOSK_CLOCK_SOURCE
- Default
- client|server
- Value
- client
The amount in seconds an image will be displayed for.
- Target
- KIOSK_DURATION
- Default
- 60
- Value
- 60
Ask browser to request a lock that prevents device screens from dimming or locking. NOTE: I haven't been able to get this to work consistently on IOS.
- Target
- KIOSK_DISABLE_SCREENSAVER
- Default
- false|true
- Value
- false
Whether Kiosk should resize images to match your browser screen dimensions for better performance. NOTE: In most cases this is not necessary, but if you are accessing Kiosk on a low-powered device, this may help.
- Target
- KIOSK_OPTIMIZE_IMAGES
- Default
- false|true
- Value
- false
Enable GPU acceleration for improved performance (e.g., CSS transforms)
- Target
- KIOSK_USE_GPU
- Default
- true|false
- Value
- true
Allow assets marked as archived to be displayed.
- Target
- KIOSK_SHOW_ARCHIVED
- Default
- false|true
- Value
- false
The ID(s) of one or more albums to display.
- Target
- KIOSK_ALBUMS
The order an album's assets will be displayed.
- Target
- KIOSK_ALBUM_ORDER
- Default
- random|newest|oldest
- Value
- random
The ID(s) of a specific album or albums you want to exclude.
- Target
- KIOSK_EXCLUDED_ALBUMS
Enable video playback.
- Target
- KIOSK_SHOW_VIDEOS
- Default
- false|true
- Value
- false
Enable live photos playback for albums.
- Target
- KIOSK_LIVE_PHOTOS
- Default
- false|true
- Value
- false
Delay in seconds before looping live photos.
- Target
- KIOSK_LIVE_PHOTO_LOOP_DELAY
- Default
- 0
- Value
- 0
The ID(s) of a specific person or people you want to display.
- Target
- KIOSK_PEOPLE
Require all people to be present in an asset.
- Target
- KIOSK_REQUIRE_ALL_PEOPLE
- Default
- false|true
- Value
- false
The ID(s) of a specific person or people you want to exclude.
- Target
- KIOSK_EXCLUDED_PEOPLE
A date range or ranges.
- Target
- KIOSK_DATES
Tag or tags you want to display.
- Target
- KIOSK_TAGS
The tag or tags you want to exclude.
- Target
- KIOSK_EXCLUDED_TAGS
Display memories.
- Target
- KIOSK_MEMORIES
- Default
- false|true
- Value
- false
The ID(s) of any specific assets you want Kiosk to skip/exclude from displaying.
- Target
- KIOSK_BLACKLIST
Filter person and random assets by date.
- Target
- KIOSK_DATE_FILTER
Disable all Kiosk's navigation (touch/click, keyboard and menu).
- Target
- KIOSK_DISABLE_NAVIGATION
- Default
- false|true
- Value
- false
A shortcut to set show_time, show_date, show_image_time and show_image_date to false.
- Target
- KIOSK_DISABLE_UI
- Default
- false|true
- Value
- false
Sets the position of the menu bar.
- Target
- KIOSK_MENU_POSITION
- Default
- top|bottom
- Value
- top
Remove borders and rounded corners on images.
- Target
- KIOSK_FRAMELESS
- Default
- false|true
- Value
- false
Hide cursor/mouse via CSS.
- Target
- KIOSK_HIDE_CURSOR
- Default
- false|true
- Value
- false
The base font size for Kiosk. Default is 100% (16px). DO NOT include the % character.
- Target
- KIOSK_FONT_SIZE
- Default
- 100
- Value
- 100
Display a blurred version of the image as a background.
- Target
- KIOSK_BACKGROUND_BLUR
- Default
- true|false
- Value
- true
The amount of blur to apply to the background image (sigma).
- Target
- KIOSK_BACKGROUND_BLUR_AMOUNT
- Default
- 10
- Value
- 10
Which theme to use.
- Target
- KIOSK_THEME
- Default
- fade|solid|bubble
- Value
- fade
Which layout to use.
- Target
- KIOSK_LAYOUT
- Default
- single|portrait|landscape|splitview|splitview-landscape
- Value
- single
Time (in 24hr format) to start sleep mode.
- Target
- KIOSK_SLEEP_START
Time (in 24hr format) to end sleep mode.
- Target
- KIOSK_SLEEP_END
Display icon during sleep mode.
- Target
- KIOSK_SLEEP_ICON
Dim screen during sleep mode when using Fully Kiosk Browser.
- Target
- KIOSK_SLEEP_DIM_SCREEN
- Default
- false|true
- Value
- false
Which transition to use when changing images.
- Target
- KIOSK_TRANSITION
- Default
- none|fade|cross-fade
- Value
- none
The duration of the fade (in seconds) transition.
- Target
- KIOSK_FADE_TRANSITION_DURATION
- Default
- 1
- Value
- 1
The duration of the cross-fade (in seconds) transition.
- Target
- KIOSK_CROSS_FADE_TRANSITION_DURATION
- Default
- 1
- Value
- 1
Display a progress bar for when image will refresh.
- Target
- KIOSK_SHOW_PROGRESS_BAR
- Default
- false|true
- Value
- false
Sets the position of the progress bar.
- Target
- KIOSK_PROGRESS_BAR_POSITION
- Default
- top|bottom
- Value
- top
How the image should fit on the screen. Default is "contain".
- Target
- KIOSK_IMAGE_FIT
- Default
- contain|cover|none
- Value
- contain
Add an effect to images.
- Target
- KIOSK_IMAGE_EFFECT
- Default
- none|zoom|smart-zoom
- Value
- none
Set the intensity of the image effect. Use a number between 100 (minimum) and higher, without the % symbol.
- Target
- KIOSK_IMAGE_EFFECT_AMOUNT
- Default
- 120
- Value
- 120
Use the original image. NOTE: If the original is not a png, gif, jpeg or webp Kiosk will fall back to using the preview.
- Target
- KIOSK_USE_ORIGINAL_IMAGE
- Default
- false|true
- Value
- false
Display the asset owner. Useful for shared albums.
- Target
- KIOSK_SHOW_OWNER
- Default
- false|true
- Value
- false
Display album names that the asset appears in.
- Target
- KIOSK_SHOW_ALBUM_NAME
- Default
- false|true
- Value
- false
Display people's names.
- Target
- KIOSK_SHOW_PERSON_NAME
- Default
- false|true
- Value
- false
Display people's ages.
- Target
- KIOSK_SHOW_PERSON_AGE
- Default
- false|true
- Value
- false
Display image time from METADATA (if available).
- Target
- KIOSK_SHOW_IMAGE_TIME
- Default
- false|true
- Value
- false
Display image time in either 12-hour or 24-hour format. This can either be 12 or 24.
- Target
- KIOSK_IMAGE_TIME_FORMAT
- Default
- 12|24
- Value
- 12
Display the image date from METADATA (if available).
- Target
- KIOSK_SHOW_IMAGE_DATE
- Default
- false|true
- Value
- false
The format of the image date. default is day/month/year.
- Target
- KIOSK_IMAGE_DATE_FORMAT
- Default
- DD/MM/YYYY
- Value
- DD/MM/YYYY
Display image description from METADATA (if available).
- Target
- KIOSK_SHOW_IMAGE_DESCRIPTION
- Default
- false|true
- Value
- false
Display image Fnumber, Shutter speed, focal length, ISO from METADATA (if available).
- Target
- KIOSK_SHOW_IMAGE_EXIF
- Default
- false|true
- Value
- false
Display the image location from METADATA (if available).
- Target
- KIOSK_SHOW_IMAGE_LOCATION
- Default
- false|true
- Value
- false
Displays a QR code linking to the original image (in Immich) next to the image metadata.
- Target
- KIOSK_SHOW_IMAGE_QR
- Default
- false|true
- Value
- false
List of countries to hide from image_location
- Target
- KIOSK_HIDE_COUNTRIES
Enables the display of additional information about the current image(s)
- Target
- KIOSK_SHOW_MORE_INFO
- Default
- true|false
- Value
- true
Shows a link to the original image (in Immich) in the additional information overlay
- Target
- KIOSK_SHOW_MORE_INFO_IMAGE_LINK
- Default
- true|false
- Value
- true
Displays a QR code linking to the original image (in Immich) in the additional information overlay
- Target
- KIOSK_SHOW_MORE_INFO_QR_CODE
- Default
- true|false
- Value
- true
Action(s) to perform when the like button is clicked. Supported actions are [favorite, album].
- Target
- KIOSK_LIKE_BUTTON_ACTION
- Value
- [favorite]
Action(s) to perform when the hide button is clicked. Supported actions are [tag, archive].
- Target
- KIOSK_HIDE_BUTTON_ACTION
- Value
- [tag, archive]
Display the user used to fetch the image.
- Target
- KIOSK_SHOW_USER
- Default
- false|true
- Value
- false
Enable offline mode for the device.
- Target
- KIOSK_USE_OFFLINE_MODE
- Default
- false|true
- Value
- false
Add iframes into Kiosk.
- Target
- KIOSK_IFRAME
The level of validation to perform on the config.yaml file.
- Target
- KIOSK_CONFIG_VALIDATION_LEVEL
- Default
- error|warning|off
- Value
- error
Which port Kiosk should use. NOTE: This is only typically needed when running Kiosk outside of a container. If you are running inside a container the port will need to be reflected in your compose file, e.g. `HOST_PORT:KIOSK_PORT`
- Target
- KIOSK_PORT
- Default
- 3000
- Value
- 3000
Is Kiosk running behind a proxy?
- Target
- KIOSK_BEHIND_PROXY
- Default
- false|true
- Value
- false
Should Kiosk watch config.yaml file for changes. Reloads all connect clients if a change is detected.
- Target
- KIOSK_WATCH_CONFIG
- Default
- false|true
- Value
- false
The number of assets (data) requested from Immich per api call. min=1 max=1000.
- Target
- KIOSK_FETCHED_ASSETS_SIZE
- Default
- 1000
- Value
- 1000
The number of seconds before an http request will time out.
- Target
- KIOSK_HTTP_TIMEOUT
- Default
- 20
- Value
- 20
Please 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
- Value
- true
Pre-fetch assets in the background, so images load much quicker when duration timer ends.
- Target
- KIOSK_PREFETCH
- Default
- true|false
- Value
- true
Balances asset selection when multiple sources are used, e.g. multiple people and albums. When enabled, sources with fewer assets will show less often.
- Target
- KIOSK_ASSET_WEIGHTING
- Default
- true|false
- Value
- true