immich-kiosk

command module
v0.33.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 27, 2026 License: AGPL-3.0 Imports: 25 Imported by: 0

README

Immich Kiosk





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.

Discord button

Documentation

Overview

Package main is the entry point for the Immich Kiosk application.

It sets up the web server, configures routes, and handles the main application logic for displaying and managing images in a kiosk mode. The package includes functionality for loading configurations, setting up middleware, and serving both dynamic content and static assets.

Directories

Path Synopsis
internal
common
Package common provides shared types and utilities for the immich-kiosk application
Package common provides shared types and utilities for the immich-kiosk application
config
Package config provides configuration management for the Immich Kiosk application.
Package config provides configuration management for the Immich Kiosk application.
immich
Package immich provides functions to interact with the Immich API.
Package immich provides functions to interact with the Immich API.
immich_open_api
Package immich_open_api provides primitives to interact with the openapi HTTP API.
Package immich_open_api provides primitives to interact with the openapi HTTP API.
kiosk
kiosk constants
kiosk constants
routes
Package routes provides HTTP endpoint handlers for the Kiosk application.
Package routes provides HTTP endpoint handlers for the Kiosk application.
utils
Package utils provides a collection of helper functions for various tasks.
Package utils provides a collection of helper functions for various tasks.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL