mirror of
https://github.com/gethomepage/homepage.git
synced 2025-10-26 16:22:26 -04:00
29 lines
1.2 KiB
Markdown
29 lines
1.2 KiB
Markdown
---
|
|
title: Unraid
|
|
description: Unraid Widget Configuration
|
|
---
|
|
|
|
Learn more about [Unraid](https://unraid.net/).
|
|
|
|
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 **GUEST** (read only) role: [Managing API Keys](https://docs.unraid.net/go/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","arrayFreeSpace","arrayUsedSpace","arrayUsedPercent","status","pool1UsedSpace","pool1FreeSpace","pool1UsedPercent","pool2UsedSpace","pool2FreeSpace","pool2UsedPercent","pool3UsedSpace","pool3FreeSpace","pool3UsedPercent","pool4UsedSpace","pool4FreeSpace","pool4UsedPercent"]`
|
|
|
|
```yaml
|
|
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
|
|
```
|