ImmichKiosk
Aplicación Docker from DamonGolding's Repository
Visión general
Requisitos
Argumentos en tiempo de ejecución
- Interfaz web
http://[IP]:[PORT:3000]- Red
bridge- Concha
sh- Privilegiado
- false
Configuración de plantillas
The language code for Kiosk to use
- Objetivo
- LANG
- Por defecto
- 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
- Valor
- en_GB
The timezone for Kiosk to use
- Objetivo
- TZ
- Valor
- Europe/London
Container Port: 3000
- Objetivo
- 3000
- Por defecto
- 3000
- Valor
- 3000
Config file for application. Remove this if using environmental variables instead.
- Objetivo
- /config.yaml
- Por defecto
- /mnt/user/appdata/immich_kiosk/config.yaml
The API for your Immich server.
- Objetivo
- 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`.
- Objetivo
- KIOSK_IMMICH_URL
The public URL of your Immich server used for generating links and QR codes.
- Objetivo
- KIOSK_IMMICH_EXTERNAL_URL
Display clock.
- Objetivo
- KIOSK_SHOW_TIME
- Por defecto
- false|true
- Valor
- false
Display clock time in either 12-hour or 24-hour format. This can either be 12 or 24.
- Objetivo
- KIOSK_TIME_FORMAT
- Por defecto
- 24|12
- Valor
- 24
Display the date.
- Objetivo
- KIOSK_SHOW_DATE
- Por defecto
- false|true
- Valor
- false
The format of the date. default is day/month/year.
- Objetivo
- KIOSK_DATE_FORMAT
- Por defecto
- DD/MM/YYYY
- Valor
- DD/MM/YYYY
The source of the clock. Either client or server.
- Objetivo
- KIOSK_CLOCK_SOURCE
- Por defecto
- client|server
- Valor
- client
The amount in seconds an image will be displayed for.
- Objetivo
- KIOSK_DURATION
- Por defecto
- 60
- Valor
- 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.
- Objetivo
- KIOSK_DISABLE_SCREENSAVER
- Por defecto
- false|true
- Valor
- 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.
- Objetivo
- KIOSK_OPTIMIZE_IMAGES
- Por defecto
- false|true
- Valor
- false
Enable GPU acceleration for improved performance (e.g., CSS transforms)
- Objetivo
- KIOSK_USE_GPU
- Por defecto
- true|false
- Valor
- true
Allow assets marked as archived to be displayed.
- Objetivo
- KIOSK_SHOW_ARCHIVED
- Por defecto
- false|true
- Valor
- false
The ID(s) of one or more albums to display.
- Objetivo
- KIOSK_ALBUMS
The order an album's assets will be displayed.
- Objetivo
- KIOSK_ALBUM_ORDER
- Por defecto
- random|newest|oldest
- Valor
- random
The ID(s) of a specific album or albums you want to exclude.
- Objetivo
- KIOSK_EXCLUDED_ALBUMS
Enable video playback.
- Objetivo
- KIOSK_SHOW_VIDEOS
- Por defecto
- false|true
- Valor
- false
Enable live photos playback for albums.
- Objetivo
- KIOSK_LIVE_PHOTOS
- Por defecto
- false|true
- Valor
- false
Delay in seconds before looping live photos.
- Objetivo
- KIOSK_LIVE_PHOTO_LOOP_DELAY
- Por defecto
- 0
- Valor
- 0
The ID(s) of a specific person or people you want to display.
- Objetivo
- KIOSK_PEOPLE
Require all people to be present in an asset.
- Objetivo
- KIOSK_REQUIRE_ALL_PEOPLE
- Por defecto
- false|true
- Valor
- false
The ID(s) of a specific person or people you want to exclude.
- Objetivo
- KIOSK_EXCLUDED_PEOPLE
A date range or ranges.
- Objetivo
- KIOSK_DATES
Tag or tags you want to display.
- Objetivo
- KIOSK_TAGS
The tag or tags you want to exclude.
- Objetivo
- KIOSK_EXCLUDED_TAGS
Display memories.
- Objetivo
- KIOSK_MEMORIES
- Por defecto
- false|true
- Valor
- false
The ID(s) of any specific assets you want Kiosk to skip/exclude from displaying.
- Objetivo
- KIOSK_BLACKLIST
Filter person and random assets by date.
- Objetivo
- KIOSK_DATE_FILTER
Disable all Kiosk's navigation (touch/click, keyboard and menu).
- Objetivo
- KIOSK_DISABLE_NAVIGATION
- Por defecto
- false|true
- Valor
- false
A shortcut to set show_time, show_date, show_image_time and show_image_date to false.
- Objetivo
- KIOSK_DISABLE_UI
- Por defecto
- false|true
- Valor
- false
Sets the position of the menu bar.
- Objetivo
- KIOSK_MENU_POSITION
- Por defecto
- top|bottom
- Valor
- top
Remove borders and rounded corners on images.
- Objetivo
- KIOSK_FRAMELESS
- Por defecto
- false|true
- Valor
- false
Hide cursor/mouse via CSS.
- Objetivo
- KIOSK_HIDE_CURSOR
- Por defecto
- false|true
- Valor
- false
The base font size for Kiosk. Default is 100% (16px). DO NOT include the % character.
- Objetivo
- KIOSK_FONT_SIZE
- Por defecto
- 100
- Valor
- 100
Display a blurred version of the image as a background.
- Objetivo
- KIOSK_BACKGROUND_BLUR
- Por defecto
- true|false
- Valor
- true
The amount of blur to apply to the background image (sigma).
- Objetivo
- KIOSK_BACKGROUND_BLUR_AMOUNT
- Por defecto
- 10
- Valor
- 10
Which theme to use.
- Objetivo
- KIOSK_THEME
- Por defecto
- fade|solid|bubble
- Valor
- fade
Which layout to use.
- Objetivo
- KIOSK_LAYOUT
- Por defecto
- single|portrait|landscape|splitview|splitview-landscape
- Valor
- single
Time (in 24hr format) to start sleep mode.
- Objetivo
- KIOSK_SLEEP_START
Time (in 24hr format) to end sleep mode.
- Objetivo
- KIOSK_SLEEP_END
Display icon during sleep mode.
- Objetivo
- KIOSK_SLEEP_ICON
Dim screen during sleep mode when using Fully Kiosk Browser.
- Objetivo
- KIOSK_SLEEP_DIM_SCREEN
- Por defecto
- false|true
- Valor
- false
Which transition to use when changing images.
- Objetivo
- KIOSK_TRANSITION
- Por defecto
- none|fade|cross-fade
- Valor
- none
The duration of the fade (in seconds) transition.
- Objetivo
- KIOSK_FADE_TRANSITION_DURATION
- Por defecto
- 1
- Valor
- 1
The duration of the cross-fade (in seconds) transition.
- Objetivo
- KIOSK_CROSS_FADE_TRANSITION_DURATION
- Por defecto
- 1
- Valor
- 1
Display a progress bar for when image will refresh.
- Objetivo
- KIOSK_SHOW_PROGRESS_BAR
- Por defecto
- false|true
- Valor
- false
Sets the position of the progress bar.
- Objetivo
- KIOSK_PROGRESS_BAR_POSITION
- Por defecto
- top|bottom
- Valor
- top
How the image should fit on the screen. Default is "contain".
- Objetivo
- KIOSK_IMAGE_FIT
- Por defecto
- contain|cover|none
- Valor
- contain
Add an effect to images.
- Objetivo
- KIOSK_IMAGE_EFFECT
- Por defecto
- none|zoom|smart-zoom
- Valor
- none
Set the intensity of the image effect. Use a number between 100 (minimum) and higher, without the % symbol.
- Objetivo
- KIOSK_IMAGE_EFFECT_AMOUNT
- Por defecto
- 120
- Valor
- 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.
- Objetivo
- KIOSK_USE_ORIGINAL_IMAGE
- Por defecto
- false|true
- Valor
- false
Display the asset owner. Useful for shared albums.
- Objetivo
- KIOSK_SHOW_OWNER
- Por defecto
- false|true
- Valor
- false
Display album names that the asset appears in.
- Objetivo
- KIOSK_SHOW_ALBUM_NAME
- Por defecto
- false|true
- Valor
- false
Display people's names.
- Objetivo
- KIOSK_SHOW_PERSON_NAME
- Por defecto
- false|true
- Valor
- false
Display people's ages.
- Objetivo
- KIOSK_SHOW_PERSON_AGE
- Por defecto
- false|true
- Valor
- false
Display image time from METADATA (if available).
- Objetivo
- KIOSK_SHOW_IMAGE_TIME
- Por defecto
- false|true
- Valor
- false
Display image time in either 12-hour or 24-hour format. This can either be 12 or 24.
- Objetivo
- KIOSK_IMAGE_TIME_FORMAT
- Por defecto
- 12|24
- Valor
- 12
Display the image date from METADATA (if available).
- Objetivo
- KIOSK_SHOW_IMAGE_DATE
- Por defecto
- false|true
- Valor
- false
The format of the image date. default is day/month/year.
- Objetivo
- KIOSK_IMAGE_DATE_FORMAT
- Por defecto
- DD/MM/YYYY
- Valor
- DD/MM/YYYY
Display image description from METADATA (if available).
- Objetivo
- KIOSK_SHOW_IMAGE_DESCRIPTION
- Por defecto
- false|true
- Valor
- false
Display image Fnumber, Shutter speed, focal length, ISO from METADATA (if available).
- Objetivo
- KIOSK_SHOW_IMAGE_EXIF
- Por defecto
- false|true
- Valor
- false
Display the image location from METADATA (if available).
- Objetivo
- KIOSK_SHOW_IMAGE_LOCATION
- Por defecto
- false|true
- Valor
- false
Displays a QR code linking to the original image (in Immich) next to the image metadata.
- Objetivo
- KIOSK_SHOW_IMAGE_QR
- Por defecto
- false|true
- Valor
- false
List of countries to hide from image_location
- Objetivo
- KIOSK_HIDE_COUNTRIES
Enables the display of additional information about the current image(s)
- Objetivo
- KIOSK_SHOW_MORE_INFO
- Por defecto
- true|false
- Valor
- true
Shows a link to the original image (in Immich) in the additional information overlay
- Objetivo
- KIOSK_SHOW_MORE_INFO_IMAGE_LINK
- Por defecto
- true|false
- Valor
- true
Displays a QR code linking to the original image (in Immich) in the additional information overlay
- Objetivo
- KIOSK_SHOW_MORE_INFO_QR_CODE
- Por defecto
- true|false
- Valor
- true
Action(s) to perform when the like button is clicked. Supported actions are [favorite, album].
- Objetivo
- KIOSK_LIKE_BUTTON_ACTION
- Valor
- [favorite]
Action(s) to perform when the hide button is clicked. Supported actions are [tag, archive].
- Objetivo
- KIOSK_HIDE_BUTTON_ACTION
- Valor
- [tag, archive]
Display the user used to fetch the image.
- Objetivo
- KIOSK_SHOW_USER
- Por defecto
- false|true
- Valor
- false
Enable offline mode for the device.
- Objetivo
- KIOSK_USE_OFFLINE_MODE
- Por defecto
- false|true
- Valor
- false
Add iframes into Kiosk.
- Objetivo
- KIOSK_IFRAME
The level of validation to perform on the config.yaml file.
- Objetivo
- KIOSK_CONFIG_VALIDATION_LEVEL
- Por defecto
- error|warning|off
- Valor
- 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`
- Objetivo
- KIOSK_PORT
- Por defecto
- 3000
- Valor
- 3000
Is Kiosk running behind a proxy?
- Objetivo
- KIOSK_BEHIND_PROXY
- Por defecto
- false|true
- Valor
- false
Should Kiosk watch config.yaml file for changes. Reloads all connect clients if a change is detected.
- Objetivo
- KIOSK_WATCH_CONFIG
- Por defecto
- false|true
- Valor
- false
The number of assets (data) requested from Immich per api call. min=1 max=1000.
- Objetivo
- KIOSK_FETCHED_ASSETS_SIZE
- Por defecto
- 1000
- Valor
- 1000
The number of seconds before an http request will time out.
- Objetivo
- KIOSK_HTTP_TIMEOUT
- Por defecto
- 20
- Valor
- 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`.
- Objetivo
- KIOSK_PASSWORD
Cache selective Immich api calls to reduce unnecessary calls.
- Objetivo
- KIOSK_CACHE
- Por defecto
- true|false
- Valor
- true
Pre-fetch assets in the background, so images load much quicker when duration timer ends.
- Objetivo
- KIOSK_PREFETCH
- Por defecto
- true|false
- Valor
- 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.
- Objetivo
- KIOSK_ASSET_WEIGHTING
- Por defecto
- true|false
- Valor
- true
Categorías
Descargar estadísticas
Descargas totales a lo largo del tiempo
Detalles
ghcr.io/damongolding/immich-kiosk:latestEjecute ImmichKiosk en Unraid.
ImmichKiosk se encuentra en Community Apps para Unraid OS. Explore Unraid para crear un servidor doméstico flexible, un NAS o un laboratorio doméstico.