8x48/homepage
1
0
Fork 0
mirror of https://github.com/gethomepage/homepage.git synced 2026-01-15 22:02:12 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

doc

Browse Source
This commit is contained in:
shamoon
2026-01-03 12:45:50 -08:00
parent 189ee5742f
commit e892432b72
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/widgets/services/truenas.md
View File

@@ -5,6 +5,13 @@ description: TrueNas Scale Widget Configuration
Learn more about [TrueNas](https://www.truenas.com/). 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"]`. Allowed fields: `["load", "uptime", "alerts"]`.
To create an API Key, follow [the official TrueNAS documentation](https://www.truenas.com/docs/scale/scaletutorials/toptoolbar/managingapikeys/). 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: widget:
type: truenas type: truenas
url: http://truenas.host.or.ip url: http://truenas.host.or.ip
version: 2 # optional, defaults to 1
username: user # not required if using api key username: user # not required if using api key
password: pass # not required if using api key password: pass # not required if using api key
key: yourtruenasapikey # not required if using username / password key: yourtruenasapikey # not required if using username / password