Unraid

Monitor and control Unraid servers

Current Release
0.10.0
Developer
ingel81
License
MIT

⚠️ Work in Progress: This adapter is under active development. Additional data points and features are planned for future releases.

unraid adapter for ioBroker

This adapter connects ioBroker to Unraid servers via the GraphQL API to monitor system metrics and status.

Features

  • Monitor CPU and memory usage (including per-core statistics)
  • Monitor mainboard temperature sensors (chipset, ambient, ...) — requires Unraid 7.2+
  • Track server status and network information
  • Monitor and control Docker containers (start/stop/pause/resume/update) — pause/resume/update require Unraid 7.2+
  • Docker update detection per container and as a summary — requires Unraid 7.2+
  • View array disks (data, parity, cache) with health information
  • Monitor network shares (usage, configuration, file system details)
  • Monitor and control virtual machines (start/stop/pause/resume/reboot)
  • Configurable polling interval

Configuration

Generating an API Token in Unraid

For Unraid versions before 7.2:

  1. Install the "Unraid Connect Plugin" from the Unraid Community Applications store
  2. After installation, navigate to: Settings → Management Access → API Keys

For Unraid 7.2 and later:

  • API functionality is built-in, go directly to: Settings → Management Access → API Keys

Creating the Token:

  1. Click on "Add API Key"

  2. Configure the permissions:

    • Base Role: Select "Viewer" (provides read access to system info, metrics, disks, etc.)
    • Additional Permissions (required for control features):
      • Docker Manager: Allows starting/stopping Docker containers
      • VM Manager: Allows starting/stopping/pausing virtual machines

    Quick Setup Alternative: Copy this template string and paste it into API Keys → "Create from template":

    ?name=ioBroker+unraid+adapter+key&scopes=role%3Aviewer%2Cdocker%2Bvms%3Acreate_any%2Bdelete_any%2Bread_any%2Bupdate_any%2Carray%2Bdashboard%2Bdisk%2Binfo%2Blogs%2Bnetwork%3Aread_any

  3. Give the token a descriptive name (e.g., "ioBroker")

  4. Copy the generated token (API Key) - you'll need it for the adapter configuration

Unraid API Token

Adapter Settings

  1. Base URL: Enter your Unraid server address (e.g., https://192.168.1.10 or https://tower.local)
  2. API Token: Paste the Admin token you generated in Unraid
  3. Polling Interval: Set how often to fetch data (default: 60 seconds, minimum: 10 seconds)
  4. Self-signed Certificates: Enable if your Unraid server uses a self-signed HTTPS certificate
  5. Data Domains: Select which data categories to monitor (System Info, Server Status, Metrics, etc.)

Configuration Interface

Configuration

Created Objects

The adapter creates a structured tree of objects for the monitored data:

Objects

Docker Container Controls

VM Controls

Requirements

  • Unraid server (version 7.0.0+ recommended)
    • For versions before 7.2: Install "Unraid Connect Plugin" from Community Applications
    • For version 7.2+: API support is built-in
  • API token with Viewer role (plus Docker/VM Manager for control features)
  • Network access from ioBroker to Unraid server

Changelog

0.10.0 (2026-08-21)

  • (ingel81) Security fixes in the network libraries (ws, undici)
  • (ingel81) Node.js 22.19.0 or higher is required — this has been the case since 0.8.0, the adapter just declared 22.0.0 by mistake
  • (ingel81) Completed the settings translations for all languages (Ukrainian was mostly missing)
  • (ingel81) Updated Apollo Client, graphql-ws and the ioBroker adapter core

0.9.0 (2026-05-03)

  • (ingel81) New mainboard temperature sensors (chipset, ambient, ...) as an optional data domain
  • (ingel81) New update indicator per Docker container plus a summary (docker.updates.hasUpdates / availableCount)
  • (ingel81) New Pause, Resume and Update buttons for Docker containers
  • (ingel81) Requires Unraid 7.2 or newer for the new features (tested on 7.2.4). Older Unraid versions keep working as before — new states are silently omitted and existing data is preserved.

0.8.0 (2026-04-19)

  • (ingel81) Node.js 22 or higher is now required (Node 20 reached end-of-life on 2026-03-24)
  • (ingel81) Requires ioBroker admin 7.6.20 or newer
  • (ingel81) Updated runtime dependencies (graphql, undici, ws, @apollo/client)
  • (ingel81) Internal: CI migrated to Node 22/24, dev dependencies refreshed

0.7.2 (2026-01-04)

  • (ingel81) Updated dependencies and admin UI (React 19)

0.7.1 (2025-11-30)

  • (ingel81) Minor pipeline issues fixed

License

MIT License

Copyright (c) 2025-2026 ingel81 ingel81@sgeht.net

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.