【亲测免费】 ImmichFrame 项目安装与使用教程

1. 项目的目录结构及介绍

ImmichFrame 是一个跨平台的数字相框应用程序，支持 Android、Linux、macOS 和 Windows。项目的目录结构如下：

ImmichFrame/
├── Android/
│   └── ImmichFrame/
├── Core/
│   └── ImmichFrame/
├── Desktop/
│   └── ImmichFrame/
├── WebApi/
│   └── ImmichFrame/
├── docker/
│   └── dockerignore
├── LICENSE.txt
├── PrivacyPolicy.md
├── README.Docker.md
├── README.md
├── dockerfile
└── Settings.example.json

目录结构介绍

• Android/: 包含 Android 平台的项目文件。
• Core/: 包含项目的核心代码。
• Desktop/: 包含桌面平台的项目文件。
• WebApi/: 包含 Web API 相关的项目文件。
• docker/: 包含 Docker 相关的配置文件。
• LICENSE.txt: 项目的开源许可证文件。
• PrivacyPolicy.md: 隐私政策文档。
• README.Docker.md: Docker 相关的 README 文件。
• README.md: 项目的主 README 文件。
• dockerfile: Docker 构建文件。
• Settings.example.json: 配置文件的示例。

2. 项目的启动文件介绍

ImmichFrame 的启动文件根据不同的平台有所不同：

Linux

• GUI 启动: 双击 Immich_Frame 文件。
• CLI 启动: 进入文件夹并运行 ./Immich_Frame。
• SSH 启动: 进入文件夹并运行 DISPLAY=:0.0 ./Immich_Frame。

Windows

• GUI 启动: 双击 Immich_Frame.exe 文件。
• 屏保启动: 将 Immich_Frame.exe 重命名为 Immich_Frame.scr，右键点击并选择“安装”。

macOS

• GUI 启动: 双击 Immich_Frame 文件。如果没有任何反应，右键点击并选择“打开方式” → “实用工具” → “终端”，勾选“始终使用此应用打开”。
• CLI 启动: 进入文件夹并运行 ./Immich_Frame。如果遇到权限错误，运行 chmod +x Immich_Frame。

Android

• 屏保启动: 正常运行应用并配置设置，进入“设置” → “显示” → “高级” → “屏幕保护程序”，选择 ImmichFrame。

3. 项目的配置文件介绍

ImmichFrame 的配置文件可以通过 Settings.json 或 GUI 界面进行配置。以下是 Settings.json 的示例和配置说明：

Settings.json 示例

{
  "ImmichServerUrl": "http://yourdomain.com",
  "ApiKey": "YourApiKey",
  "Albums": ["First Album UID", "Second Album UID"],
  "People": ["First Person UID", "Second Person UID"],
  "WeatherApiKey": "YourApiKey",
  "WeatherLatLong": "YourLatitude,YourLongitude"
}

配置项说明

• ImmichServerUrl: Immich 服务器的 URL，可以是域名或本地 IP 地址。
• ApiKey: Immich API 密钥，用于访问 Immich 服务器。
• Albums: 要显示的相册 UID 列表。
• People: 要显示的人物 UID 列表。
• WeatherApiKey: OpenWeatherMap API 密钥，用于显示天气信息。
• WeatherLatLong: 天气信息的纬度和经度。

通过以上配置，您可以根据需要自定义 ImmichFrame 的行为和显示内容。