Skip to content
This repository was archived by the owner on Jun 16, 2026. It is now read-only.

Commit b9bd7d7

Browse files
docs(integrations): add truenas (#356)
Co-authored-by: Meier Lukas <meierschlumpf@gmail.com>
1 parent 6dd2314 commit b9bd7d7

4 files changed

Lines changed: 54 additions & 0 deletions

File tree

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: 'TrueNAS'
3+
description: "Enterprise network-attached storage for your home, office, and cloud."
4+
hide_title: true
5+
---
6+
7+
import { IntegrationHeader } from '@site/src/components/integrations/header';
8+
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
9+
import { AddingIntegration } from '@site/src/components/integrations/adding';
10+
import { IntegrationSecrets } from '@site/src/components/integrations/secrets';
11+
import { truenasIntegration } from '.';
12+
import { systemResourcesWidget } from '@site/docs/widgets/system-resources';
13+
import { healthMonitoringWidget } from '@site/docs/widgets/health-monitoring';
14+
15+
16+
<IntegrationHeader
17+
integration={truenasIntegration}
18+
categories={['NAS', 'Hardware']}
19+
/>
20+
21+
### Widgets & Capabilities
22+
<IntegrationCapabilites
23+
items={[
24+
{ widget: healthMonitoringWidget },
25+
{ widget: systemResourcesWidget },
26+
]}
27+
/>
28+
29+
### Adding the integration
30+
<AddingIntegration />
31+
32+
### Secrets
33+
<IntegrationSecrets secrets={[{
34+
credentials: ['username', 'password'],
35+
steps: [
36+
"Create a user on the TrueNAS UI with a secure password at \"Credentials\" > \"Users\" > \"Add User\".",
37+
"Add the auxiliary group \"auxiliary_administrator\" to the user.",
38+
"Save the user and create an integration in Homarr with the previous defined credentials"
39+
],
40+
}]} />

docs/integrations/truenas/index.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import { IntegrationDefinition } from '@site/src/types';
2+
export const truenasIntegration: IntegrationDefinition = {
3+
name: 'TrueNAS',
4+
description: 'Enterprise network-attached storage for your home, office, and cloud.',
5+
iconUrl: 'https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/truenas.svg',
6+
path: '../../integrations/truenas',
7+
};

docs/widgets/health-monitoring/index.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ This widget displays information about the health and status of your system(s),
2828

2929
import systemView from './img/system-view.png';
3030
import clusterView from './img/cluster-view.png';
31+
import { truenasIntegration } from '@site/docs/integrations/truenas';
3132

3233
<img src={systemView} alt="health-monitoring system-view" width={256} height={256} />
3334
<img src={clusterView} alt="health-monitoring cluster-view" width={256} height={256} />
@@ -40,6 +41,9 @@ import clusterView from './img/cluster-view.png';
4041
}, {
4142
integration: openMediaVaultIntegration,
4243
note: "Will display information on the system tab"
44+
}, {
45+
integration: truenasIntegration,
46+
note: "Will display information on the system tab"
4347
}, {
4448
integration: proxmoxIntegration,
4549
note: "Will display information on the cluster tab, only supports one integration at a time"

docs/widgets/system-resources/index.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Displays CPU, RAM and network of your host in real time
2424
### Screenshots
2525

2626
import widget from './img/dark-widget.png';
27+
import { truenasIntegration } from '@site/docs/integrations/truenas';
2728

2829
<div className='flex gap-1'>
2930
<img src={widget} alt="system resources widget" width={256} height={256} />
@@ -35,6 +36,8 @@ import widget from './img/dark-widget.png';
3536
integration: dashDotIntegration
3637
}, {
3738
integration: openMediaVaultIntegration
39+
}, {
40+
integration: truenasIntegration
3841
}]} />
3942

4043
### Adding the widget

0 commit comments

Comments
 (0)