iobroker.unraid 0.5.1 → 0.5.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -19,17 +19,45 @@ This adapter connects ioBroker to Unraid servers via the GraphQL API to monitor
19
19
 
20
20
  ## Features
21
21
 
22
- - Monitor CPU and memory usage
22
+ - Monitor CPU and memory usage (including per-core statistics)
23
23
  - Track server status and network information
24
+ - Monitor Docker containers status and resources
25
+ - View array disks (data, parity, cache) with health information
26
+ - Track network shares usage
27
+ - Monitor virtual machines status
24
28
  - View system time and operating system details
25
29
  - Support for self-signed certificates
26
30
  - Configurable polling interval
31
+ - Dynamic state creation based on available resources
27
32
 
28
33
  ## Configuration
29
34
 
35
+ ### Generating an API Token in Unraid
36
+
37
+ #### For Unraid versions before 7.2:
38
+
39
+ 1. Install the **"Unraid Connect Plugin"** from the Unraid Community Applications store
40
+ 2. After installation, navigate to: **Settings → Management Access → API Keys**
41
+
42
+ #### For Unraid 7.2 and later:
43
+
44
+ - API functionality is built-in, go directly to: **Settings → Management Access → API Keys**
45
+
46
+ #### Creating the Token:
47
+
48
+ 1. Click on **"Add API Key"**
49
+ 2. **Important**: Select **"Admin"** as the access level (Roles: ADMIN)
50
+ - Currently only Admin tokens work properly (see [this forum post](https://forums.unraid.net/topic/193661-api-access-always-403-forbidden/))
51
+ 3. Give the token a descriptive name (e.g., "ioBroker")
52
+ 4. Copy the generated token (API Key) - you'll need it for the adapter configuration
53
+
54
+ ![Unraid API Token](docs/de/img/unraid_token01.png)
55
+
56
+ ### Adapter Settings
57
+
30
58
  1. **Base URL**: Enter your Unraid server address (e.g., `https://192.168.1.10` or `https://tower.local`)
31
- 2. **API Token**: Generate an API token in your Unraid web UI settings and paste it here
32
- 3. **Polling Interval**: Set how often to fetch data (default: 60 seconds)
59
+ 2. **API Token**: Paste the Admin token you generated in Unraid
60
+ 3. **Polling Interval**: Set how often to fetch data (default: 60 seconds, minimum: 10 seconds)
33
61
  4. **Self-signed Certificates**: Enable if your Unraid server uses a self-signed HTTPS certificate
34
62
  5. **Data Domains**: Select which data categories to monitor (System Info, Server Status, Metrics, etc.)
35
63
 
@@ -41,13 +69,16 @@ This adapter connects ioBroker to Unraid servers via the GraphQL API to monitor
41
69
 
42
70
  The adapter creates a structured tree of objects for the monitored data:
43
71
 
44
- ![Objects](docs/de/img/ioBroker_Objects01.png)
72
+ ![Objects](docs/de/img/ioBroker_objects01.png)
45
73
 
46
74
  ## Requirements
47
75
 
48
- - Unraid server with GraphQL API enabled
49
- - API token generated in Unraid web UI
76
+ - Unraid server (version 7.0.0+ recommended)
77
+ - For versions before 7.2: Install "Unraid Connect Plugin" from Community Applications
78
+ - For version 7.2+: API support is built-in
79
+ - Admin-level API token generated in Unraid web UI
50
80
  - Network access from ioBroker to Unraid server
81
+ - ioBroker version 3.0 or higher
51
82
 
52
83
  ## Changelog
53
84
 
@@ -55,6 +86,15 @@ The adapter creates a structured tree of objects for the monitored data:
55
86
  Placeholder for the next version (at the beginning of the line):
56
87
  ### **WORK IN PROGRESS**
57
88
  -->
89
+ ### 0.5.3 (2025-09-23)
90
+
91
+ - (ingel81) Support for node 20, 22 and 24
92
+
93
+ ### 0.5.2 (2025-09-22)
94
+
95
+ - (ingel81) Documentation
96
+ - (ingel81) Minor admin page improvements
97
+
58
98
  ### 0.5.1 (2025-09-22)
59
99
 
60
100
  - (ingel81) ESLint9 Migration