unraidclaw

Complete Unraid server management via the UnraidCLaW REST API. Covers: - Docker containers (create/start/stop/remove/logs) - VMs (start/stop/restart/pause) - Array operations (start/stop/parity) - Disks, shares, users, network, notifications, system - Full permission matrix and API key management Requires: UnraidCLaW plugin installed and enabled on Unraid. API Base: https://<UNRAID_IP>:9876 | Auth: x-api-key header Version requirement: **Always sync with the latest UnraidCLaW version.** Currently tested against: **v0.1.27**. If `GET /api/health` returns a different (older) version, alert the user that a newer UnraidCLaW is available and suggest upgrading. Use when: managing Unraid containers, VMs, array, or system tasks via API rather than SSH or WebUI.

Ir a la instalación

Repositorio: GeorgeDoors888/GB-Power-Market-JJ
Última actividad en el origen: 16 de abril de 2026 a las 00:11
Idioma detectado de SKILL.md: chino
Estrellas: 3
Forks: 1

Opciones de instalación

De forma predeterminada está seleccionado el prompt que primero revisa el origen. Puedes cambiar a un comando directo o descargar una copia local.

Instalar con Codex o Claude Copia este prompt, pégalo en Codex, Claude u otro asistente, y deja que revise la página de la skill y la instale por ti.

Un comando directo omite el prompt de revisión. Revisa el origen antes de ejecutarlo.

npx skills add https://github.com/GeorgeDoors888/GB-Power-Market-JJ --skill unraidclaw

El comando permanece en una sola línea. Desplázate horizontalmente para revisarlo antes de copiarlo.

¿Prefieres una copia local? Descarga los archivos que SkillsMP tiene disponibles ahora.

Revisa los archivos de origen

Lee SKILL.md y los archivos complementarios que muestra SkillsMP antes de decidir si quieres instalarlo.

Explorador de archivos

5 archivos

SKILL.md

Instrucciones de origen · Vista previa de solo lectura

Volver a la búsqueda Volver a la instalación

name

unraidclaw

description

UnraidCLaW 全套操作指南

API 基础

Base URL: https://<UNRAID_IP>:9876
认证: x-api-key: <API_KEY> (Header)
返回格式: 统一包络 { "ok": true, "data": {...} } 或 { "ok": false, "error": {...} }
TLS: 默认自签名证书，请求时加 -k 或在业务系统中关闭证书验证

版本检查（每次操作前必读）

当前测试版本: v0.1.27

每次执行 UnraidCLaW 操作前，先检查插件版本：

curl -s -k -H "x-api-key: $TOKEN" https://<UNRAID_IP>:9876/api/health
# 返回: {"ok":true,"data":{"status":"ok","version":"0.1.27","uptime":...}}

如果版本低于当前测试版本：

提醒用户："检测到 UnraidCLaW 版本为 X.X.X，最新版本为 0.1.27，建议升级以获得更好的兼容性"
升级方式：在 Unraid 社区应用里搜索 "UnraidClaw" 更新，或手动下载最新 txz 包

如果版本高于 0.1.27：

说明：技能描述基于 0.1.27，如遇 API 差异请告知

已知版本历史:

0.1.27 — 当前测试版本
0.1.21 — 历史安装包（仍存在于磁盘）

API 端点总表

分类	方法	端点	权限
Health	GET	`/api/health`	无
Docker	GET	`/api/docker/containers`	docker:read
Docker	GET	`/api/docker/containers/:id`	docker:read
Docker	GET	`/api/docker/containers/:id/logs`	docker:read
Docker	POST	`/api/docker/containers`	docker:create
Docker	POST	`/api/docker/containers/:id/:action`	docker:update
Docker	DELETE	`/api/docker/containers/:id`	docker:delete
VMs	GET	`/api/vms`	vms:read
VMs	GET	`/api/vms/:id`	vms:read
VMs	POST	`/api/vms/:id/:action`	vms:update
VMs	DELETE	`/api/vms/:id`	vms:delete
Array	GET	`/api/array/status`	array:read
Array	GET	`/api/array/parity/status`	array:read
Array	POST	`/api/array/start`	array:update
Array	POST	`/api/array/stop`	array:update
Array	POST	`/api/array/parity/start`	array:update
Array	POST	`/api/array/parity/pause`	array:update
Array	POST	`/api/array/parity/resume`	array:update
Array

权限矩阵

分类	权限
Docker	docker:read, docker:create, docker:update, docker:delete
VMs	vms:read, vms:update, vms:delete
阵列/存储	array:read, array:update, disk:read, share:read, share:update
系统	info:read, os:update, services:read
通知	notification:read, notification:create, notification:update, notification:delete
网络	network:read
用户	me:read
日志	logs:read

预设角色：Read Only、Docker Manager、VM Manager、Full Admin、None

核心操作详解

1. 容器列表

curl -s -k -H "x-api-key: $UNRAIDCLAW_TOKEN" \
  https://192.168.8.11:9876/api/docker/containers | python3 -m json.tool

2. 创建容器（POST /api/docker/containers）

Body 参数（仅 image 必填）：

{
  "image": "ghcr.io/anomalyco/opencode:latest",
  "name": "opencode",
  "ports": ["4096:4096", "4097:4097"],
  "volumes": [
    "/mnt/user/appdata/opencode/config:/home/opencode/.config/opencode",
    "/mnt/user/appdata/opencode/data:/home/opencode/.local/share/opencode"
  ],
  "env": [
    "HTTP_PROXY=http://192.168.8.30:7893",
    "HTTPS_PROXY=http://192.168.8.30:7893",
    "NO_PROXY=localhost,127.0.0.1",
    "ENABLE_WEB_UI=true",
    "PUID=99",
    "PGID=100"
  ],
  "restart": "unless-stopped",
  "network": "bridge",
  "icon": "https://example.com/icon.png",
  "webui"

注意：

容器创建后会自动生成 DockerMan XML 模板，出现在 Unraid Docker 页面
volumes 格式：宿主机路径:容器内路径
env 格式：KEY=value
ports 格式：宿主机端口:容器端口

3. 容器操作（POST /api/docker/containers/:id/:action）

# 启动
curl -s -k -X POST -H "x-api-key: $TOKEN" \
  https://HOST/api/docker/containers/opencode/start

# 停止
curl -s -k -X POST -H "x-api-key: $TOKEN" \
  https://HOST/api/docker/containers/opencode/stop

# 重启
curl -s -k -X POST -H "x-api-key: $TOKEN" \
  https://HOST/api/docker/containers/opencode/restart

# 暂停
curl -s -k -X POST -H "x-api-key: $TOKEN" \
  https://HOST/api/docker/containers/opencode/pause

# 取消暂停
curl -s -k -X POST -H "x-api-key: $TOKEN" \
  https://HOST/api/docker/containers/opencode/unpause

4. 查看容器日志

curl -s -k -H "x-api-key: $TOKEN" \
  "https://HOST/api/docker/containers/opencode/logs?stdout=1&stderr=1&tail=50"

5. 删除容器

curl -s -k -X DELETE -H "x-api-key: $TOKEN" \
  https://HOST/api/docker/containers/opencode

6. 阵列操作

# 查看阵列状态
curl -s -k -H "x-api-key: $TOKEN" \
  https://HOST/api/array/status

# 启动阵列
curl -s -k -X POST -H "x-api-key: $TOKEN" \
  https://HOST/api/array/start

# 停止阵列
curl -s -k -X POST -H "x-api-key: $TOKEN" \
  https://HOST/api/array/stop

7. 系统操作

# 重启 Unraid 宿主机
curl -s -k -X POST -H "x-api-key: $TOKEN" \
  https://HOST/api/system/reboot

# 关机
curl -s -k -X POST -H "x-api-key: $TOKEN" \
  https://HOST/api/system/shutdown

8. VM 操作

# 列表
curl -s -k -H "x-api-key: $TOKEN" \
  https://HOST/api/vms

# 启动/停止/重启/强制停止
curl -s -k -X POST -H "x-api-key: $TOKEN" \
  "https://HOST/api/vms/<vm_id>/start"

curl -s -k -X POST -H "x-api-key: $TOKEN" \
  "https://HOST/api/vms/<vm_id>/stop"

9. 创建通知

curl -s -k -X POST -H "x-api-key: $TOKEN" \
  -H "Content-Type: application/json" \
  https://HOST/api/notifications \
  -d '{
    "title": "容器已停止",
    "body": "OpenCode 容器在 19:55 异常停止",
    "severity": "warning"
  }'

镜像访问代理配置（国内必读）

国内服务器访问 ghcr.io（GitHub Container Registry）通常需要代理。在创建容器时通过 env 传入：

"env": [
  "HTTP_PROXY=http://192.168.8.30:7893",
  "HTTPS_PROXY=http://192.168.8.30:7893",
  "NO_PROXY=localhost,127.0.0.1,192.168.0.0/16"
]

但注意：

代理环境变量作用于容器内进程，如果镜像拉取在 Docker daemon 层发生（如使用代理registry），需要在 Unraid Docker 设置里配置 registry mirror
容器运行时的 HTTP_PROXY/HTTPS_PROXY 影响容器内所有出站请求

常见错误处理

错误码	含义	解决方案
`GRAPHQL_ERROR` / Invalid CSRF token	API Key 权限不足或格式错误	检查 Key 是否有对应操作权限
`DOCKER_CREATE_FAILED` / Conflict	容器名已占用	先删除同名容器
`DOCKER_CREATE_FAILED` / No such image	镜像在主机上不存在	手动 `docker pull` 或配置代理
`DOCKER_CREATE_FAILED` / network not found	网络不存在	检查 `network` 字段，用 `bridge`
`NOT_FOUND`	端点或资源不存在	检查 URL 和容器/VM ID

脚本工具

配套脚本在 scripts/ 目录：

unraid_docker.sh — Docker 容器常用操作（创建/启动/停止/删除/日志）
unraid_common.sh — 公共函数（API 调用/凭据读取）
opencode_install.sh — OpenCode Docker 容器一键安装（带代理）

使用前先设置环境变量或在 .env 文件中配置：

export UNRAIDCLAW_TOKEN="your-api-key-here"
export UNRAID_HOST="192.168.8.11"

参考文档

UnraidCLaW GitHub: https://github.com/emaspa/unraidclaw
API 完整源码: packages/unraid-plugin/server
OpenClaw Plugin: packages/openclaw-plugin（以 npm 包 unraidclaw 发布）

unraidclaw

Datos de origen

Opciones de instalación

Revisa los archivos de origen

Más de este repositorio

Más de este repositorio

UnraidCLaW 全套操作指南

API 基础

版本检查（每次操作前必读）

API 端点总表

权限矩阵

核心操作详解

1. 容器列表

2. 创建容器（POST /api/docker/containers）

3. 容器操作（POST /api/docker/containers/:id/:action）

4. 查看容器日志

5. 删除容器

6. 阵列操作

7. 系统操作

8. VM 操作

9. 创建通知

镜像访问代理配置（国内必读）

常见错误处理

脚本工具

参考文档

UnraidCLaW 全套操作指南

API 基础

版本检查（每次操作前必读）

API 端点总表

权限矩阵

核心操作详解

1. 容器列表

2. 创建容器（POST /api/docker/containers）

3. 容器操作（POST /api/docker/containers/:id/:action）

4. 查看容器日志

5. 删除容器

6. 阵列操作

7. 系统操作

8. VM 操作

9. 创建通知

镜像访问代理配置（国内必读）

常见错误处理

脚本工具

参考文档