homepage/docs/widgets/services/truenas.md

title, description

title	description
TrueNas	TrueNas Scale Widget Configuration

Learn more about TrueNas.

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.

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.

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