mirror of
https://github.com/gethomepage/homepage.git
synced 2026-01-05 23:12:08 +08:00
doc
This commit is contained in:
@@ -5,6 +5,13 @@ description: TrueNas Scale Widget Configuration
|
||||
|
||||
Learn more about [TrueNas](https://www.truenas.com/).
|
||||
|
||||
`version` controls which API the single TrueNAS widget uses (defaults to `1`):
|
||||
|
||||
| TrueNAS API | Homepage widget version |
|
||||
| ---------------------- | ----------------------- |
|
||||
| REST (pre-26.04) | 1 (default) |
|
||||
| WebSocket JSON-RPC 2.0 | 2 |
|
||||
|
||||
Allowed fields: `["load", "uptime", "alerts"]`.
|
||||
|
||||
To create an API Key, follow [the official TrueNAS documentation](https://www.truenas.com/docs/scale/scaletutorials/toptoolbar/managingapikeys/).
|
||||
@@ -17,6 +24,7 @@ To use the `enablePools` option with TrueNAS Core, the `nasType` parameter is re
|
||||
widget:
|
||||
type: truenas
|
||||
url: http://truenas.host.or.ip
|
||||
version: 2 # optional, defaults to 1
|
||||
username: user # not required if using api key
|
||||
password: pass # not required if using api key
|
||||
key: yourtruenasapikey # not required if using username / password
|
||||
|
||||
Reference in New Issue
Block a user