Skip to content

About

TowerDeck · 塔台 —— 非官方 Unraid 手机客户端,只用官方 GraphQL API。Unofficial Unraid mobile client built on the official GraphQL API.

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Repository files navigation

TowerDeck · 塔台

中文 · English

一个 Android 客户端,通过 Unraid 内置的 官方 GraphQL API 管理你的 Unraid 主机。

非官方项目。 与 Lime Technology 无任何关联,未获其背书。 "Unraid" 是 Lime Technology 的商标,这里仅用于说明本项目连接的对象。


界面

仪表盘 存储 容器
仪表盘 存储 容器
通知 设置 插件商店
通知 设置 插件商店

它能做什么

页面 内容
仪表盘 CPU(含每线程)/ 内存 / 网络吞吐与链路速率 / 磁盘温度 / 阵列容量与仓位 / 容器与虚拟机计数 / UPS / 主板与内存规格 / 引导盘用量
存储 阵列状态与容量、磁盘明细、奇偶校验状态与历史、引导盘、共享配置
容器 列表与图标、启停/重启/暂停/恢复、自启动开关、镜像更新(单个与批量)、容器日志、删除容器;虚拟机 7 个动作
通知 未读/归档两箱、按严重度排序、归档/标为未读/删除、新通知实时推送
更多 服务器列表(多台)、系统日志(可实时跟随)、已装插件、插件商店、设置
设置 服务器标识、时区与 NTP、SSH 开关、UPS 配置(只读)、API 密钥管理

实时数据走 WebSocket 订阅(CPU / 内存 / 网络 / 新通知 / 日志跟随),其余走 30 秒轮询, 退到后台即停止。

它刻意不做什么

  • 不碰会唤醒休眠磁盘的接口。 盘温取自 emhttp 的 array.disks[].temp, 绝不用 metrics.temperature(它 fork smartctl 且不带 -n standby,会把休眠盘转起来)。
  • 只用官方 API + API key,不借 WebUI 登录态调 PHP 端点。API 拿不到的功能就不做, 原因逐条登记在 FEATURES.md 末尾。理由见 ADR-0004。

⚠️ 使用前必读

  • 只在一台机器上验证过:Unraid 7.3.2 / unraid-api 4.36.1,单阵列、单 UPS、单网卡、摄氏度。 多池、华氏度、其它 unraid-api 版本都没验过。
  • 存储页的写操作(启停阵列、奇偶校验、挂载/卸载磁盘、清除统计)从未真正执行过。 文档形状校验通过,但没有一次真跑。点之前请自己想清楚后果。
  • app 里保存的 API key 权限有多大,它就能做多大的事。建议用限权 key,别用 ADMIN。

哪些测过、哪些没测,逐条记在 docs/features/TESTLOG.md。

构建

flutter pub get
dart run build_runner build --delete-conflicting-outputs
flutter build apk --release

验证:

flutter test                                    # 逻辑单测 + 页面冒烟
dart run tool/probe.dart <baseUrl> <apiKey>     # 用 app 真实客户端代码连真机,含 TOFU 流程

机箱图标(可选)

仪表盘上的机箱图标来自 Unraid WebUI 的图标字体,那是 Lime Technology 的资产, 不随本仓库分发。想要那块显示成你在 WebUI 里选的机箱,对着自己的服务器跑一次:

tool/fetch_case_icons.sh https://你的地址 root '密码'

它会抓取并生成 assets/fonts/unraid_cases.ttf 与码位表(均已 gitignore), 并在 pubspec.yaml 里补上字体声明。不跑也能正常编译运行,会退回 WebUI 自带的默认机箱图。

打正式签名的包

仓库里没有签名密钥。要打能上架 / 能长期升级的包,自己生成一次:

keytool -genkey -v -keystore ~/towerdeck-release.jks \
  -keyalg RSA -keysize 2048 -validity 10000 -alias towerdeck

然后写 android/key.properties(已 gitignore):

storeFile=/home/你/towerdeck-release.jks
storePassword=你的密码
keyAlias=towerdeck
keyPassword=你的密码

有这个文件就用正式签名,没有就回落到 debug 签名(能装能跑,但商店不收)。

⚠️ 密钥库丢了,这个 app 就永远无法再更新(Play 会拒绝换签名的新版本)。 请离线备份 .jks 和密码。

配置正式签名(生成密钥库之后跑一次):

tool/setup_signing.sh            # 默认 ~/towerdeck-release.jks,别名 towerdeck

它会先验口令再写 android/key.properties(权限 600,已 gitignore)。

上架 Google Play 要的是 App Bundle:flutter build appbundle --release。

发布

tool/release.sh

产物落在 dist/:按 ABI 拆分的三个包 + 通用包 + SHA256SUMS.txt。 绝大多数手机装 arm64-v8a(约 19 MB);不确定就装 universal(约 53 MB)。

脚本会先跑测试,并在没有配置正式签名时警告后再确认 —— debug key 是公开的,用它签的包任何人都能伪造「更新」。

连接方式

地址由用户手填,局域网 IP 和反向代理域名都行。首次连接会显示自签证书的 SHA-256 指纹让你核对,确认后记住(TOFU),之后指纹不符即拒绝连接。见 ADR-0001。

许可证

Apache License 2.0。第三方素材与商标声明见 NOTICE。

简单说:随便用、随便改、可商用,改了要注明改过;Apache-2.0 附带专利授权。 但 "Unraid" 商标不在授权范围内(许可证第 6 条),本项目也未获 Lime Technology 背书。

文档

About

TowerDeck · 塔台 —— 非官方 Unraid 手机客户端,只用官方 GraphQL API。Unofficial Unraid mobile client built on the official GraphQL API.

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages