Immich Kiosk

https://docs.immichkiosk.app
Admin
Immich Kiosk is a highly customizable kiosk application that displays photos and videos from Immich...
Tokens:35,853
Snippets:551
Trust Score:5.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install and launch ImmichFrame

Source: https://docs.immichkiosk.app/misc/frameo

Commands to install and start the ImmichFrame application.

```bash
adb install path/to/downloaded/immichframe.apk
```

```bash
adb shell am start -n com.immichframe.immichframe/.MainActivity
```

--------------------------------

### Install and launch Fully Kiosk Browser

Source: https://docs.immichkiosk.app/misc/frameo

Commands to install and start the Fully Kiosk Browser application.

```bash
adb install path/to/downloaded/Fully-Kiosk-Browser.apk
```

```bash
adb shell am start -n de.ozerov.fully/.MainActivity
```

--------------------------------

### Download Configuration File

Source: https://docs.immichkiosk.app/installation

Create the configuration directory and download the example config.yaml file.

```bash
mkdir ./config
wget -O ./config/config.yaml https://raw.githubusercontent.com/damongolding/immich-kiosk/refs/heads/main/config.example.yaml
```

```bash
mkdir ./config
curl -o ./config/config.yaml https://raw.githubusercontent.com/damongolding/immich-kiosk/refs/heads/main/config.example.yaml
```

--------------------------------

### Create Kiosk Directory

Source: https://docs.immichkiosk.app/installation

Initialize the directory structure for a standalone Docker installation.

```bash
mkdir ./immich-kiosk
cd ./immich-kiosk
```

--------------------------------

### Tag Wildcard Examples

Source: https://docs.immichkiosk.app/configuration/tags

Demonstrates the use of wildcards for including and excluding tags in configuration.

```yaml
tags:
  - vacation

excluded_tags:
  - vacation/2023/**  # Exclude all 2023 vacation photos
```

--------------------------------

### Example URL with date range

Source: https://docs.immichkiosk.app/configuration/date-range

Specify a date range in a URL query, from a specific start date to 'today'.

```http
http://{URL}?date=2023-01-01_to_today

```

--------------------------------

### Start Docker Container

Source: https://docs.immichkiosk.app/installation

Launch the Kiosk container in detached mode.

```bash
docker compose up -d
```

--------------------------------

### Immich Kiosk Configuration File

Source: https://docs.immichkiosk.app/config-example

A complete example of the config.yaml file structure for setting up Immich Kiosk.

```yaml
# yaml-language-server: $schema=https://raw.githubusercontent.com/damongolding/immich-kiosk/main/config.schema.json


## Required settings - move these to ENV if you want to check in this file
immich_api_key: ""
immich_url: ""


## Clock
show_time: false
time_format: 24 # 12 or 24
show_am_pm: true # show am/pm when using 12 hour format
show_date: false
date_format: YYYY/MM/DD
clock_source: client


## Kiosk behaviour
duration: 60 # The duration a slide will be displayed (seconds).
disable_screensaver: false # Ask the browser to request a lock that prevents device screens from dimming or locking.
optimize_images: false # Whether Kiosk should resize images to match your browser screen dimensions for better performance.
use_gpu: true # Enable GPU acceleration for improved performance.
burn_in_interval: 0 # The interval between burn-in protection cycles (minutes, 0 = disabled).
burn_in_duration: 30 # The duration of each burn-in protection cycle (seconds).
burn_in_opacity: 70 # The opacity the UI will dip to, as a percentage.


## Asset sources
show_archived: false # Allow assets marked as archived to be displayed.


## ID(s) of person or people to display
people:
  - "PERSON_ID"
require_all_people: false # When true, only show images containing all specified people together
excluded_people:
  - "PERSON_ID"


## ID(s) of album or albums to display
albums:
  - "ALBUM_ID"
album_order: random # random | newest | oldest
# Album IDs to exclude from being shown. Albums in this list will be filtered from
# appearing in the frame even if they are included in the 'album' list.
excluded_albums:
  - "ALBUM_ID"


## Date range or ranges to display
dates:
  - "YYYY-MM-DD_to_YYYY-MM-DD"


## Value(s) of tag(s) to display
tags:
  - "TAG_VALUE"
excluded_tags:
  - "TAG_VALUE"


# Include assets based on their rating
rating: -1 # 0 - 5 (-1 = disabled)


excluded_partners:
  - "PARTNER_ID"


memories: false # show memories


## Filters
# filter_date: last-30-days # Limit assets from sources to a given date range
# filter_newest: 0 # Limit asset sources to only the newest X assets.
# filter_exclude_faces: false # Excludes assets where Immich has detected a face
# filter_favorites: false # Filter to only show favorite assets


## UI
show_clear_cache_button: false # Show a menu button to clear the Kiosk server cache
show_progress_bar: false # display a progress bar
disable_ui: false # this is just a shortcut for all ui elements (show_time, show_date, show_image_time, show_image_date)
frameless: false # remove border around image and rounded corners.
frame_padding: 0 # padding (px) around the edge of Kiosk; accepts integer or array [top, right, bottom, left]
hide_cursor: false # Hide cursor/mouse via CSS.
font_size: 100 # the base font size as a percentage. OMIT the % character
background_blur: true # display a blurred version of image as background
background_blur_amount: 10 # amount of blur to apply to background image (sigma)
theme: fade # which theme to use. fade or solid
layout: single # which layout to use. single | splitview | splitview-landscape | portrait | landscape


## Sleep mode
# sleep_start: 22 # sleep mode start time
# sleep_end: 7 # sleep mode end time
# sleep_dim_screen: false # dim screen when sleep mode is active (only works with Fully Kiosk Browser)
sleep_icon: true


## Transition options
transition: none # cross-fade, fade or none
fade_transition_duration: 1 # in seconds
cross_fade_transition_duration: 1 # in seconds


## Image display settings
image_fit: contain # none | contain | cover
image_effect: none # none | zoom | smart-zoom
image_effect_amount: 120
use_original_image: false # use the original file.


## Video
show_videos: false
live_photos: false
live_photo_loop_delay: 0
show_animated_gifs: false


## Image METADATA
show_image_rating: false
show_owner: false # show the owner of the image
show_album_name: false
show_person_name: false
show_person_age: false
show_image_time: false
image_time_format: 24 # 12 or 24
show_image_date: false
image_date_format: YYYY-MM-DD
show_image_description: false
show_image_camera: false
show_image_exif: false
show_image_location: false
show_image_qr: false
hide_countries:
  - "country to hide"
show_image_id: false
show_more_info: true
show_more_info_image_link: true
show_more_info_qr_code: true


like_button_action: favorite # album, favorite or both [album, favorite]
hide_button_action: tag # tag, archive, or both [tag, archive]


## Weather feature - you’ll need an API key from OpenWeatherMap
# weather:
#   rotation_interval: 60 # in seconds (minimum: 10); rotation must be enabled via URL parameter
#   locations:
#     - name: london
#       lat: 51.5285262
#       lon: -0.2663999
#       api: ""
#       unit: metric
#       lang: en
#       forecast: false
#       default: false
#       show:
#         humidity: false
#         wind: false
#         wind_direction: false
#         visibility: false
#         temperature_range: false
```

--------------------------------

### Example URL with 'today' alias

Source: https://docs.immichkiosk.app/configuration/date-range

Use 'today' as a shortcut for the current date in URL queries.

```http
http://{URL}?date=today

```

--------------------------------

### Advanced Weather Configuration with Rotation

Source: https://docs.immichkiosk.app/configuration/weather

Example showing multiple locations and the rotation interval setting in the config.yaml file.

```yaml
weather:
  rotation_interval: 60 # in seconds (10 is the minimum).
  locations:
    - name: london
      lat: 51.5285262
      lon: -0.2663999
      api: API_KEY
      unit: metric
      lang: en
      default: true


    - name: london-api
      lat: 51.5285262
      lon: -0.2663999
      api: API_KEY
      unit: metric
      lang: en


    - name: new-york
      lat: 40.6973709
      lon: -74.1444838
      api: API_KEY
      unit: imperial
      round_temperature: true
      lang: en
```

--------------------------------

### Extended Docker Compose with Environment Variables

Source: https://docs.immichkiosk.app/compose-example

A comprehensive configuration example showing all available environment variables for fine-tuning kiosk behavior, display settings, and asset filtering.

```yaml
services:
  immich-kiosk:
    image: ghcr.io/damongolding/immich-kiosk:latest
    container_name: immich-kiosk
    environment:
      LANG: "en_GB"
      TZ: "Europe/London"
      # Required settings
      KIOSK_IMMICH_API_KEY: "****"
      KIOSK_IMMICH_URL: "****"
      # External url for image links/QR codes
      KIOSK_IMMICH_EXTERNAL_URL: ""
      # Clock
      KIOSK_SHOW_TIME: false
      KIOSK_TIME_FORMAT: 24
      KIOSK_SHOW_DATE: false
      KIOSK_DATE_FORMAT: YYYY/MM/DD
      KIOSK_CLOCK_SOURCE: client
      # Kiosk behaviour
      KIOSK_DURATION: 60
      KIOSK_DISABLE_SCREENSAVER: false
      KIOSK_OPTIMIZE_IMAGES: false
      KIOSK_USE_GPU: true
      KIOSK_BURN_IN_INTERVAL: 0
      KIOSK_BURN_IN_DURATION: 30
      KIOSK_BURN_IN_OPACITY: 70
      # Asset sources
      KIOSK_SHOW_ARCHIVED: false
      KIOSK_ALBUMS: "ALBUM_ID,ALBUM_ID,ALBUM_ID"
      KIOSK_ALBUM_ORDER: random
      KIOSK_EXCLUDED_ALBUMS: "ALBUM_ID,ALBUM_ID,ALBUM_ID"
      KIOSK_PEOPLE: "PERSON_ID,PERSON_ID,PERSON_ID"
      KIOSK_REQUIRE_ALL_PEOPLE: false
      KIOSK_EXCLUDED_PEOPLE: "PERSON_ID,PERSON_ID,PERSON_ID"
      KIOSK_DATES: "DATE_RANGE,DATE_RANGE,DATE_RANGE"
      KIOSK_TAGS: "TAG_VALUE,TAG_VALUE,TAG_VALUE"
      KIOSK_EXCLUDED_TAGS: "TAG_VALUE,TAG_VALUE,TAG_VALUE"
      KIOSK_RATING: -1
      KIOSK_EXCLUDED_PARTNERS: "PARTNER_ID"
      KIOSK_MEMORIES: false
      KIOSK_BLACKLIST: "ASSET_ID,ASSET_ID,ASSET_ID"
      # FILTER
      KIOSK_FILTER_DATE: ""
      KIOSK_FILTER_NEWEST: 0
      KIOSK_FILTER_EXCLUDE_FACES: false
      KIOSK_FILTER_FAVORITES: false
      # UI
      KIOSK_SHOW_PROGRESS_BAR: false
      KIOSK_DISABLE_NAVIGATION: false
      KIOSK_DISABLE_UI: false
      KIOSK_FRAMELESS: false
      KIOSK_HIDE_CURSOR: false
      KIOSK_FONT_SIZE: 100
      KIOSK_BACKGROUND_BLUR: true
      KIOSK_BACKGROUND_BLUR_AMOUNT: 10
      KIOSK_THEME: fade
      KIOSK_LAYOUT: single
      KIOSK_SHOW_USER: false
      # Sleep mode
      # KIOSK_SLEEP_START: 22
      # KIOSK_SLEEP_END: 7
      # KIOSK_SLEEP_DIM_SCREEN: false
      # Transistion options
      KIOSK_TRANSITION: none
      KIOSK_FADE_TRANSITION_DURATION: 1
      KIOSK_CROSS_FADE_TRANSITION_DURATION: 1
      # Image display settings
      KIOSK_IMAGE_FIT: contain
      KIOSK_IMAGE_EFFECT: smart-zoom
      KIOSK_IMAGE_EFFECT_AMOUNT: 120
      KIOSK_USE_ORIGINAL_IMAGE: false
      # Video
      KIOSK_SHOW_VIDEOS: false
      KIOSK_LIVE_PHOTOS: false
      KIOSK_LIVE_PHOTO_LOOP_DELAY: 0
      KIOSK_SHOW_ANIMATED_GIFS: false
      # Image metadata
      KIOSK_SHOW_IMAGE_RATING: false
      KIOSK_SHOW_OWNER: false
      KIOSK_SHOW_ALBUM_NAME: false
      KIOSK_SHOW_PERSON_NAME: false
      KIOSK_SHOW_PERSON_AGE: false
      KIOSK_SHOW_IMAGE_TIME: false
      KIOSK_IMAGE_TIME_FORMAT: 24
      KIOSK_SHOW_IMAGE_DATE: false
      KIOSK_IMAGE_DATE_FORMAT: YYYY-MM-DD
      KIOSK_SHOW_IMAGE_DESCRIPTION: false
      KIOSK_SHOW_IMAGE_CAMERA: false
      KIOSK_SHOW_IMAGE_EXIF: false
      KIOSK_SHOW_IMAGE_LOCATION: false
      KIOSK_HIDE_COUNTRIES: "HIDDEN_COUNTRY,HIDDEN_COUNTRY"
      KIOSK_SHOW_IMAGE_ID: false
      KIOSK_SHOW_IMAGE_QR: false
      KIOSK_SHOW_MORE_INFO: true
      KIOSK_SHOW_MORE_INFO_IMAGE_LINK: true
      KIOSK_SHOW_MORE_INFO_QR_CODE: true
      # More info actions
      KIOSK_LIKE_BUTTON_ACTION: favorite
      KIOSK_HIDE_BUTTON_ACTION: tag
      # Kiosk settings
      KIOSK_PORT: 3000
      KIOSK_BEHIND_PROXY: false
      KIOSK_DISABLE_URL_QUERIES: false
      KIOSK_DISABLE_CONFIG_ENDPOINT: false
      KIOSK_ENABLE_URL_BUILDER: false
      KIOSK_WATCH_CONFIG: false
      KIOSK_FETCHED_ASSETS_SIZE: 1000
      KIOSK_HTTP_TIMEOUT: 20
      KIOSK_PASSWORD: ""
      KIOSK_CACHE: true
      KIOSK_PREFETCH: true
      KIOSK_ASSET_WEIGHTING: true
    ports:
      - 3000:3000
    restart: always
    healthcheck:
      test: ["CMD", "/kiosk", "--healthcheck"]
      interval: 30s
      timeout: 5s
      retries: 3
      start_period: 10s
```

--------------------------------

### Systemd Service with Credentials

Source: https://docs.immichkiosk.app/configuration/core

Example of a Systemd service file configured to use LoadCredential for sensitive variables.

```ini

[Unit]
Description=Immich Kiosk Service
After=network.target


[Service]
Type=simple
User=immichkiosk
Group=immichkiosk
WorkingDirectory=/opt/immich-kiosk
Environment="KIOSK_IMMICH_URL=http://192.168.1.123:2283"
LoadCredential=kiosk_immich_api_key:/path/to/immich_api_key.txt
LoadCredential=kiosk_password:/path/to/password.txt
ExecStart=/opt/immich-kiosk/immich-kiosk
Restart=on-failure
RestartSec=10


[Install]
WantedBy=multi-user.target

```

--------------------------------

### Install Anthias

Source: https://docs.immichkiosk.app/guides/anthias

Execute the Anthias installation script by piping the output of `curl` to `bash`. This command downloads and runs the official Anthias installation script.

```bash
bash <(curl -sL https://install-anthias.srly.io)
```

--------------------------------

### View Anthias Installation Script

Source: https://docs.immichkiosk.app/guides/anthias

Before running the Anthias installation script, it is recommended to view its contents using `curl -L`. This allows you to inspect the script for security or configuration checks.

```bash
curl -L https://install-anthias.srly.io
```

--------------------------------

### Configure Theme via URL Query

Source: https://docs.immichkiosk.app/configuration/themes

Append the `theme` query parameter to the application URL to dynamically set the theme. For example, `http://{URL}?theme=fade`.

```http
http://{URL}?theme=fade

```

--------------------------------

### Locate WebView APK path

Source: https://docs.immichkiosk.app/misc/frameo

Find the file path of the installed WebView APK on the device.

```bash
adb shell pm path com.android.webview
```

--------------------------------

### Configure Sleep Start Time

Source: https://docs.immichkiosk.app/configuration/sleep-mode

Set the time for sleep mode to begin. Accepts 24-hour format. Can be configured via YAML, environment variables, or URL.

```yaml
sleep_start:
```

```yaml
environment:
  KIOSK_SLEEP_START:
```

```url
http://{URL}?sleep_start=
```

--------------------------------

### Enable Videos in Immich Kiosk (config.yaml)

Source: https://docs.immichkiosk.app/configuration/videos

Set the `show_videos` option to `true` in your `config.yaml` file to enable video playback. Ensure `prefetch` is also enabled for optimal performance.

```yaml
show_videos: true
```

--------------------------------

### Enable Videos in Immich Kiosk (URL Query)

Source: https://docs.immichkiosk.app/configuration/videos

Append `?show_videos=true` to your Immich Kiosk URL to enable video playback. Ensure `prefetch` is also enabled in your configuration.

```http
http://{URL}?show_videos=true
```

--------------------------------

### Run Kiosk Binary

Source: https://docs.immichkiosk.app/installation

Execute the Kiosk binary directly after configuration.

```bash
./kiosk
```

--------------------------------

### Backup original WebView

Source: https://docs.immichkiosk.app/misc/frameo

Remount the system partition as read-write and create a backup of the existing WebView APK.

```bash
mount -o remount,rw /system && cp /system/app/webview/webview.apk /system/app/webview/webview.apk.bak
```

--------------------------------

### Enable Videos in Immich Kiosk (Docker Compose)

Source: https://docs.immichkiosk.app/configuration/videos

Configure the `KIOSK_SHOW_VIDEOS` environment variable in your `docker-compose.yml` to `true` to enable video playback. Ensure `KIOSK_PREFETCH` is also enabled.

```yaml
environment:
  KIOSK_SHOW_VIDEOS: true
```

--------------------------------

### Webhook JSON Payload Example

Source: https://docs.immichkiosk.app/configuration/webhooks

The structure of the JSON payload sent to the configured webhook URL when an event occurs.

```json
{
  "event": "asset.new",
  "timestamp": "2024-11-19T11:03:07Z",
  "deviceID": "ed08beb1-6de7-4592-9827-078c3ad91ae4",
  "clientName": "dining-room-pi",
  "assetCount": 1,
  "assets": [
    {
      "id": "bb4ce63b-b80d-430f-ad37-5cfe243e08b1",
      "type": "IMAGE",
      "originalMimeType": "image/jpeg",
      "localDateTime": "2013-04-06T23:45:54Z"
      /* ... other properties omitted for brevity */
    }
  ],
  "config": {
    /* ... configuration fields omitted for brevity */
  },
  "meta": {
    "source": "immich-kiosk",
    "version": "0.13.1"
  }
}
```

--------------------------------

### Docker Compose with Secrets

Source: https://docs.immichkiosk.app/configuration/core

Example of using Docker secrets to securely pass sensitive configuration variables to the Kiosk service.

```yaml

services:
  immich-kiosk:
    image: ghcr.io/damongolding/immich-kiosk:latest
    environment:
      KIOSK_IMMICH_URL: http://192.168.1.123:2283
      KIOSK_IMMICH_API_KEY_FILE: /run/secrets/immich_api_key
      KIOSK_PASSWORD_FILE: /run/secrets/password
      KIOSK_WEATHER_API_KEY_FILE: /run/secrets/weather_api_key
    secrets:
      - immich_api_key
      - password
      - weather_api_key


secrets:
  immich_api_key:
    file: /path/to/immich_api_key.txt
  password:
    file: /path/to/password.txt
  weather_api_key:
    file: /path/to/weather_api_key.txt

```

--------------------------------

### Create environment file

Source: https://docs.immichkiosk.app/installation

Initialize the docker-compose.env file to store sensitive configuration data.

```bash
touch docker-compose.env
```

--------------------------------

### Specify People IDs using ENV

Source: https://docs.immichkiosk.app/configuration/people

Configure the KIOSK_PEOPLE environment variable with a comma-separated string of person IDs to display. This is useful for Docker Compose setups.

```yaml
environment:
  KIOSK_PEOPLE: "PERSON_ID, PERSON_ID"
```

--------------------------------

### Define environment variables

Source: https://docs.immichkiosk.app/installation

Add Immich API credentials to the environment file.

```text
KIOSK_IMMICH_API_KEY=SECRET_KEY
KIOSK_IMMICH_URL=SECRET_URL
```

--------------------------------

### Configure Albums with config.yaml

Source: https://docs.immichkiosk.app/configuration/albums

Specify album IDs to include in the slideshow using a YAML configuration file. Each album ID should be on a new line.

```yaml
albums:
  - ALBUM_ID
  - ALBUM_ID

```

--------------------------------

### Basic Configuration Structure

Source: https://docs.immichkiosk.app/configuration/additional-options

This snippet shows the basic structure for additional options within the `config.yaml` file, including Immich URL, API key, and other general configurations.

```yaml
immich_url: "****"
immich_api_key: "****"
// all your other config options


// 👇 Additional options
kiosk:
  password: ""
  cache: true
  prefetch: true

```

--------------------------------

### Target Images by Tag with CSS

Source: https://docs.immichkiosk.app/configuration/custom-css

Use CSS attribute selectors to style images based on their `data-tags` attribute. This example targets images with the tag `kiosk-contain` and applies `object-fit: contain`.

```css
/* Target images tagged with "kiosk-contain" */
img[data-tags~="kiosk-contain"] {
  object-fit: contain;
}
```

--------------------------------

### Deploy Immich Kiosk with environment variables

Source: https://docs.immichkiosk.app/installation

Configure all kiosk settings directly through environment variables in the Docker Compose file.

```yaml

services:
  immich-kiosk:
    image: ghcr.io/damongolding/immich-kiosk:latest
    container_name: immich-kiosk
    environment:
      LANG: "en_GB"
      TZ: "Europe/London"
      # Required settings
      KIOSK_IMMICH_API_KEY: "****"
      KIOSK_IMMICH_URL: "****"
      # External url for image links/QR codes
      KIOSK_IMMICH_EXTERNAL_URL: ""
      # Clock
      KIOSK_SHOW_TIME: false
      KIOSK_TIME_FORMAT: 24
      KIOSK_SHOW_DATE: false
      KIOSK_DATE_FORMAT: YYYY/MM/DD
      KIOSK_CLOCK_SOURCE: client
      # Kiosk behaviour
      KIOSK_DURATION: 60
      KIOSK_DISABLE_SCREENSAVER: false
      KIOSK_OPTIMIZE_IMAGES: false
      KIOSK_USE_GPU: true
      KIOSK_BURN_IN_INTERVAL: 0
      KIOSK_BURN_IN_DURATION: 30
      KIOSK_BURN_IN_OPACITY: 70
      # Asset sources
      KIOSK_SHOW_ARCHIVED: false
      KIOSK_ALBUMS: "ALBUM_ID,ALBUM_ID,ALBUM_ID"
      KIOSK_ALBUM_ORDER: random
      KIOSK_EXCLUDED_ALBUMS: "ALBUM_ID,ALBUM_ID,ALBUM_ID"
      KIOSK_PEOPLE: "PERSON_ID,PERSON_ID,PERSON_ID"
      KIOSK_REQUIRE_ALL_PEOPLE: false
      KIOSK_EXCLUDED_PEOPLE: "PERSON_ID,PERSON_ID,PERSON_ID"
      KIOSK_DATES: "DATE_RANGE,DATE_RANGE,DATE_RANGE"
      KIOSK_TAGS: "TAG_VALUE,TAG_VALUE,TAG_VALUE"
      KIOSK_EXCLUDED_TAGS: "TAG_VALUE,TAG_VALUE,TAG_VALUE"
      KIOSK_RATING: -1
      KIOSK_EXCLUDED_PARTNERS: "PARTNER_ID"
      KIOSK_MEMORIES: false
      KIOSK_BLACKLIST: "ASSET_ID,ASSET_ID,ASSET_ID"
      # FILTER
      KIOSK_FILTER_DATE: ""
      KIOSK_FILTER_NEWEST: 0
      KIOSK_FILTER_EXCLUDE_FACES: false
      KIOSK_FILTER_FAVORITES: false
      # UI
      KIOSK_SHOW_PROGRESS_BAR: false
      KIOSK_DISABLE_NAVIGATION: false
      KIOSK_DISABLE_UI: false
      KIOSK_FRAMELESS: false
      KIOSK_HIDE_CURSOR: false
      KIOSK_FONT_SIZE: 100
      KIOSK_BACKGROUND_BLUR: true
      KIOSK_BACKGROUND_BLUR_AMOUNT: 10
      KIOSK_THEME: fade
      KIOSK_LAYOUT: single
      KIOSK_SHOW_USER: false
      # Sleep mode
      # KIOSK_SLEEP_START: 22
      # KIOSK_SLEEP_END: 7
      # KIOSK_SLEEP_DIM_SCREEN: false
      # Transistion options
      KIOSK_TRANSITION: none
      KIOSK_FADE_TRANSITION_DURATION: 1
      KIOSK_CROSS_FADE_TRANSITION_DURATION: 1
      # Image display settings
      KIOSK_IMAGE_FIT: contain
      KIOSK_IMAGE_EFFECT: smart-zoom
      KIOSK_IMAGE_EFFECT_AMOUNT: 120
      KIOSK_USE_ORIGINAL_IMAGE: false
      # Video
      KIOSK_SHOW_VIDEOS: false
      KIOSK_LIVE_PHOTOS: false
      KIOSK_LIVE_PHOTO_LOOP_DELAY: 0
      KIOSK_SHOW_ANIMATED_GIFS: false
      # Image metadata
      KIOSK_SHOW_IMAGE_RATING: false
      KIOSK_SHOW_OWNER: false
      KIOSK_SHOW_ALBUM_NAME: false
      KIOSK_SHOW_PERSON_NAME: false
      KIOSK_SHOW_PERSON_AGE: false
      KIOSK_SHOW_IMAGE_TIME: false
      KIOSK_IMAGE_TIME_FORMAT: 24
      KIOSK_SHOW_IMAGE_DATE: false
      KIOSK_IMAGE_DATE_FORMAT: YYYY-MM-DD
      KIOSK_SHOW_IMAGE_DESCRIPTION: false
      KIOSK_SHOW_IMAGE_CAMERA: false
      KIOSK_SHOW_IMAGE_EXIF: false
      KIOSK_SHOW_IMAGE_LOCATION: false
      KIOSK_HIDE_COUNTRIES: "HIDDEN_COUNTRY,HIDDEN_COUNTRY"
      KIOSK_SHOW_IMAGE_ID: false
      KIOSK_SHOW_IMAGE_QR: false
      KIOSK_SHOW_MORE_INFO: true
      KIOSK_SHOW_MORE_INFO_IMAGE_LINK: true
      KIOSK_SHOW_MORE_INFO_QR_CODE: true
      # More info actions
      KIOSK_LIKE_BUTTON_ACTION: favorite
      KIOSK_HIDE_BUTTON_ACTION: tag
      # Kiosk settings
      KIOSK_PORT: 3000
      KIOSK_BEHIND_PROXY: false
      KIOSK_DISABLE_URL_QUERIES: false
      KIOSK_DISABLE_CONFIG_ENDPOINT: false
      KIOSK_ENABLE_URL_BUILDER: false
      KIOSK_WATCH_CONFIG: false
      KIOSK_FETCHED_ASSETS_SIZE: 1000
      KIOSK_HTTP_TIMEOUT: 20
      KIOSK_PASSWORD: ""
      KIOSK_CACHE: true
      KIOSK_PREFETCH: true
      KIOSK_ASSET_WEIGHTING: true
    ports:
      - 3000:3000
    restart: always
    healthcheck:
      test: ["CMD", "/kiosk", "--healthcheck"]
      interval: 30s
      timeout: 5s
      retries: 3
      start_period: 10s

```

--------------------------------

### Configure Show Image Camera

Source: https://docs.immichkiosk.app/configuration/metadata

Settings to toggle the display of camera make and model information.

```yaml
show_image_camera: false
```

```yaml
environment:
  KIOSK_SHOW_IMAGE_CAMERA: false
```

```text
http://{URL}?show_image_camera=false
```

--------------------------------

### Configure Theme in config.yaml

Source: https://docs.immichkiosk.app/configuration/themes

Set the theme using the `theme` key in your `config.yaml` file. The default theme is `fade`.

```yaml
theme: fade

```

--------------------------------

### Enable Prefetch with config.yaml

Source: https://docs.immichkiosk.app/configuration/additional-options

Enable prefetching of assets in the background using the `config.yaml` file, which helps images load quicker when the duration timer ends. The default value is `true`.

```yaml
kiosk:
  prefetch: true
```

--------------------------------

### Configure Like Button Action

Source: https://docs.immichkiosk.app/configuration/more-info

Define the action(s) for the like button, supporting 'favorite' and 'album'. Multiple actions can be specified as a list. Configuration is available via YAML, environment variables, or URL queries.

```yaml
like_button_action: ["favorite"]
```

```yaml
environment:
  KIOSK_LIKE_BUTTON_ACTION: ["favorite"]
```

```text
http://{URL}?like_button_action=["favorite"]
```

--------------------------------

### Configure Memory Weighting (URL Query)

Source: https://docs.immichkiosk.app/configuration/memories

Append '?memory_weight=1.0' to the URL to set the normal memory weight. Use float values to adjust.

```http
http://{URL}?memory_weight=1.0
```

--------------------------------

### Configure Layout with config.yaml

Source: https://docs.immichkiosk.app/configuration/layouts

Set the 'layout' option in your config.yaml file to choose a display mode. Defaults to 'single'.

```yaml
layout: single
```

--------------------------------

### Configure Immich Kiosk as Wallpanel Image Source

Source: https://docs.immichkiosk.app/misc/home-assistant

Integrate Immich Kiosk with Wallpanel in Home Assistant for dynamic image sourcing. Appending a timestamp parameter ensures Wallpanel fetches new images.

```yaml
wallpanel:
    enabled: true
    image_fit: cover
    idle_time: 10
    screensaver_entity: input_boolean.kiosk
    screensaver_stop_navigation_path: /dashboard-kiosk
    fullscreen: true
    display_time: 86400
    image_url: >-
      http://{immich-kiosk-url}/image?person=PERSON_1_ID&person=PERSON_2_ID&t=${timestamp}
    cards:
      - type: vertical-stack
        cards:
          - type: custom:weather-card
            details: true
            forecast: true
            hourly_forecast: false
            name: Weather
            entity: weather.pirateweather
            current: true
            number_of_forecasts: '6'
          - type: custom:horizon-card
            darkMode: true
            showAzimuth: true
            showElevation: true
```

--------------------------------

### Application Configuration File

Source: https://docs.immichkiosk.app/configuration

Template for the config.yaml file containing all available settings for the Kiosk application.

```yaml

# yaml-language-server: $schema=https://raw.githubusercontent.com/damongolding/immich-kiosk/main/config.schema.json


## Required settings - move these to ENV if you want to check in this file
immich_api_key: ""
immich_url: ""


## Clock
show_time: false
time_format: 24 # 12 or 24
show_am_pm: true # show am/pm when using 12 hour format
show_date: false
date_format: YYYY/MM/DD
clock_source: client


## Kiosk behaviour
duration: 60 # The duration a slide will be displayed (seconds).
disable_screensaver: false # Ask the browser to request a lock that prevents device screens from dimming or locking.
optimize_images: false # Whether Kiosk should resize images to match your browser screen dimensions for better performance.
use_gpu: true # Enable GPU acceleration for improved performance.
burn_in_interval: 0 # The interval between burn-in protection cycles (minutes, 0 = disabled).
burn_in_duration: 30 # The duration of each burn-in protection cycle (seconds).
burn_in_opacity: 70 # The opacity the UI will dip to, as a percentage.


## Asset sources
show_archived: false # Allow assets marked as archived to be displayed.


## ID(s) of person or people to display
people:
  - "PERSON_ID"
require_all_people: false # When true, only show images containing all specified people together
excluded_people:
  - "PERSON_ID"


## ID(s) of album or albums to display
albums:
  - "ALBUM_ID"
album_order: random # random | newest | oldest
# Album IDs to exclude from being shown. Albums in this list will be filtered from
# appearing in the frame even if they are included in the 'album' list.
excluded_albums:
  - "ALBUM_ID"


## Date range or ranges to display
dates:
  - "YYYY-MM-DD_to_YYYY-MM-DD"


## Value(s) of tag(s) to display
tags:
  - "TAG_VALUE"
excluded_tags:
  - "TAG_VALUE"


# Include assets based on their rating
rating: -1 # 0 - 5 (-1 = disabled)


excluded_partners:
  - "PARTNER_ID"


memories: false # show memories


## Filters
# filter_date: last-30-days # Limit assets from sources to a given date range
# filter_newest: 0 # Limit asset sources to only the newest X assets.
# filter_exclude_faces: false # Excludes assets where Immich has detected a face
# filter_favorites: false # Filter to only show favorite assets


## UI
show_clear_cache_button: false # Show a menu button to clear the Kiosk server cache
show_progress_bar: false # display a progress bar
disable_ui: false # this is just a shortcut for all ui elements (show_time, show_date, show_image_time, show_image_date)
frameless: false # remove border around image and rounded corners.
frame_padding: 0 # padding (px) around the edge of Kiosk; accepts integer or array [top, right, bottom, left]
hide_cursor: false # Hide cursor/mouse via CSS.
font_size: 100 # the base font size as a percentage. OMIT the % character
background_blur: true # display a blurred version of image as background
background_blur_amount: 10 # amount of blur to apply to background image (sigma)
theme: fade # which theme to use. fade or solid
layout: single # which layout to use. single | splitview | splitview-landscape | portrait | landscape


## Sleep mode
# sleep_start: 22 # sleep mode start time
# sleep_end: 7 # sleep mode end time
# sleep_dim_screen: false # dim screen when sleep mode is active (only works with Fully Kiosk Browser)
sleep_icon: true


## Transition options
transition: none # cross-fade, fade or none
fade_transition_duration: 1 # in seconds
cross_fade_transition_duration: 1 # in seconds


## Image display settings
image_fit: contain # none | contain | cover
image_effect: none # none | zoom | smart-zoom
image_effect_amount: 120
use_original_image: false # use the original file.


## Video
show_videos: false
live_photos: false
live_photo_loop_delay: 0
show_animated_gifs: false

```

--------------------------------

### Enable Prefetch with Docker Compose

Source: https://docs.immichkiosk.app/configuration/additional-options

Enable prefetching of assets in the background using environment variables in your `docker-compose.yml` file. This is an alternative to using the `config.yaml` file.

```yaml
environment:
  KIOSK_PREFETCH: true
```

--------------------------------

### Show More Info Image Link

Source: https://docs.immichkiosk.app/configuration/more-info

Enable the display of a direct link to the original Immich image within the 'More Info' overlay. Configure 'show_more_info_image_link' using YAML, environment variables, or URL queries.

```yaml
show_more_info_image_link: true
```

```yaml
environment:
  KIOSK_SHOW_MORE_INFO_IMAGE_LINK: true
```

```text
http://{URL}?show_more_info_image_link=true
```

--------------------------------

### Set Device Settings via URL

Source: https://docs.immichkiosk.app/configuration/url-params

Append query parameters to the base URL to configure settings like duration, background blur, and transitions for a specific device. This is useful for kiosk devices where URL input is the primary configuration method.

```url
https://{URL}?duration=120&background_blur=false&transition=none
```

--------------------------------

### Restore original Frameo experience

Source: https://docs.immichkiosk.app/misc/frameo

Revert system settings to use the original Frameo app as the default launcher and optionally remove ImmichFrame.

```bash
# Re-enable the Frameo app
adb shell pm enable net.frameo.frame


# Set it as default launcher
adb shell cmd package set-home-activity net.frameo.frame/.MainActivity


# Optionally uninstall ImmichFrame
adb uninstall com.immichframe.immichframe
```

--------------------------------

### Set ImmichFrame as default launcher

Source: https://docs.immichkiosk.app/misc/frameo

Configure the ImmichFrame activity as the system's default home launcher.

```bash
adb shell cmd package set-home-activity com.immichframe.immichframe/.MainActivity
```

--------------------------------

### Deploy Immich Kiosk with config.yaml

Source: https://docs.immichkiosk.app/installation

Use a local config file to manage settings for the Immich Kiosk container.

```yaml

services:
  immich-kiosk:
    image: ghcr.io/damongolding/immich-kiosk:latest
    container_name: immich-kiosk
    tty: true
    environment:
      LANG: "en_GB"
      TZ: "Europe/London"
    ports:
      - 3000:3000
    volumes:
      - ./config:/config
      # - ./custom.css:/custom.css
      # - ./offline-assets:/offline-assets
    restart: always
    healthcheck:
      test: ["CMD", "/kiosk", "--healthcheck"]
      interval: 30s
      timeout: 5s
      retries: 3
      start_period: 10s

```

--------------------------------

### Configure Multiple Immich Users API Keys

Source: https://docs.immichkiosk.app/configuration/multiple-users

Add multiple Immich usernames and their corresponding API keys to the `immich_users_api_keys` field in your `config.yaml` file. This allows the Kiosk to authenticate with different user accounts.

```yaml
immich_users_api_keys:
 damon: "api_key_here"
 laura: "api_key_here"
```

--------------------------------

### Configure Layout with URL Query

Source: https://docs.immichkiosk.app/configuration/layouts

Append the 'layout' query parameter to the Kiosk URL to dynamically change the display mode. Defaults to 'single'.

```http
http://{URL}?layout=single
```

--------------------------------

### Enter root shell

Source: https://docs.immichkiosk.app/misc/frameo

Gain root access on the device to perform system modifications.

```bash
adb shell su
```

--------------------------------

### Configure Albums with URL Query

Source: https://docs.immichkiosk.app/configuration/albums

Include specific album IDs in the slideshow by appending them to the URL query parameters. Use 'album=' followed by the ID.

```http
http://{URL}?album=ALBUM_ID

```

--------------------------------

### Configure Tags using URL Queries

Source: https://docs.immichkiosk.app/configuration/tags

Append tag parameters to the URL to include specific tags.

```http
http://{URL}?tag=TAG_VALUE&tag=TAG_VALUE&tag=TAG_VALUE
```

--------------------------------

### SSH into Raspberry Pi

Source: https://docs.immichkiosk.app/guides/anthias

Use this command to establish an SSH connection to your Raspberry Pi. Replace `YOU_USERNAME` and `<Raspberry Pi IP Address>` with your specific details.

```bash
ssh YOU_USERNAME@<Raspberry Pi IP Address>
```

--------------------------------

### Like Button Action: Album

Source: https://docs.immichkiosk.app/configuration/more-info

Configures the like button to add the asset to the 'Kiosk Favorites' album. The album will be created if it does not already exist.

```yaml
like_button_action: album
```

--------------------------------

### Override Weather Settings via URL

Source: https://docs.immichkiosk.app/configuration/weather

Demonstrates how to override specific weather display options using query parameters in the kiosk URL.

```text
https://{KIOSK_URL}?weather_show_forecast=true&weather_show_humidity=true
```

--------------------------------

### Configure Iframes

Source: https://docs.immichkiosk.app/configuration

Add local files or remote URLs to the Kiosk interface.

```yaml
#iframe:
# - https://iframe.immichkiosk.app/pokemon
# - ./iframes/pokemon.html
```

--------------------------------

### Use 'all' Album Keyword

Source: https://docs.immichkiosk.app/configuration/albums

To display assets from all owned and shared albums, use the special keyword 'all' in the 'album' URL query parameter.

```http
http://{URL}?album=all

```

--------------------------------

### Show More Info QR Code

Source: https://docs.immichkiosk.app/configuration/more-info

Configure the 'show_more_info_qr_code' setting to display a QR code in the 'More Info' overlay, which links to the original Immich image. This can be set via config.yaml, environment variables, or URL parameters.

```yaml
show_more_info_qr_code: true
```

```yaml
environment:
  KIOSK_SHOW_MORE_INFO_QR_CODE: true
```

```text
http://{URL}?show_more_info_qr_code=true
```

--------------------------------

### Configure ImmichKiosk settings

Source: https://docs.immichkiosk.app/config-example

The configuration file defines iframe sources, user API keys, offline mode behavior, and core kiosk server settings.

```yaml
# config.yaml

## Add iframes into Kiosk - you can use local files or remote URLs
#iframe:
# - https://iframe.immichkiosk.app/pokemon
# - ./iframes/pokemon.html


## Immich API keys for specific users
# immich_users_api_keys:
#   user1: ""
# show_user: false # show user name


## Offline mode
# offline_mode:
#   enabled: false
#   number_of_assets: 100
#   max_size: 0
#   parallel_downloads: 1
#   expiration_hours: 0


## Options that can NOT be changed via url params
kiosk:
  port: 3000
  behind_proxy: false
  disable_url_queries: false
  disable_config_endpoint: false
  enable_url_builder: false
  watch_config: false
  fetched_assets_size: 1000
  http_timeout: 20
  password: ""
  cache: true # cache select api calls
  prefetch: true # fetch assets in the background
  asset_weighting: true # use weighting when picking assets
```

--------------------------------

### Check WebView version

Source: https://docs.immichkiosk.app/misc/frameo

Verify the current system WebView version to determine if an update is required.

```bash
adb shell dumpsys webviewupdate
```

--------------------------------

### Create a new feature branch

Source: https://docs.immichkiosk.app/contributing

Use this command to initialize a new branch for your development work.

```bash
git checkout -b feature/my-feature
```

--------------------------------

### Apply Custom CSS to All Devices and Specific Devices

Source: https://docs.immichkiosk.app/configuration/custom-css

This CSS demonstrates how to apply styles to all elements and how to apply styles specifically to devices that have the `custom_css_class` set to `foo`.

```css
/* applied to all */
#clock,
#weather,
.image--metadata {
    padding: 4rem;
}


/* applied to devices with `custom_css_class=foo` */
.foo #clock,
.foo #weather,
.image--metadata {
    padding: 2rem;
}
```

--------------------------------

### Enable TCP/IP for wireless ADB

Source: https://docs.immichkiosk.app/misc/frameo

Configure the device to accept wireless ADB connections on port 5555.

```bash
adb tcpip 5555
```

--------------------------------

### Configure Show Image Exif

Source: https://docs.immichkiosk.app/configuration/metadata

Settings to toggle the display of technical image data like Fnumber, shutter speed, focal length, and ISO.

```yaml
show_image_exif: false
```

```yaml
environment:
  KIOSK_SHOW_IMAGE_EXIF: false
```

```text
http://{URL}?show_image_exif=false
```

--------------------------------

### Enable More Info Overlay

Source: https://docs.immichkiosk.app/configuration/more-info

Configure the 'show_more_info' setting to enable or disable the additional information overlay for images. This can be set via config.yaml, environment variables, or URL parameters.

```yaml
show_more_info: true
```

```yaml
environment:
  KIOSK_SHOW_MORE_INFO: true
```

```text
http://{URL}?show_more_info=true
```

--------------------------------

### Enable Watch Config in YAML

Source: https://docs.immichkiosk.app/configuration/additional-options

Configure Immich Kiosk to watch the `config.yaml` file for changes and reload clients accordingly by setting `watch_config` to `true`. Note that changes require a container restart to be fully implemented.

```yaml
kiosk:
  watch_config: false

```

--------------------------------

### Configure Up Arrow Action

Source: https://docs.immichkiosk.app/misc/navigation

Methods to bind custom actions to the keyboard up arrow using configuration files, environment variables, or URL parameters.

```yaml

up_arrow_action:

```

```yaml

environment:
  KIOSK_UP_ARROW_ACTION:

```

```text

http://{URL}?up_arrow_action=

```

--------------------------------

### Enable Live Photos

Source: https://docs.immichkiosk.app/configuration/live-photos

Configure whether Live Photos are enabled. Set to 'false' to disable.

```yaml
live_photos: false
```

```yaml
environment:
  KIOSK_LIVE_PHOTOS: false
```

```text
http://{URL}?live_photos=false
```

--------------------------------

### Configure Immich API Keys

Source: https://docs.immichkiosk.app/configuration

Set API keys for specific users and toggle user name display.

```yaml
# immich_users_api_keys:
#   user1: ""
# show_user: false # show user name
```

--------------------------------

### Download Docker Compose File

Source: https://docs.immichkiosk.app/installation

Fetch the docker-compose.yaml file using either wget or curl.

```bash
wget -O docker-compose.yaml https://raw.githubusercontent.com/damongolding/immich-kiosk/refs/heads/main/docker-compose.yaml
```

```bash
curl -o docker-compose.yaml https://raw.githubusercontent.com/damongolding/immich-kiosk/refs/heads/main/docker-compose.yaml
```

--------------------------------

### Configure Kiosk Server Options

Source: https://docs.immichkiosk.app/configuration

Core server settings that cannot be modified via URL parameters.

```yaml
kiosk:
  port: 3000
  behind_proxy: false
  disable_url_queries: false
  disable_config_endpoint: false
  enable_url_builder: false
  watch_config: false
  fetched_assets_size: 1000
  http_timeout: 20
  password: ""
  cache: true # cache select api calls
  prefetch: true # fetch assets in the background
  asset_weighting: true # use weighting when picking assets
```

--------------------------------

### Set Maximum Video Length (URL Query)

Source: https://docs.immichkiosk.app/configuration/videos

Append `?exclude_videos_over={duration}` to your Immich Kiosk URL to specify the maximum video duration in seconds. A value of `0` means no videos will be excluded based on length.

```http
http://{URL}?exclude_videos_over=0
```

--------------------------------

### Enable Asset Weighting with config.yaml

Source: https://docs.immichkiosk.app/configuration/additional-options

Enable asset weighting using the `config.yaml` file to balance asset selection when multiple sources are used. Sources with fewer assets will show less often. The default value is `true`.

```yaml
kiosk:
  asset_weighting: true
```

--------------------------------

### Configure Album Order with URL Query

Source: https://docs.immichkiosk.app/configuration/albums

Specify the asset display order for albums directly in the URL using the 'album_order' query parameter. Valid values include 'random', 'newest', and 'oldest'.

```http
http://{URL}?album_order=random

```

--------------------------------

### Configure Button Actions

Source: https://docs.immichkiosk.app/configuration

Define the behavior for like and hide button interactions.

```yaml
like_button_action: favorite # album, favorite or both [album, favorite]
hide_button_action: tag # tag, archive, or both [tag, archive]
```

--------------------------------

### List connected ADB devices

Source: https://docs.immichkiosk.app/misc/frameo

Verify the connection status of the Frameo device.

```bash
adb devices
```

--------------------------------

### Connect to device wirelessly

Source: https://docs.immichkiosk.app/misc/frameo

Establish a connection to the frame over the network using its IP address.

```bash
adb connect <device_ip>:5555
```

--------------------------------

### Configure Blacklist

Source: https://docs.immichkiosk.app/configuration/behavior

Specify asset IDs to exclude from display. Alternatively, tag assets with 'kiosk-skip' in Immich. Configuration can be done using YAML, environment variables, or URL parameters. An empty string or empty array means no assets are blacklisted.

```yaml
blacklist: ""
```

```yaml
environment:
  KIOSK_BLACKLIST: ""
```

```url
http://{URL}?blacklist=""
```

--------------------------------

### Configure Clock Source

Source: https://docs.immichkiosk.app/configuration/clock

Set the clock source to either the client or the server.

```yaml

clock_source: client

```

```yaml

environment:
  KIOSK_CLOCK_SOURCE: client

```

```text

http://{URL}?clock_source=client

```

--------------------------------

### Replace WebView APK

Source: https://docs.immichkiosk.app/misc/frameo

Overwrite the system WebView APK with the new version.

```bash
mount -o remount,rw /system && cp /sdcard/webview.apk /system/app/webview/webview.apk
```
Tokens:
Raw