TrueNAS
NASHardware
Enterprise network-attached storage for your home, office, and cloud.
Widgets & Capabilities​
Adding the integration​
You can find how to add the integration on the Integrations Management documentation page.
Use the HTTPS address
TrueNAS only serves its API over HTTPS, so enter the https:// URL of your TrueNAS web interface. If it uses a self-signed certificate (the default), add it under Management > Tools > Certificates so Homarr can establish the connection.
Secrets​
- API Key
- Username & Password
Recommended
API key authentication is the recommended method. It works across current TrueNAS versions and does not depend on user group membership.
| Name | Description |
|---|---|
API Key | API Key from the service for authentication. |
Steps to retrieve the credentials:
- In the TrueNAS web interface, click your user avatar in the top-right corner and select "API Keys".
- Click "Add", give the key a name such as "Homarr", and confirm.
- Copy the generated key immediately - TrueNAS only shows it once - and paste it as the API Key when creating the integration in Homarr.
| Name | Description |
|---|---|
Username | Account username for authentication. |
Password | Account password for authentication. |
Administrative access required
The account must have administrative API access. The
auxiliary_administrator group was removed in TrueNAS 25.10; on that version or newer, use API key authentication instead, or assign the user a full-admin role.Steps to retrieve the credentials:
- In the TrueNAS web interface, go to "Credentials" > "Users" > "Add" and create a user with a secure password.
- Grant the user administrative access so Homarr can read system, pool, and reporting data.
- Save the user and create the integration in Homarr with these credentials.