Unraid PWA

一个可自托管、移动端优先的 Web 应用，用于通过 GraphQL API 监控和控制 Unraid。

截图

在 Unraid 上安装（终端）

此应用尚未上架 Community Applications。请使用 Docker Compose 手动安装。

使用预构建镜像（推荐）

预构建 Docker 镜像会自动发布到 GitHub Container Registry。

在 Unraid 服务器终端运行以下命令：

cd /mnt/user/appdata
git clone https://github.com/laurensguijt/Unraid-PWA.git
cd Unraid-PWA

# 可选：自定义环境变量
cp .env.example .env
nano .env

# 使用预构建镜像启动
docker compose up -d

# 查看状态
docker compose ps

从源码构建

如果你希望在本地构建镜像：

cd /mnt/user/appdata
git clone https://github.com/laurensguijt/Unraid-PWA.git
cd Unraid-PWA

# 可选：自定义环境变量
cp .env.example .env
nano .env

# 构建并启动
docker compose up -d --build

# 查看状态
docker compose ps

打开：

• http://<UNRAID-IP>:2442

首次进入界面后：

1. 添加 Unraid 服务器 URL（https://<unraid-ip>:3443）
2. 添加 Unraid API 密钥
3. 保存设置

在 Unraid 上更新

cd /mnt/user/appdata/Unraid-PWA
git pull
docker compose up -d --build

停止 / 启动

cd /mnt/user/appdata/Unraid-PWA
docker compose down
docker compose up -d

数据持久化

持久化应用数据存放在：

• backend/data/servers.enc（加密后的服务器凭据）
• backend/data/encryption.key（本地加密密钥）
• backend/data/audit.log（写入操作审计日志）

请备份 backend/data 文件夹。

配置

.env 是可选的，默认配置即可直接运行。

可用变量见 .env.example：

• UNRAID_BFF_PORT（默认 3001，在 docker-compose.yml 中映射到宿主机端口 2442）
• UNRAID_BFF_ORIGIN（跨域 /api 请求的 CORS 允许列表；通过 http://<UNRAID-IP>:2442 同源访问时不需要设置）
• UNRAID_BFF_ENCRYPTION_KEY（可选覆盖项；留空时应用会自动生成并持久化 backend/data/encryption.key）
• UNRAID_BFF_ALLOW_SELF_SIGNED (true/false)
• UNRAID_BFF_TRUST_PROXY（false、true 或代理模式）

本地开发

npm --prefix backend install
npm --prefix frontend install
npm run dev:backend
npm run dev:frontend

前端开发地址：

• http://localhost:5173

质量检查

npm run lint
npm run test
npm run test:e2e

许可证

MIT (LICENSE).