Truenas Skill

🖥️ TrueNAS 全能管家,一键掌控 NAS 与容器生态

TrueNAS SCALE 管理中枢,集成 ZFS 存储监控、快照备份、容器编排与 homelab 服务自动化,支持 REST/WebSocket 双协议。

收藏
8.2k
安装
2.3k
版本
1.1.0
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心功能与用法

TrueNAS Skill 是一套面向自托管 NAS 环境的综合管理工具,主要功能覆盖三大层面:

1. 存储与数据保护:通过 TrueNAS API 监控 ZFS Pool 健康状态,管理数据集(dataset)的创建与销毁,执行手动或计划快照(snapshot),并监控复制任务(replication)状态。支持 REST API(24.10/25.x)与 WebSocket API(25.04+ 推荐)两种调用方式,后者通过 truenas-ws.mjs 脚本封装了 DDP 协议握手与认证流程。

2. 容器与应用编排:原生支持 TrueNAS Apps 市场应用的安装、更新与状态查询;同时集成 Dockge(Docker Compose UI),通过 Socket.IO 协议管理非官方容器栈,支持批量更新与运行状态监控。

3. Homelab 生态整合:预置 15+ 主流服务的 API 参考配置,包括 Sonarr/Radarr 媒体管理、Plex/Tautulli 播放监控、qBittorrent/SABnzbd 下载工具、Overseerr 媒体请求、Syncthing 同步、n8n 自动化等,形成从存储到服务的完整闭环。

显著优势

  • 双协议兼容:主动适配 TrueNAS API 演进(REST 废弃→WebSocket),延长工具生命周期
  • 零信任友好:支持 API Key + HTTPS 自签名证书(-k 模式),契合家庭内网场景
  • 生态完整:不仅是 NAS 工具,更是 homelab 中台,将 bookmarks(Karakeep)、游戏服务器(Crafty)、数据库(NocoDB)等纳入统一接口
  • 声明式安全:敏感操作(如 dataset 删除)强制要求用户确认,避免误删

局限性与风险

  • 版本锁定:TrueNAS 26.04 将彻底移除 REST API,旧版脚本需升级;WebSocket 协议文档较少,调试门槛较高
  • 权限集中:单一 API Key 通常拥有管理员权限,泄露即等于完全控权
  • 网络暴露:依赖 curl -k 跳过证书验证,存在中间人攻击风险;Docker Socket 暴露给 Dockge 时同样高危
  • 依赖较重:需 Node.js 18+、npm 依赖安装,对精简环境不够友好

适合人群

  • 运行 TrueNAS SCALE 24.10+ 的 homelab 用户
  • 需要将 NAS 操作与媒体/下载/自动化工作流串联的技术爱好者
  • 熟悉 Docker Compose、愿意维护自托管 infra 的进阶用户

常规风险与建议

| 场景 | 风险 | 缓解措施 |
|------|------|----------|
| API Key 泄露 | 完整服务器控制权丧失 | 使用最小权限 Key,定期轮换,存储于环境变量而非代码 |
| 自签名 HTTPS | 证书伪造/MITM | 内网配合 WireGuard/Tailscale,外网强制 valid cert |
| 快照误删 | 数据不可恢复 | 启用 "确认交互" 模式,关键数据异地复制 |
| Dockge Socket.IO 暴露 | 容器逃逸/主机沦陷 | 限制监听 127.0.0.1,配合反向代理认证 |

总体评估:功能强大、生态整合度高,但配置复杂度与权限集中度同步上升,建议具备 Linux 系统管理经验的用户部署。

Truenas Skill 内容

references文件夹
scripts文件夹
手动下载zip · 19.3 kB
app-installation.mdtext/markdown
请选择文件