Immich Kiosk 安装与配置指南
1. 项目基础介绍
Immich Kiosk 是一个轻量级的幻灯片应用程序,专为在售货亭设备或浏览器上运行而设计。它使用 Immich 作为数据源,可以展示 Immich 服务器上的图片和视频。
主要编程语言:Go
2. 项目使用的关键技术和框架
- Go:项目主要使用 Go 语言开发,保证了程序的效率和简洁性。
- Docker:使用 Docker 可以方便地进行项目的部署和环境配置。
- Web框架:项目使用前端框架来构建用户界面,提供响应式的用户体验。
3. 项目安装和配置的准备工作
在开始安装之前,请确保您的系统中已经安装以下软件:
- Docker
- Git
安装步骤
第一步:克隆项目仓库
打开终端(或命令提示符),执行以下命令克隆项目仓库:
git clone https://github.com/damongolding/immich-kiosk.git
cd immich-kiosk
第二步:配置 Immich 服务器
确保您的 Immich 服务器正在运行,并且版本至少为 v1.127.0。您需要知道 Immich 服务器的 URL 和 API 密钥。
第三步:创建配置文件
在项目目录中创建一个名为 config
的文件夹,并在此文件夹中创建 config.yaml
文件。该文件应包含以下内容:
immich_url: "您的 Immich 服务器地址"
immich_api_key: "您的 Immich API 密钥"
第四步:启动 Docker 容器
在项目目录中,使用以下命令启动 Docker 容器:
docker-compose up -d
如果您的系统不支持 docker-compose
命令,您可以尝试直接运行 Docker 容器。
第五步:访问 Kiosk
在浏览器中输入 http://localhost:3000
,您应该可以看到 Immich Kiosk 的界面。
以上步骤为基本的安装流程,您可以根据实际需要调整配置文件中的设置,以适应不同的展示需求。