mirror of
https://github.com/gethomepage/homepage.git
synced 2026-01-11 19:42:09 +08:00
82d4d15622
Some checks failed
Crowdin Action / Crowdin Sync (push) Has been cancelled
Docker CI / Linting Checks (push) Has been cancelled
Docker CI / Docker Build & Push (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
32 lines
1.1 KiB
Markdown
32 lines
1.1 KiB
Markdown
---
|
|
title: TrueNas
|
|
description: TrueNas Scale Widget Configuration
|
|
---
|
|
|
|
Learn more about [TrueNas](https://www.truenas.com/).
|
|
|
|
| TrueNAS Version | Homepage widget version |
|
|
| ----------------------- | ----------------------- |
|
|
| < 26.04 (REST API) | 1 (default) |
|
|
| > 25.04 (Websocket API) | 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/).
|
|
|
|
A detailed pool listing is disabled by default, but can be enabled with the `enablePools` option.
|
|
|
|
To use the `enablePools` option with TrueNAS Core, the `nasType` parameter is required.
|
|
|
|
```yaml
|
|
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
|
|
enablePools: true # optional, defaults to false
|
|
nasType: scale # defaults to scale, must be set to 'core' if using enablePools with TrueNAS Core
|
|
```
|