ImmichKiosk

Docker 应用程序 from DamonGolding's Repository

概述

Immich Kiosk is a lightweight slideshow for running on kiosk devices and browsers that uses Immich as a data source.

要求

A reachable Immich server that is running version v1.127.0 or above. See the project page for more information: https://github.com/damongolding/immich-kiosk?tab=readme-ov-file

运行时参数

网络用户界面: http://[IP]:[PORT:3000]
网络: bridge
外壳: sh
特权: false

模板配置

LanguageVariable

The language code for Kiosk to use

目标: LANG
默认值: 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
价值: en_GB

TimezoneVariable

The timezone for Kiosk to use

目标: TZ
价值: Europe/London

Web UI PortPorttcp

Container Port: 3000

目标: 3000
默认值: 3000
价值: 3000

Config FilePathrw

Config file for application. Remove this if using environmental variables instead.

目标: /config.yaml
默认值: /mnt/user/appdata/immich_kiosk/config.yaml

Immich Api KeyVariable

The API for your Immich server.

目标: KIOSK_IMMICH_API_KEY

Immich UrlVariable

The URL of your Immich server. MUST include a port if one is needed e.g. `http://192.168.1.123:2283`.

目标: KIOSK_IMMICH_URL

Immich External UrlVariable

The public URL of your Immich server used for generating links and QR codes.

目标: KIOSK_IMMICH_EXTERNAL_URL

Show TimeVariable

Display clock.

目标: KIOSK_SHOW_TIME
默认值: false|true
价值: false

Time FormatVariable

Display clock time in either 12-hour or 24-hour format. This can either be 12 or 24.

目标: KIOSK_TIME_FORMAT
默认值: 24|12
价值: 24

Show DateVariable

Display the date.

目标: KIOSK_SHOW_DATE
默认值: false|true
价值: false

Date FormatVariable

The format of the date. default is day/month/year.

目标: KIOSK_DATE_FORMAT
默认值: DD/MM/YYYY
价值: DD/MM/YYYY

Clock SourceVariable

The source of the clock. Either client or server.

目标: KIOSK_CLOCK_SOURCE
默认值: client|server
价值: client

DurationVariable

The amount in seconds an image will be displayed for.

目标: KIOSK_DURATION
默认值: 60
价值: 60

Disable ScreensaverVariable

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.

目标: KIOSK_DISABLE_SCREENSAVER
默认值: false|true
价值: false

Optimize ImagesVariable

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.

目标: KIOSK_OPTIMIZE_IMAGES
默认值: false|true
价值: false

Use GpuVariable

Enable GPU acceleration for improved performance (e.g., CSS transforms)

目标: KIOSK_USE_GPU
默认值: true|false
价值: true

Show ArchivedVariable

Allow assets marked as archived to be displayed.

目标: KIOSK_SHOW_ARCHIVED
默认值: false|true
价值: false

AlbumsVariable

The ID(s) of one or more albums to display.

目标: KIOSK_ALBUMS

Album OrderVariable

The order an album's assets will be displayed.

目标: KIOSK_ALBUM_ORDER
默认值: random|newest|oldest
价值: random

Excluded AlbumsVariable

The ID(s) of a specific album or albums you want to exclude.

目标: KIOSK_EXCLUDED_ALBUMS

Show VideosVariable

Enable video playback.

目标: KIOSK_SHOW_VIDEOS
默认值: false|true
价值: false

Live PhotosVariable

Enable live photos playback for albums.

目标: KIOSK_LIVE_PHOTOS
默认值: false|true
价值: false

Live Photo Loop DelayVariable

Delay in seconds before looping live photos.

目标: KIOSK_LIVE_PHOTO_LOOP_DELAY
默认值: 0
价值: 0

PeopleVariable

The ID(s) of a specific person or people you want to display.

目标: KIOSK_PEOPLE

Require All PeopleVariable

Require all people to be present in an asset.

目标: KIOSK_REQUIRE_ALL_PEOPLE
默认值: false|true
价值: false

Excluded PeopleVariable

The ID(s) of a specific person or people you want to exclude.

目标: KIOSK_EXCLUDED_PEOPLE

DatesVariable

A date range or ranges.

目标: KIOSK_DATES

TagsVariable

Tag or tags you want to display.

目标: KIOSK_TAGS

Excluded TagsVariable

The tag or tags you want to exclude.

目标: KIOSK_EXCLUDED_TAGS

MemoriesVariable

Display memories.

目标: KIOSK_MEMORIES
默认值: false|true
价值: false

BlacklistVariable

The ID(s) of any specific assets you want Kiosk to skip/exclude from displaying.

目标: KIOSK_BLACKLIST

Date FilterVariable

Filter person and random assets by date.

目标: KIOSK_DATE_FILTER

Disable NavigationVariable

Disable all Kiosk's navigation (touch/click, keyboard and menu).

目标: KIOSK_DISABLE_NAVIGATION
默认值: false|true
价值: false

Disable UiVariable

A shortcut to set show_time, show_date, show_image_time and show_image_date to false.

目标: KIOSK_DISABLE_UI
默认值: false|true
价值: false

Menu PositionVariable

Sets the position of the menu bar.

目标: KIOSK_MENU_POSITION
默认值: top|bottom
价值: top

FramelessVariable

Remove borders and rounded corners on images.

目标: KIOSK_FRAMELESS
默认值: false|true
价值: false

Hide CursorVariable

Hide cursor/mouse via CSS.

目标: KIOSK_HIDE_CURSOR
默认值: false|true
价值: false

Font SizeVariable

The base font size for Kiosk. Default is 100% (16px). DO NOT include the % character.

目标: KIOSK_FONT_SIZE
默认值: 100
价值: 100

Background BlurVariable

Display a blurred version of the image as a background.

目标: KIOSK_BACKGROUND_BLUR
默认值: true|false
价值: true

Background Blur AmountVariable

The amount of blur to apply to the background image (sigma).

目标: KIOSK_BACKGROUND_BLUR_AMOUNT
默认值: 10
价值: 10

ThemeVariable

Which theme to use.

目标: KIOSK_THEME
默认值: fade|solid|bubble
价值: fade

LayoutVariable

Which layout to use.

目标: KIOSK_LAYOUT
默认值: single|portrait|landscape|splitview|splitview-landscape
价值: single

Sleep StartVariable

Time (in 24hr format) to start sleep mode.

目标: KIOSK_SLEEP_START

Sleep EndVariable

Time (in 24hr format) to end sleep mode.

目标: KIOSK_SLEEP_END

Sleep IconVariable

Display icon during sleep mode.

目标: KIOSK_SLEEP_ICON

Sleep Dim ScreenVariable

Dim screen during sleep mode when using Fully Kiosk Browser.

目标: KIOSK_SLEEP_DIM_SCREEN
默认值: false|true
价值: false

TransitionVariable

Which transition to use when changing images.

目标: KIOSK_TRANSITION
默认值: none|fade|cross-fade
价值: none

Fade Transition DurationVariable

The duration of the fade (in seconds) transition.

目标: KIOSK_FADE_TRANSITION_DURATION
默认值: 1
价值: 1

Cross Fade Transition DurationVariable

The duration of the cross-fade (in seconds) transition.

目标: KIOSK_CROSS_FADE_TRANSITION_DURATION
默认值: 1
价值: 1

Show Progress BarVariable

Display a progress bar for when image will refresh.

目标: KIOSK_SHOW_PROGRESS_BAR
默认值: false|true
价值: false

Progress Bar PositionVariable

Sets the position of the progress bar.

目标: KIOSK_PROGRESS_BAR_POSITION
默认值: top|bottom
价值: top

Image FitVariable

How the image should fit on the screen. Default is "contain".

目标: KIOSK_IMAGE_FIT
默认值: contain|cover|none
价值: contain

Image EffectVariable

Add an effect to images.

目标: KIOSK_IMAGE_EFFECT
默认值: none|zoom|smart-zoom
价值: none

Image Effect AmountVariable

Set the intensity of the image effect. Use a number between 100 (minimum) and higher, without the % symbol.

目标: KIOSK_IMAGE_EFFECT_AMOUNT
默认值: 120
价值: 120

Use Original ImageVariable

Use the original image. NOTE: If the original is not a png, gif, jpeg or webp Kiosk will fall back to using the preview.

目标: KIOSK_USE_ORIGINAL_IMAGE
默认值: false|true
价值: false

Show OwnerVariable

Display the asset owner. Useful for shared albums.

目标: KIOSK_SHOW_OWNER
默认值: false|true
价值: false

Show Album NameVariable

Display album names that the asset appears in.

目标: KIOSK_SHOW_ALBUM_NAME
默认值: false|true
价值: false

Show Person NameVariable

Display people's names.

目标: KIOSK_SHOW_PERSON_NAME
默认值: false|true
价值: false

Show Person AgeVariable

Display people's ages.

目标: KIOSK_SHOW_PERSON_AGE
默认值: false|true
价值: false

Show Image TimeVariable

Display image time from METADATA (if available).

目标: KIOSK_SHOW_IMAGE_TIME
默认值: false|true
价值: false

Image Time FormatVariable

Display image time in either 12-hour or 24-hour format. This can either be 12 or 24.

目标: KIOSK_IMAGE_TIME_FORMAT
默认值: 12|24
价值: 12

Show Image DateVariable

Display the image date from METADATA (if available).

目标: KIOSK_SHOW_IMAGE_DATE
默认值: false|true
价值: false

Image Date FormatVariable

The format of the image date. default is day/month/year.

目标: KIOSK_IMAGE_DATE_FORMAT
默认值: DD/MM/YYYY
价值: DD/MM/YYYY

Show Image DescriptionVariable

Display image description from METADATA (if available).

目标: KIOSK_SHOW_IMAGE_DESCRIPTION
默认值: false|true
价值: false

Show Image ExifVariable

Display image Fnumber, Shutter speed, focal length, ISO from METADATA (if available).

目标: KIOSK_SHOW_IMAGE_EXIF
默认值: false|true
价值: false

Show Image LocationVariable

Display the image location from METADATA (if available).

目标: KIOSK_SHOW_IMAGE_LOCATION
默认值: false|true
价值: false

Show Image QrVariable

Displays a QR code linking to the original image (in Immich) next to the image metadata.

目标: KIOSK_SHOW_IMAGE_QR
默认值: false|true
价值: false

Hide CountriesVariable

List of countries to hide from image_location

目标: KIOSK_HIDE_COUNTRIES

Show More InfoVariable

Enables the display of additional information about the current image(s)

目标: KIOSK_SHOW_MORE_INFO
默认值: true|false
价值: true

Show More Info Image LinkVariable

Shows a link to the original image (in Immich) in the additional information overlay

目标: KIOSK_SHOW_MORE_INFO_IMAGE_LINK
默认值: true|false
价值: true

Show More Info Qr CodeVariable

Displays a QR code linking to the original image (in Immich) in the additional information overlay

目标: KIOSK_SHOW_MORE_INFO_QR_CODE
默认值: true|false
价值: true

Like Button ActionVariable

Action(s) to perform when the like button is clicked. Supported actions are [favorite, album].

目标: KIOSK_LIKE_BUTTON_ACTION
价值: [favorite]

Hide Button ActionVariable

Action(s) to perform when the hide button is clicked. Supported actions are [tag, archive].

目标: KIOSK_HIDE_BUTTON_ACTION
价值: [tag, archive]

Show UserVariable

Display the user used to fetch the image.

目标: KIOSK_SHOW_USER
默认值: false|true
价值: false

Use Offline ModeVariable

Enable offline mode for the device.

目标: KIOSK_USE_OFFLINE_MODE
默认值: false|true
价值: false

IframeVariable

Add iframes into Kiosk.

目标: KIOSK_IFRAME

Config Validation LevelVariable

The level of validation to perform on the config.yaml file.

目标: KIOSK_CONFIG_VALIDATION_LEVEL
默认值: error|warning|off
价值: error

PortVariable

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`

目标: KIOSK_PORT
默认值: 3000
价值: 3000

Behind ProxyVariable

Is Kiosk running behind a proxy?

目标: KIOSK_BEHIND_PROXY
默认值: false|true
价值: false

Watch ConfigVariable

Should Kiosk watch config.yaml file for changes. Reloads all connect clients if a change is detected.

目标: KIOSK_WATCH_CONFIG
默认值: false|true
价值: false

Fetched Assets SizeVariable

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

目标: KIOSK_FETCHED_ASSETS_SIZE
默认值: 1000
价值: 1000

Http TimeoutVariable

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

目标: KIOSK_HTTP_TIMEOUT
默认值: 20
价值: 20

PasswordVariable

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`.

目标: KIOSK_PASSWORD

CacheVariable

Cache selective Immich api calls to reduce unnecessary calls.

目标: KIOSK_CACHE
默认值: true|false
价值: true

PrefetchVariable

Pre-fetch assets in the background, so images load much quicker when duration timer ends.

目标: KIOSK_PREFETCH
默认值: true|false
价值: true

Asset WeightingVariable

Balances asset selection when multiple sources are used, e.g. multiple people and albums. When enabled, sources with fewer assets will show less often.

目标: KIOSK_ASSET_WEIGHTING
默认值: true|false
价值: true