Immich Kiosk 使用指南

Immich Kiosk 使用指南

immich-kiosk Immich Kiosk is a lightweight slideshow for running on kiosk devices and browsers that uses Immich as a data source. 项目地址: https://gitcode.com/gh_mirrors/im/immich-kiosk

1. 项目介绍

Immich Kiosk 是一个轻量级的幻灯片展示应用，可在售货亭设备或浏览器上运行，使用 Immich 作为数据源。它适用于展示 Immich 服务器上的图片，支持自定义布局、过渡效果和设备设置。

2. 项目快速启动

Docker 启动

1. 创建一个目录用来存放 docker-compose.yaml 文件和配置文件。

   mkdir ./immich-kiosk
   cd ./immich-kiosk
   

2. 下载 docker-compose.yaml 文件。

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

3. 设置语言和时区环境变量。

   export LANG="zh_CN"
   export TZ="Asia/Shanghai"
   

4. 创建配置目录并下载 config.yaml 文件。

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

5. 修改 config.yaml 文件，至少设置 immich_url 和 immich_api_key 字段。

   immich_url: "http://your_immich_server_url"
   immich_api_key: "your_immich_api_key"
   

6. 启动容器。

   docker compose up -d
   

二进制文件启动

1. 下载对应架构的二进制文件并解压。

   # 下载命令示例，根据实际架构替换 URL
   wget -O kiosk "https://github.com/damonolding/immich-kiosk/releases/latest/download/kiosk-amd64"
   chmod +x kiosk
   

2. 创建配置目录并下载 config.yaml 文件。

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

3. 修改 config.yaml 文件，至少设置 immich_url 和 immich_api_key 字段。

   immich_url: "http://your_immich_server_url"
   immich_api_key: "your_immich_api_key"
   

4. 启动 Kiosk。

   ./kiosk
   

3. 应用案例和最佳实践

案例一： Raspberry Pi

• 使用 DietPi 或其他适合的操作系统。
• 通过 URL 参数自定义展示内容，例如：

  http://immich_kiosk_url?album=ALBUM_ID&transition=none&show_time=false
  

案例二：电视展示

• 展示随机图片或特定人员的图片。
• 使用 URL 参数设置图片填充方式及过渡效果，例如：

  http://immich_kiosk_url?image_fit=cover&transition=fade&person=PERSON_1_ID&person=PERSON_2_ID
  

4. 典型生态项目

• Immich: 图片管理服务，用于存储和检索图片。
• Immich Kiosk: 展示 Immich 存储的图片的轻量级幻灯片应用。

以上是 Immich Kiosk 的基本使用指南，你可以根据实际需求调整配置，实现个性化的展示效果。

immich-kiosk Immich Kiosk is a lightweight slideshow for running on kiosk devices and browsers that uses Immich as a data source. 项目地址: https://gitcode.com/gh_mirrors/im/immich-kiosk