Files
homepage/docs/widgets/services/unraid.md
Charles Ng a756a01d63
Some checks failed
Crowdin Action / Crowdin Sync (push) Has been cancelled
Docker CI / Linting Checks (push) Has been cancelled
Docs / Linting Checks (push) Has been cancelled
Docker CI / Docker Build & Push (push) Has been cancelled
Docs / Test Build Docs (push) Has been cancelled
Docs / Build & Deploy Docs (push) Has been cancelled
Repository Maintenance / Stale (push) Has been cancelled
Repository Maintenance / Lock Old Threads (push) Has been cancelled
Repository Maintenance / Close Answered Discussions (push) Has been cancelled
Repository Maintenance / Close Outdated Discussions (push) Has been cancelled
Repository Maintenance / Close Unsupported Feature Requests (push) Has been cancelled
Documentation: correct Unraid widget allowed fields (#5908)
2025-10-29 18:52:15 -07:00

1.2 KiB

title, description
title description
Unraid Unraid Widget Configuration

Learn more about Unraid.

The Unraid widget allows you to monitor the resources of an Unraid server.

Minimum Requirements:

  • Unraid 7.2 -or- Unraid Connect plugin 2025.08.19.1850
  • API key with the ADMIN role: Managing API Keys

The widget can display metrics for selected Unraid pools. If using one of the "pool" fields, you must also add the pool name to the settings.

Allowed fields: ["cpu","memoryPercent","memoryAvailable","memoryUsed","notifications","arrayFree","arrayUsedSpace","arrayUsedPercent","status","pool1UsedSpace","pool1FreeSpace","pool1UsedPercent","pool2UsedSpace","pool2FreeSpace","pool2UsedPercent","pool3UsedSpace","pool3FreeSpace","pool3UsedPercent","pool4UsedSpace","pool4FreeSpace","pool4UsedPercent"]

widget:
  type: unraid
  url: https://unraid.host.or.ip
  key: api-key
  pool1: pool1name # required only if using pool1 fields
  pool2: pool2name # required only if using pool2 fields
  pool3: pool3name # required only if using pool3 fields
  pool4: pool4name # required only if using pool4 fields