sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-09-08 08:01:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Align docs with the new dashboard UI (Phase 1) (#778)

Browse Source 
* bulk text edit to fit new flows

* Updated screenshots, some minor docs fix. (#782)

* Update Settings on site-to-site.mdx

* fix image names and embedded links

* Update high level dia

* general dashboard images and auto-update stucture fix

* remove temp audit file

---------

Co-authored-by: PizzaLovingNerd <cameron@stillhq.io>
This commit is contained in:
Brandon Hopkins
2026-06-10 09:24:36 -07:00
committed by GitHub
parent 6107943b50
commit 39303d1c48
92 changed files with 98 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/pages/get-started/install/mobile.mdx
View File

@@ -8,7 +8,7 @@ NetBird has an official Android application that you can download at Google Play
<p>
<a href="https://play.google.com/store/apps/details?id=io.netbird.client" target="_blank">
<img src="/docs-static/img/get-started/mobile/google-play-badge.png" alt="playstore" className="imagewrapper"/>
<img src="/docs-static/img/get-started/android/google-play-badge.png" alt="playstore" className="imagewrapper"/>
</a>
</p>
@@ -21,6 +21,6 @@ NetBird has an official iOS application that you can download from the App Store
<p>
<a href="https://apps.apple.com/de/app/netbird-p2p-vpn/id6469329339?l=en-GB" target="_blank">
<img src="/docs-static/img/get-started/mobile/app-store-badge.svg" alt="appstore" className="imagewrapper" style={{ padding: '30px' }}/>
<img src="/docs-static/img/get-started/ios/app-store-badge.svg" alt="appstore" className="imagewrapper" style={{ padding: '30px' }}/>
</a>
</p>

2
src/pages/get-started/install/raspberrypi.mdx
View File

@@ -50,6 +50,6 @@ sudo netbird up
```
This will present you with an Authentication URL. Open it in your browser, log in with your NetBird account, and approve the device. Alternatively, you can authenticate with a **setup key**. Learn more about generating setup key, learn more about that [here](https://docs.netbird.io/how-to/setup-keys-add-servers-to-network#creating-a-setup-key-in-your-net-bird-account).
This will present you with an Authentication URL. Open it in your browser, log in with your NetBird account, and approve the device. Alternatively, you can authenticate with a **setup key**. Learn more about generating setup keys [here](/manage/peers/register-machines-using-setup-keys).
Once the device is connected it should show up under the **Peers** page on the NetBird dashboard. Here we can quickly assign the Raspberry Pi a group. Within the **Groups** column click the pencil to edit and add the peer to a new group, this can be something like “RaspberryPi”.

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

@@ -20,7 +20,7 @@ The NetBird app on TrueNAS runs in a Docker container. You **cannot** use the pe
<img src="/docs-static/img/get-started/truenas/truenas-install-netbird.png" alt="Install NetBird app on TrueNAS" className="imagewrapper-big"/>
3. After installation, confirm the app is **Running** in the Apps list.
4. Open your [NetBird dashboard](https://app.netbird.io/) and go to **Peers**. You should see your TrueNAS peer listed. Rename it (e.g., "TrueNAS" or "NAS") if you like for easier identification.
4. Open your [NetBird dashboard](https://app.netbird.io/) and go to **Peers** → **Servers**. You should see your TrueNAS peer listed. Rename it (e.g., "TrueNAS" or "NAS") if you like for easier identification.
### App configuration
@@ -34,7 +34,7 @@ When you install the NetBird app, TrueNAS shows an **Edit Netbird Client** form.
- **Application name**: Display name in TrueNAS (e.g., "NetBird" or "Netbird Client"). Default is fine.
- **Timezone**: Leave default unless you need a specific timezone for logs.
- **Hostname**: Name this peer will use in NetBird (e.g., "truenas" or "nas"). Pick something you’ll recognize in the dashboard.
- **Setup Key** *(required)*: Paste the setup key you created in [Generate your Setup Key](#generate-your-setup-key). This registers the TrueNAS peer with your NetBird network.
- **Setup Key** *(required)*: Paste a setup key created under `Settings` → `Setup Keys` (see [Register machines using setup keys](/manage/peers/register-machines-using-setup-keys)). This registers the TrueNAS peer with your NetBird network.
- **Userspace**: Leave default (userspace networking). Only change if you have a specific need.
- **Management URL** *(optional)*: Leave empty for NetBird Cloud (`https://api.netbird.io`). Set this only if you use a [self-hosted](/selfhosted/selfhosted-quickstart) management server.
- **Additional Environment Variables**: Leave empty unless you need extra [environment variables](/get-started/cli#environment-variables).
@@ -57,7 +57,7 @@ You can leave **Labels** and **Additional Storage** empty unless you use them fo
Because NetBird on TrueNAS runs inside a Docker container, you cannot connect directly to the TrueNAS host or its services by IP as you would to a normal peer. To reach TrueNAS or other devices on the same LAN, use [NetBird Networks](/manage/networks/homelab/access-home-network):
1. **Create a NetBird Network**: In the dashboard, go to **Networks** → **Add Network**. Name it (e.g., "Home LAN" or "TrueNAS LAN").
1. **Create a NetBird Network**: In the dashboard, go to **Network Routing** → **Networks** → **Add Network**. Name it (e.g., "Home LAN" or "TrueNAS LAN").
2. **Add the TrueNAS peer as a routing peer**: In that network, click **Add Routing Peer** and select the TrueNAS peer. This makes TrueNAS the gateway for traffic into your local subnet.
3. **Add a network resource**: Click **Add Resource**. Either:
- 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