homepage/docs/widgets/services/truenas.md
2024-03-31 20:59:36 -04:00

923 B

title description
TrueNas TrueNas Scale Widget Configuration

Learn more about TrueNas.

Allowed fields: ["load", "uptime", "alerts"].

To create an API Key, follow the official TrueNAS documentation.

A detailed pool listing is disabled by default, but can be enabled with the enablePools option.

The Scale and Core API's provide information on the pools in different manners. The nasType option choses which API response parsing should be used.

widget:
  type: truenas
  url: http://truenas.host.or.ip
  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, values are core or scale