sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-04-16 15:36:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Edits and add KH Ref (#591)

Browse Source
This commit is contained in:
Brandon Hopkins
2026-02-06 07:38:44 -08:00
committed by GitHub
parent 14c3112fc6
commit b323333df5
1 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/pages/get-started/install/truenas.mdx
View File

@@ -1,8 +1,9 @@
import {Note} from "@/components/mdx";
import {YouTube} from "@/components/YouTube";
# Install NetBird on TrueNAS
NetBird can now be installed on TrueNAS via [TrueNAS Apps](https://apps.truenas.com/catalog/netbird-client/) (the built-in app catalog).
NetBird can now be installed on TrueNAS via [TrueNAS Apps](https://apps.truenas.com/catalog/netbird-client/) (the built-in app catalog). If you need help setting up TrueNAS from scratch (install, storage pools, datasets, users, SMB sharing, and more), see our [Knowledge Hub Guide: TrueNAS Made Easy](https://netbird.io/knowledge-hub/truenas-setup-and-remote-access).
<Note>
The NetBird app on TrueNAS runs in a Docker container. You **cannot** use the peer's NetBird IP address or [NetBird domain (hostname)](/manage/dns/index) to connect directly to your TrueNAS instance traffic to those addresses reaches the container, not the TrueNAS host. See [Access TrueNAS via NetBird Networks](#access-truenas-via-netbird-networks) below for the full steps.
@@ -40,7 +41,7 @@ When you install the NetBird app, TrueNAS shows an **Edit Netbird Client** form.
**Network Configuration**
- **Host Network**: Enable **Host Network** so the NetBird container uses the TrueNAS host's network stack. Without it, the container only has its own network and cannot reach your LAN or act as a [routing peer](/manage/networks/homelab/access-home-network#choose-or-add-a-routing-peer-in-your-lan). Turn this on unless you have a specific reason to keep the peer isolated (e.g. you only need the peer in the mesh with no LAN access).
- **Host Network**: Enable **Host Network** so the NetBird container uses the TrueNAS host's network stack. Without it, the container only has its own network and cannot reach your LAN or act as a [routing peer](/manage/networks/homelab/access-home-network#choose-or-add-a-routing-peer-in-your-lan).
**Storage Configuration**
@@ -62,4 +63,15 @@ Because NetBird on TrueNAS runs inside a Docker container, you cannot connect di
- Add your **entire LAN subnet** (e.g., `192.168.1.0/24`) so you can reach TrueNAS and any other device on that subnet, or
- Add a **single resource** (e.g., `192.168.1.100/32`) if you only need access to the TrueNAS host.
After you define an [access control policy](/manage/networks/homelab/access-home-network#create-an-access-control-policy) that allows the right peers or groups to reach this network, you can access TrueNAS and other resources on that subnet through the TrueNAS routing peer.
After you define an [access control policy](/manage/networks/homelab/access-home-network#create-an-access-control-policy) that allows the right peers or groups to reach this network, you can access TrueNAS and other resources on that subnet through the TrueNAS routing peer.
## Video Walkthrough
<YouTube videoId="NkP6J3hJew4" />
Install and configure TrueNAS for home server storage, then securely access it from anywhere using NetBird. Covers ZFS pools, SMB sharing, apps, and zero-trust remote access, see our [Knowledge Hub Guide: TrueNAS Made Easy](https://netbird.io/knowledge-hub/truenas-setup-and-remote-access).
- Make sure to [star us on GitHub](https://github.com/netbirdio/netbird)
- Follow us [on X](https://x.com/netbird)
- Join our [Slack Channel](/slack-url)
- NetBird [latest release](https://github.com/netbirdio/netbird/releases) on GitHub