bokker/unraidapi-re Docker 镜像 - 轩辕镜像 | Docker 镜像高效稳定拉取服务

UnraidAPI-RE

图标由 Freepik 制作

用于控制多个Unraid实例并连接到Home Assistant的新UI和API
原项目ElectricBrainUK/UnraidAPI的分支（原项目已停止维护）

提交 issue

标签遵循Unraid主要版本， minor版本通常也兼容：
docker pull bokker/unraidapi-re:6.12 适用于Unraid 6.12

外部链接

• Unraid论坛支持主题
• Docker Hub

安装

Unraid社区应用

• 安装社区应用（CA）：***安装CA教程 & CA支持论坛
• 进入应用选项卡，搜索unraid-api并安装。

Home Assistant插件

• 添加自定义仓库：[***]
• 构建插件
• 填写配置部分
• 启动

环境变量

Home Assistant集成

自动集成

参考Home Assistant文档设置MQTT发现：
[***]

通过环境变量配置MQTT客户端并连接到MQTT代理。若Home Assistant启用自动发现，将创建以下实体：

• 每台服务器的实体：
  • （传感器）服务器状态监控
  • （开关）阵列启动/停止开关
• 每个虚拟机的实体：
  • （开关）虚拟机状态切换（启动/停止）
  • （开关）独立的USB设备连接/断开开关
  • （传感器）特定USB设备是否连接（可用于自动化热插拔，如连接时切换USB开关）
• 每个Docker容器的实体：
  • （开关）Docker状态切换（启动/停止）

生成的实体示例：

• binary_sensor.unraid_server （属性包含服务器信息）
• binary_sensor.unraid_vm_VMNAME_usb_USBDEVICE
• sensor.unraid_vm_VMNAME_status （属性包含VM统计信息）
• switch.unraid_array
• switch.unraid_docker_DOCKERNAME （属性包含Docker信息）
• switch.unraid_vm_VMNAME （属性包含VM信息）

手动集成

手动配置示例：
服务器和VM名称与MQTT中一致（空格替换为下划线，全小写）
** payload选项 ： started, stopped, paused, restart, kill, hibernate**

yaml
- platform: mqtt
  command_topic: "homeassistant/servername/vmname/state"
  payload_on: "started"
  payload_off: "stopped"

当Unraid API连接到MQTT代理时，所有API功能的配置详情会发布到各种Home Assistant实体类型下，例如homeassistant/switch/server/vm/config。