Align docs with the new dashboard UI (Phase 1) (#778)
* 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>
|
Before Width: | Height: | Size: 194 KiB After Width: | Height: | Size: 238 KiB |
|
Before Width: | Height: | Size: 284 KiB After Width: | Height: | Size: 163 KiB |
|
Before Width: | Height: | Size: 486 KiB After Width: | Height: | Size: 261 KiB |
|
Before Width: | Height: | Size: 109 KiB After Width: | Height: | Size: 61 KiB |
|
Before Width: | Height: | Size: 321 KiB |
|
Before Width: | Height: | Size: 318 KiB |
|
Before Width: | Height: | Size: 333 KiB After Width: | Height: | Size: 333 KiB |
|
Before Width: | Height: | Size: 419 KiB After Width: | Height: | Size: 419 KiB |
|
Before Width: | Height: | Size: 410 KiB After Width: | Height: | Size: 410 KiB |
|
Before Width: | Height: | Size: 273 KiB After Width: | Height: | Size: 273 KiB |
|
Before Width: | Height: | Size: 348 KiB After Width: | Height: | Size: 348 KiB |
|
Before Width: | Height: | Size: 394 KiB After Width: | Height: | Size: 394 KiB |
|
Before Width: | Height: | Size: 206 KiB After Width: | Height: | Size: 206 KiB |
|
Before Width: | Height: | Size: 435 KiB After Width: | Height: | Size: 435 KiB |
|
Before Width: | Height: | Size: 459 KiB After Width: | Height: | Size: 459 KiB |
|
Before Width: | Height: | Size: 247 KiB After Width: | Height: | Size: 179 KiB |
|
Before Width: | Height: | Size: 152 KiB After Width: | Height: | Size: 92 KiB |
|
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 73 KiB |
|
Before Width: | Height: | Size: 135 KiB After Width: | Height: | Size: 127 KiB |
|
Before Width: | Height: | Size: 143 KiB After Width: | Height: | Size: 154 KiB |
|
Before Width: | Height: | Size: 96 KiB After Width: | Height: | Size: 161 KiB |
|
Before Width: | Height: | Size: 606 KiB After Width: | Height: | Size: 284 KiB |
|
Before Width: | Height: | Size: 327 KiB After Width: | Height: | Size: 179 KiB |
|
Before Width: | Height: | Size: 577 KiB After Width: | Height: | Size: 116 KiB |
|
Before Width: | Height: | Size: 179 KiB After Width: | Height: | Size: 113 KiB |
|
Before Width: | Height: | Size: 190 KiB After Width: | Height: | Size: 234 KiB |
|
Before Width: | Height: | Size: 300 KiB After Width: | Height: | Size: 280 KiB |
|
Before Width: | Height: | Size: 148 KiB After Width: | Height: | Size: 125 KiB |
|
Before Width: | Height: | Size: 226 KiB After Width: | Height: | Size: 296 KiB |
|
Before Width: | Height: | Size: 71 KiB After Width: | Height: | Size: 116 KiB |
|
Before Width: | Height: | Size: 82 KiB After Width: | Height: | Size: 97 KiB |
|
Before Width: | Height: | Size: 486 KiB After Width: | Height: | Size: 222 KiB |
|
Before Width: | Height: | Size: 224 KiB After Width: | Height: | Size: 145 KiB |
|
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 203 KiB |
BIN
public/docs-static/img/manage/peers/auto-update/dashboard.png
Normal file
|
After Width: | Height: | Size: 165 KiB |
|
Before Width: | Height: | Size: 226 KiB After Width: | Height: | Size: 296 KiB |
|
Before Width: | Height: | Size: 226 KiB After Width: | Height: | Size: 296 KiB |
|
Before Width: | Height: | Size: 74 KiB After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 433 KiB After Width: | Height: | Size: 118 KiB |
|
Before Width: | Height: | Size: 247 KiB |
|
Before Width: | Height: | Size: 333 KiB After Width: | Height: | Size: 333 KiB |
|
Before Width: | Height: | Size: 283 KiB After Width: | Height: | Size: 283 KiB |
|
Before Width: | Height: | Size: 419 KiB After Width: | Height: | Size: 419 KiB |
|
Before Width: | Height: | Size: 410 KiB After Width: | Height: | Size: 410 KiB |
|
Before Width: | Height: | Size: 273 KiB After Width: | Height: | Size: 273 KiB |
|
Before Width: | Height: | Size: 348 KiB After Width: | Height: | Size: 348 KiB |
|
Before Width: | Height: | Size: 394 KiB After Width: | Height: | Size: 394 KiB |
|
Before Width: | Height: | Size: 336 KiB After Width: | Height: | Size: 336 KiB |
|
Before Width: | Height: | Size: 341 KiB After Width: | Height: | Size: 341 KiB |
|
Before Width: | Height: | Size: 300 KiB After Width: | Height: | Size: 300 KiB |
|
Before Width: | Height: | Size: 312 KiB After Width: | Height: | Size: 312 KiB |
|
Before Width: | Height: | Size: 300 KiB After Width: | Height: | Size: 300 KiB |
|
After Width: | Height: | Size: 153 KiB |
|
Before Width: | Height: | Size: 450 KiB After Width: | Height: | Size: 450 KiB |
|
Before Width: | Height: | Size: 496 KiB After Width: | Height: | Size: 496 KiB |
|
Before Width: | Height: | Size: 206 KiB After Width: | Height: | Size: 206 KiB |
|
Before Width: | Height: | Size: 279 KiB After Width: | Height: | Size: 279 KiB |
|
Before Width: | Height: | Size: 435 KiB After Width: | Height: | Size: 435 KiB |
|
Before Width: | Height: | Size: 332 KiB After Width: | Height: | Size: 332 KiB |
|
Before Width: | Height: | Size: 459 KiB After Width: | Height: | Size: 459 KiB |
|
Before Width: | Height: | Size: 326 KiB After Width: | Height: | Size: 326 KiB |
|
Before Width: | Height: | Size: 282 KiB After Width: | Height: | Size: 282 KiB |
|
Before Width: | Height: | Size: 67 KiB After Width: | Height: | Size: 116 KiB |
|
Before Width: | Height: | Size: 90 KiB After Width: | Height: | Size: 282 KiB |
|
Before Width: | Height: | Size: 59 KiB After Width: | Height: | Size: 99 KiB |
@@ -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>
|
||||
|
||||
@@ -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”.
|
||||
@@ -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
|
||||
|
||||
@@ -38,7 +38,7 @@ To check your permissions:
|
||||
* Expand the `Manage` tab and click on `Roles and administrators` in the left menu.
|
||||
* Look for your username and verify if you're assigned any of the above roles.
|
||||
|
||||

|
||||

|
||||
|
||||
If you don't have the required permissions, contact your Azure AD administrator to grant you the appropriate role before proceeding with the NetBird integration.
|
||||
|
||||
@@ -55,7 +55,7 @@ A new wizard screen will appear, offering step-by-step instructions for creating
|
||||
|
||||
For convenience, click on [Azure Active Directory](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/Overview) (step 1). That will open the Azure dashboard. Navigate to `App registrations` in the left menu and then click `+New registration` as indicated below:
|
||||
|
||||

|
||||

|
||||
|
||||
Fill in the required information:
|
||||
|
||||
@@ -65,7 +65,7 @@ After entering all required information, click the `Register` button at the bott
|
||||
|
||||
Upon successful registration, you'll be redirected to a confirmation screen similar to the following:
|
||||
|
||||

|
||||

|
||||
|
||||
Copy and securely store the generated `Application (client) ID` and `Directory (tenant) ID` as you will need them shortly.
|
||||
|
||||
@@ -77,19 +77,19 @@ On the NetBird dashboard click the `Continue →` button. A new wizard screen wi
|
||||
|
||||
Back to Azure, in the `App registrations` screen, click on `Manage` in the left menu to expand it and then click on `API permissions`:
|
||||
|
||||

|
||||

|
||||
|
||||
Look for the `+ Add a permission` button, located near the top of the permissions list and click on it.
|
||||
|
||||

|
||||

|
||||
|
||||
A new pop-up window will appear, asking you to select an API. Click on `Microsoft Graph`.
|
||||
|
||||

|
||||

|
||||
|
||||
On the next screen, click on the `Application permissions` button, which will let you select the appropriate permissions for NetBird to function correctly with your Microsoft Intune environment.
|
||||
|
||||

|
||||

|
||||
|
||||
To assign user permissions:
|
||||
|
||||
@@ -121,11 +121,11 @@ Back to the NetBird dashboard, click the `Continue →` button. A new wizard scr
|
||||
|
||||
On Azure, click on the `Certificates & secrets` button in the left menu to open the management page. Click on `+New client secret` as shown below. Choose an expiration time that suits your security needs and click the `Add` button.
|
||||
|
||||

|
||||

|
||||
|
||||
A new client secret will be generated and displayed on the screen. Copy and securely store the `Value` field immediately, as you will needed in the next step.
|
||||
|
||||

|
||||

|
||||
|
||||
## Enter Application ID and Directory ID in NetBird
|
||||
|
||||
|
||||
@@ -56,7 +56,7 @@ which will be distributed to all peers members of the group `route-users`. In th
|
||||
which is a member of the group `route-nodes`, this way, the policy we just created goes into effect, and all peers from the group `route-users` will be able to reach
|
||||
`router-01` only if they are not in the office network, due to our posture check.
|
||||
|
||||
To get started navigate to `Network Routes` menu on the NetBird dashboard and click on **Add Route**. Fill out the fields as shown in the image below, and click `Continue`:
|
||||
To get started navigate to the `Network Routing` → `Routes` menu on the NetBird dashboard and click on **Add Route**. Fill out the fields as shown in the image below, and click `Continue`:
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/access-control/posture-checks/connecting-from-the-office/create-route-with-posturecheck.png" alt="high-level-dia" className="imagewrapper"/>
|
||||
</p>
|
||||
|
||||
@@ -95,7 +95,7 @@ To enable access to your private resources, you need to set up a network with ro
|
||||
|
||||
#### Create a Network
|
||||
|
||||
1. Navigate to **Networks** > **Networks** in the NetBird dashboard.
|
||||
1. Navigate to **Network Routing** > **Networks** in the NetBird dashboard.
|
||||
2. Click **Add Network** to start the network creation wizard.
|
||||
3. Fill out the network details:
|
||||
- **Name**: `Internal Network`
|
||||
|
||||
@@ -67,7 +67,7 @@ If your internal DNS server is on a private network (not directly reachable by p
|
||||
|
||||
**Create a Network Resource** so peers can reach the DNS server through the routing peer:
|
||||
|
||||
1. Go to **Networks** → **Add Network**
|
||||
1. Go to **Network Routing** → **Networks** → **Add Network**
|
||||
2. Add a resource with the DNS server's IP (e.g., `192.168.0.32/32`)
|
||||
3. Assign the resource to a group (e.g., "Internal DNS")
|
||||
4. Add the routing peer that can access the private network
|
||||
|
||||
@@ -629,7 +629,7 @@ While Acronis Cyber Protect Cloud handles the automated deployment of NetBird cl
|
||||
|
||||
For example, organizations using Microsoft 365 can use the [NetBird-Microsoft Entra ID integration](https://docs.netbird.io/manage/team/idp-sync/microsoft-entra-id-sync#get-started-with-net-bird-entra-id-integration) to automatically authenticate and synchronize users and groups from Entra ID to NetBird. This integration eliminates manual user provisioning by automatically syncing organizational structure, including group memberships and user access permissions. Once synchronized, users automatically inherit the corresponding Access Control Policies created in the initial configuration section (`IT Administrators` group has access to the `Windows Workstations` group), ensuring that network access permissions align with their organizational roles.
|
||||
|
||||
To confirm that your Acronis-deployed Windows (or macOS) endpoints successfully joined NetBird, navigate to the `Peers` menu in your NetBird dashboard. Successfully registered endpoints will appear in the peers list with their device names, connection status, and assigned IP addresses within your NetBird network.
|
||||
To confirm that your Acronis-deployed Windows (or macOS) endpoints successfully joined NetBird, navigate to `Peers` → `Servers` in your NetBird dashboard. Successfully registered endpoints will appear in the peers list with their device names, connection status, and assigned IP addresses within your NetBird network.
|
||||
|
||||
This verification step ensures that your automated deployment process has completed successfully and that devices are ready to enforce the access control policies configured for your organization's security requirements.
|
||||
|
||||
|
||||
@@ -140,7 +140,7 @@ If you see the NetBird policy listed, that would indicate that NetBird has been
|
||||
To further verify the integration, check that the machine has been added to your NetBird network:
|
||||
|
||||
* Log into a NetBird account with administrative privileges.
|
||||
* Go to the `Peers` section.
|
||||
* Go to `Peers` → `Servers`.
|
||||
* Look for the newly enrolled machine in the list of peers.
|
||||
|
||||
If you can see the new machine listed as a peer in NetBird, this confirms that the automated provisioning process is working correctly and the device has been successfully added to your NetBird network.
|
||||
|
||||
@@ -185,7 +185,7 @@ To verify the deployment pipeline, navigate to `DEVICES` in Kandji, select an en
|
||||
|
||||

|
||||
|
||||
You can also confirm the process in NetBird. Log in to a NetBird account with administrative privileges, navigate to the `Peers` section, and look for the new device.
|
||||
You can also confirm the process in NetBird. Log in to a NetBird account with administrative privileges, navigate to `Peers` → `Servers`, and look for the new device.
|
||||
|
||||

|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ If you assign an empty group (one containing no peers) as the access control gro
|
||||
|
||||
## Creating a Network Route with Access Control
|
||||
|
||||
To create a network route with access control groups, navigate to **Network Routes** and click **Add Route**.
|
||||
To create a network route with access control groups, navigate to **Network Routing** → **Routes** and click **Add Route**.
|
||||
|
||||
In this example, we create a route with the following settings (see [Key Concepts](/manage/network-routes#key-concepts) for field descriptions):
|
||||
|
||||
|
||||
@@ -109,7 +109,7 @@ A network route describes a network you want to connect with your NetBird peers.
|
||||
|
||||
### Creating a Network Route
|
||||
|
||||
Access the **Network Routes** tab and click **Add Route**.
|
||||
Access **Network Routing** → **Routes** and click **Add Route**.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/network-routes/concepts/netbird-network-routes-add-button.png" alt="Add route button" className="imagewrapper-big"/>
|
||||
|
||||
@@ -35,12 +35,12 @@ Two sites, A and B:
|
||||
|
||||
Create one setup key per site with an auto-assigned group for that site's routing peers.
|
||||
|
||||
1. **Setup Keys** → **Create Setup Key**
|
||||
1. **Settings** → **Setup Keys** → **Create Setup Key**
|
||||
2. For Site A: name "Site A Routing Peer", auto-assign group `site-a-routers`
|
||||
3. Repeat for Site B with group `site-b-routers`
|
||||
|
||||
<Note>
|
||||
You can also assign groups manually after the peer connects, under **Peers** → select peer → **Assigned Groups**.
|
||||
You can also assign groups manually after the peer connects, under **Peers** → **Servers** → select peer → **Assigned Groups**.
|
||||
</Note>
|
||||
|
||||
## Step 2: Install NetBird on the routing peers
|
||||
@@ -54,7 +54,7 @@ sudo netbird up --setup-key YOUR_SETUP_KEY
|
||||
|
||||
## Step 3: Create network routes
|
||||
|
||||
Add one route per site under **Network Routes** → **Add Route**:
|
||||
Add one route per site under **Network Routing** → **Routes** → **Add Route**:
|
||||
|
||||
**Site A:**
|
||||
- Network range: `10.0.0.0/24`
|
||||
|
||||
@@ -19,7 +19,7 @@ Masquerade can only be turned off on Linux routing peers.
|
||||
|
||||
## Disable masquerade on the routing peer
|
||||
|
||||
In the dashboard: **Networks** → your network → the **routing peer** row → toggle **Masquerade** off. The change takes effect within seconds; the routing peer stops SNATing forwarded traffic for this network.
|
||||
In the dashboard: **Network Routing** → **Networks** → your network → the **routing peer** row → toggle **Masquerade** off. The change takes effect within seconds; the routing peer stops SNATing forwarded traffic for this network.
|
||||
|
||||
You can also flip it through the API:
|
||||
|
||||
|
||||
@@ -30,11 +30,11 @@ If you haven't already, install NetBird on your laptop and connect:
|
||||
1. Download NetBird from [app.netbird.io/install](https://app.netbird.io/install)
|
||||
2. Run the application and click **Connect** in the system tray
|
||||
3. Complete the sign-up process in your browser
|
||||
4. Verify your device appears in the [NetBird dashboard](https://app.netbird.io/) under **Peers**
|
||||
4. Verify your device appears in the [NetBird dashboard](https://app.netbird.io/) under **Peers** → **User Devices**
|
||||
|
||||
## Step 2: Add Your Laptop to a User Group
|
||||
|
||||
1. In the **Peers** section of the dashboard, select your laptop peer
|
||||
1. In **Peers** → **User Devices**, select your laptop peer
|
||||
2. Under **Assigned Groups**, add a new group: "Home Users"
|
||||
|
||||
<p>
|
||||
@@ -59,7 +59,7 @@ Look for your local subnet, typically something like `192.168.1.0/24` or `192.16
|
||||
|
||||
## Step 4: Create a Network for Your Home LAN
|
||||
|
||||
1. Go to **Networks** in the NetBird dashboard
|
||||
1. Go to **Network Routing** → **Networks** in the NetBird dashboard
|
||||
2. Click **Add Network**
|
||||
3. Name it "Home LAN" and click **Save**
|
||||
|
||||
@@ -106,11 +106,11 @@ The routing peer forwards traffic from NetBird to your local network. Use any al
|
||||
|
||||
**Install NetBird on your routing peer:**
|
||||
|
||||
1. In the NetBird dashboard, go to **Setup Keys**
|
||||
1. In the NetBird dashboard, go to **Settings** → **Setup Keys**
|
||||
2. Create a new setup key (one-time use recommended). Add `home-lan` to **Auto-assigned groups** and click **Create Setup Key**.
|
||||
|
||||
<Note>
|
||||
You can also add groups to peers manually after setup. Go to **Peers**, select the peer, and add groups under **Assigned Groups**.
|
||||
You can also add groups to peers manually after setup. Go to **Peers** → **Servers**, select the peer, and add groups under **Assigned Groups**.
|
||||
</Note>
|
||||
|
||||
3. On your routing peer, run:
|
||||
|
||||
@@ -38,7 +38,7 @@ Look for your local subnet, typically something like `10.100.0.0/24`.
|
||||
|
||||
## Step 2: Create a Network for On-Premise Resources
|
||||
|
||||
1. Go to **Networks** in the NetBird dashboard
|
||||
1. Go to **Network Routing** → **Networks** in the NetBird dashboard
|
||||
2. Click **Add Network**
|
||||
3. Name it "On-Premise Data Center" and click **Save**
|
||||
|
||||
@@ -80,7 +80,7 @@ For more granular access, add specific database IPs instead of the entire subnet
|
||||
|
||||
The routing peer forwards traffic from NetBird to your data center network. Install NetBird on a server that can reach the database:
|
||||
|
||||
1. In the NetBird dashboard, go to **Setup Keys**
|
||||
1. In the NetBird dashboard, go to **Settings** → **Setup Keys**
|
||||
2. Create a new setup key (one-time use recommended). Add `on-prem-databases` to **Auto-assigned groups** and click **Create Setup Key**.
|
||||
|
||||
<p>
|
||||
@@ -88,7 +88,7 @@ The routing peer forwards traffic from NetBird to your data center network. Inst
|
||||
</p>
|
||||
|
||||
<Note>
|
||||
You can also add groups to peers manually after setup. Go to **Peers**, select the peer, and add groups under **Assigned Groups**.
|
||||
You can also add groups to peers manually after setup. Go to **Peers** → **Servers**, select the peer, and add groups under **Assigned Groups**.
|
||||
</Note>
|
||||
|
||||
3. On your on-premise server, run:
|
||||
@@ -105,7 +105,7 @@ sudo netbird up --setup-key YOUR_SETUP_KEY
|
||||
|
||||
Create a setup key for your cloud workloads:
|
||||
|
||||
1. In the NetBird dashboard, go to **Setup Keys**
|
||||
1. In the NetBird dashboard, go to **Settings** → **Setup Keys**
|
||||
2. Create a new setup key. Add "`cloud-workloads`" to **Auto-assigned groups** and click **Create Setup Key**.
|
||||
|
||||
**For VMs:**
|
||||
@@ -142,7 +142,7 @@ Use the [NetBird Kubernetes Operator](/manage/integrations/kubernetes) for produ
|
||||
|
||||
After deploying NetBird on your cloud workloads:
|
||||
|
||||
1. Go to **Peers** in the NetBird dashboard
|
||||
1. Go to **Peers** → **Servers** in the NetBird dashboard
|
||||
2. Verify your cloud workloads appear and are assigned to the "`cloud-workloads`" group
|
||||
3. If using a setup key with auto-assigned groups, this happens automatically
|
||||
|
||||
|
||||
@@ -34,12 +34,12 @@ Two sites, A and B:
|
||||
|
||||
Create one setup key per site with an auto-assigned group for that site's routing peers.
|
||||
|
||||
1. Go to **Setup Keys** → **Create Setup Key**
|
||||
1. Go to **Settings** → **Setup Keys** → **Create Setup Key**
|
||||
2. For Site A: name "Site A Routing Peer", auto-assign group `site-a-routers`
|
||||
3. Repeat for Site B with group `site-b-routers`
|
||||
|
||||
<Note>
|
||||
You can also assign groups manually after the peer connects, under **Peers** → select peer → **Assigned Groups**.
|
||||
You can also assign groups manually after the peer connects, under **Peers** → **Servers** → select peer → **Assigned Groups**.
|
||||
</Note>
|
||||
|
||||
## Step 2: Install NetBird on the routing peers
|
||||
@@ -57,7 +57,7 @@ Each site becomes its own Network: a Resource for that site's subnet, served by
|
||||
|
||||
**Network A:**
|
||||
|
||||
1. Go to **Networks** → **Add Network**, name it `site-a`, and click **Create Network**
|
||||
1. Go to **Network Routing** → **Networks** → **Add Network**, name it `site-a`, and click **Create Network**
|
||||
2. Inside the network, click **Add Resource**:
|
||||
- Enter a name like `site-a-subnet`
|
||||
- Enter the address `10.0.0.0/24` (a subnet, or a single host like `10.0.0.50/32`)
|
||||
|
||||
@@ -57,7 +57,7 @@ control.
|
||||
Before installing NetBird on the routing peer, create a setup key with an
|
||||
auto-assigned group so the peer lands in the right place:
|
||||
|
||||
1. Go to **Setup Keys** in the NetBird dashboard
|
||||
1. Go to **Settings** → **Setup Keys** in the NetBird dashboard
|
||||
2. Click **Create Setup Key**
|
||||
3. Configure:
|
||||
- Name: "Site Routing Peer"
|
||||
@@ -117,7 +117,7 @@ interface address) on egress from `wt0` is sufficient.
|
||||
|
||||
In the NetBird dashboard:
|
||||
|
||||
1. Go to **Networks** and click **Add Network**
|
||||
1. Go to **Network Routing** → **Networks** and click **Add Network**
|
||||
2. Name: `site-50-network`
|
||||
3. Click **Create Network**
|
||||
|
||||
|
||||
@@ -65,7 +65,7 @@ With the setup key in place, the next crucial step is creating a network route t
|
||||
|
||||
Follow these steps to configure the network route:
|
||||
|
||||
In the NetBird dashboard, navigate to the `Network Routes` section and click on `Add Route` to create a new network route.
|
||||
In the NetBird dashboard, navigate to `Network Routing` → `Routes` and click on `Add Route` to create a new network route.
|
||||
|
||||

|
||||
|
||||
|
||||
@@ -35,7 +35,7 @@ With prerequisites in place, you'll be prepared to establish an encrypted point-
|
||||
|
||||
## 1. Installing NetBird on the Remote Server
|
||||
|
||||
Login to NetBird and navigate to `Peers`. Ensure you see your local peer connected.
|
||||
Login to NetBird and navigate to `Peers` → `User Devices`. Ensure you see your local peer connected.
|
||||
|
||||

|
||||
|
||||
|
||||
@@ -128,7 +128,7 @@ Next, ensure NetBird starts automatically on boot:
|
||||
sudo systemctl enable netbird
|
||||
```
|
||||
|
||||
Finally, log into your NetBird dashboard and navigate to the `Peers` section to confirm your VM is listed and connected.
|
||||
Finally, log into your NetBird dashboard and navigate to `Peers` → `Servers` to confirm your VM is listed and connected.
|
||||
|
||||

|
||||
|
||||
@@ -172,7 +172,7 @@ Notice that the container is accessible on port `8080` of the VM. You'll use thi
|
||||
|
||||
Now that your VM is connected to the NetBird secure network, you can verify the connection using either `curl` or your web browser. Simply use the NetBird-assigned IP address or domain for the VM to access the deployed web server.
|
||||
|
||||
To locate the NetBird-assigned IP or domain, go to the `Peers` page in your NetBird dashboard and hover your cursor over the VM's name.
|
||||
To locate the NetBird-assigned IP or domain, go to `Peers` → `Servers` in your NetBird dashboard and hover your cursor over the VM's name.
|
||||
|
||||

|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@ The Automatic Updates feature allows the NetBird client to notify users when a n
|
||||
|
||||
## Enable Automatic Updates
|
||||
|
||||

|
||||

|
||||
|
||||
To enable client auto updates, navigate to [Settings » Clients](https://app.netbird.io/settings) and enable 'Automatic Updates'.
|
||||
|
||||
|
||||
@@ -84,6 +84,10 @@ Go to `Settings` → `Setup Keys` and click the `Create Setup Key` button.
|
||||
In the dialog that opens, give your new key a recognizable name, choose its type, set a usage limit, and assign auto-groups.
|
||||
The defaults are suitable for most cases. For security reasons, we recommend using one-off keys.
|
||||
|
||||
<Note>
|
||||
You can also generate a setup key while adding a peer. Go to `Peers` → `Servers` → `Add Peer` and click `Generate Key`. This is the most common path when enrolling a new server or routing peer. It creates a one-off key that expires in 24 hours with no auto-assigned groups. To control the key type, expiration, usage limit, or auto-groups, create the key from `Settings` → `Setup Keys` instead.
|
||||
</Note>
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/manage/peers/register-machines-using-setup-keys/add-setup-key.png" alt="high-level-dia" className="imagewrapper"/>
|
||||
</p>
|
||||
|
||||
@@ -28,7 +28,7 @@ Select your **Microsoft Entra ID** identity provider connector for this integrat
|
||||
|
||||
This will open a pop-up window featuring a user-friendly wizard, guiding you through the synchronization process between NetBird and Azure AD.
|
||||
|
||||

|
||||

|
||||
|
||||
## Prerequisites
|
||||
|
||||
@@ -46,7 +46,7 @@ To check your permissions:
|
||||
* Expand the `Manage` tab and click on `Roles and administrators` in the left menu.
|
||||
* Look for your username and verify if you're assigned any of the above roles.
|
||||
|
||||

|
||||

|
||||
|
||||
If you don't have the required permissions, contact your Azure AD administrator to grant you the appropriate role before proceeding with the NetBird integration.
|
||||
|
||||
@@ -61,21 +61,21 @@ A new wizard screen will appear, offering step-by-step instructions for creating
|
||||
* Redirect Type
|
||||
* Redirect URI
|
||||
|
||||

|
||||

|
||||
|
||||
For convenience, click on [Azure Active Directory](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/Overview) (step 1). That will open the Azure dashboard. Navigate to `App registrations` in the left menu and then click `+New registration` as indicated below:
|
||||
|
||||

|
||||

|
||||
|
||||
Fill in the required information:
|
||||
|
||||

|
||||

|
||||
|
||||
After entering all required information, click the `Register` button at the bottom of the form to finalize the application registration process.
|
||||
|
||||
Upon successful registration, you'll be redirected to a confirmation screen similar to the following:
|
||||
|
||||

|
||||

|
||||
|
||||
Copy and securely store the generated `Application (client) ID` and `Directory (tenant) ID` as you will need them shortly.
|
||||
|
||||
@@ -83,23 +83,23 @@ Copy and securely store the generated `Application (client) ID` and `Directory (
|
||||
|
||||
On the NetBird dashboard click the `Continue →` button. A new wizard screen will appear, this time, offering step-by-step instructions for setting up API permissions.
|
||||
|
||||

|
||||

|
||||
|
||||
Back to Azure, in the `App registrations` screen, click on `Manage` in the left menu to expand it and then click on `API permissions`:
|
||||
|
||||

|
||||

|
||||
|
||||
Look for the `+ Add a permission` button, located near the top of the permissions list and click on it.
|
||||
|
||||

|
||||

|
||||
|
||||
A new pop-up window will appear, asking you to select an API. Click on `Microsoft Graph`.
|
||||
|
||||

|
||||

|
||||
|
||||
On the next screen, click on the `Application permissions` button, which will let you select the appropriate permissions for NetBird to function correctly with your Microsoft Entra ID environment.
|
||||
|
||||

|
||||

|
||||
|
||||
To assign user permissions:
|
||||
|
||||
@@ -107,17 +107,17 @@ To assign user permissions:
|
||||
* In the search results, click on the `User` tab to expand it and view the available permissions.
|
||||
* Click on the checkbox to select and enable the `User.Read.All` permission.
|
||||
|
||||

|
||||

|
||||
|
||||
The `User.Read.All` permission allows NetBird to read the full set of profile properties, group memberships, and reports of the signed-in user and other users in your organization.
|
||||
|
||||
Next, repeat the procedure. This time, search for `Group.Read.All` and click on the checkbox to enable it as shown below:
|
||||
|
||||

|
||||

|
||||
|
||||
Once done, click the `Add permissions` button. You will see a few warnings:
|
||||
|
||||

|
||||

|
||||
|
||||
Locate the `Grant admin consent for [Your Organization Name]` button (you'll find it next to `+Add a permission` button). Click on it to grant the required permissions.
|
||||
|
||||
@@ -125,21 +125,21 @@ A confirmation dialog will appear, asking you to verify this action. Review the
|
||||
|
||||
Once finished, the status of the permissions should change to `Granted for [Your Organization Name]`. Verify that all selected permissions now show a green checkmark, indicating they've been successfully granted:
|
||||
|
||||

|
||||

|
||||
|
||||
## Create a Client Secret for Secure NetBird-Entra ID Authentication
|
||||
|
||||
Back to the NetBird dashboard, click the `Continue →` button. A new wizard screen will appear, showing instructions for generating a client secret in Entra ID.
|
||||
|
||||

|
||||

|
||||
|
||||
On Azure, click on the `Certificates & secrets` button in the left menu to open the management page. Click on `+New client secret` as shown below. Choose an expiration time that suits your security needs and click the `Add` button.
|
||||
|
||||

|
||||

|
||||
|
||||
A new client secret will be generated and displayed on the screen. Copy and securely store the `Value` field immediately, as you will needed in the next step.
|
||||
|
||||

|
||||

|
||||
|
||||
## Enter Application ID and Directory ID in NetBird
|
||||
|
||||
@@ -147,7 +147,7 @@ Paste the secret `Value` from the previous step into NetBird and click the `Cont
|
||||
|
||||
Paste the values and click the `Continue →` button.
|
||||
|
||||

|
||||

|
||||
|
||||
## Choose Groups to Synchronize from Entra ID
|
||||
At this stage, NetBird is set to synchronize all groups from your Microsoft Entra ID by default. You have two options:
|
||||
@@ -155,7 +155,7 @@ At this stage, NetBird is set to synchronize all groups from your Microsoft Entr
|
||||
* If you want to synchronize all groups, simply click the `Continue →` button.
|
||||
* To synchronize only specific groups, click the `+ Add group filter` button, which will open a new panel where you can set criteria to include or exclude groups.
|
||||
|
||||

|
||||

|
||||
|
||||
## Choose Users to Synchronize from Entra ID
|
||||
After configuring group synchronization, you'll now set up user synchronization. Similar than before, NetBird is configured to synchronize all users from your Microsoft Entra ID by default.
|
||||
@@ -167,7 +167,7 @@ After configuring group synchronization, you'll now set up user synchronization.
|
||||
You can modify these synchronization settings later if necessary.
|
||||
</Note>
|
||||
|
||||

|
||||

|
||||
|
||||
After configuring user and group synchronization, the setup wizard will finalize the process and you'll automatically return to the main Identity Provider screen.
|
||||
|
||||
@@ -186,7 +186,7 @@ These indicators confirm that:
|
||||
You can manually trigger a sync or adjust settings by clicking on the Microsoft Entra ID section in the Identity Provider screen
|
||||
</Note>
|
||||
|
||||

|
||||

|
||||
|
||||
## Verify the Integration
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ To get started, navigate to [Integrations](https://app.netbird.io/integrations)
|
||||
`Identity Provider` integration. Click the `Entra ID (Azure AD)` button. This action will trigger a pop-up window that will
|
||||
present you with a user-friendly wizard, guiding you through the synchronization process between NetBird and Azure AD.
|
||||
|
||||

|
||||

|
||||
|
||||
## Prerequisites
|
||||
|
||||
@@ -43,7 +43,7 @@ To check your permissions:
|
||||
* Expand the `Manage` tab and click on `Roles and administrators` in the left menu.
|
||||
* Look for your username and verify if you're assigned any of the above roles.
|
||||
|
||||

|
||||

|
||||
|
||||
If you don't have the required permissions, contact your Azure AD administrator to grant you the appropriate role before proceeding with the NetBird integration.
|
||||
|
||||
@@ -58,21 +58,21 @@ A new wizard screen will appear, offering step-by-step instructions for creating
|
||||
* Redirect Type
|
||||
* Redirect URI
|
||||
|
||||

|
||||

|
||||
|
||||
For convenience, click on [Azure Active Directory](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/Overview) (step 1). That will open the Azure dashboard. Navigate to `App registrations` in the left menu and then click `+New registration` as indicated below:
|
||||
|
||||

|
||||

|
||||
|
||||
Fill in the required information:
|
||||
|
||||

|
||||

|
||||
|
||||
After entering all required information, click the `Register` button at the bottom of the form to finalize the application registration process.
|
||||
|
||||
Upon successful registration, you'll be redirected to a confirmation screen similar to the following:
|
||||
|
||||

|
||||

|
||||
|
||||
Copy and securely store the generated `Application (client) ID` and `Directory (tenant) ID` as you will need them shortly.
|
||||
|
||||
@@ -80,23 +80,23 @@ Copy and securely store the generated `Application (client) ID` and `Directory (
|
||||
|
||||
On the NetBird dashboard click the `Continue →` button. A new wizard screen will appear, this time, offering step-by-step instructions for setting up API permissions.
|
||||
|
||||

|
||||

|
||||
|
||||
Back to Azure, in the `App registrations` screen, click on `Manage` in the left menu to expand it and then click on `API permissions`:
|
||||
|
||||

|
||||

|
||||
|
||||
Look for the `+ Add a permission` button, located near the top of the permissions list and click on it.
|
||||
|
||||

|
||||

|
||||
|
||||
A new pop-up window will appear, asking you to select an API. Click on `Microsoft Graph`.
|
||||
|
||||

|
||||

|
||||
|
||||
On the next screen, click on the `Application permissions` button, which will let you select the appropriate permissions for NetBird to function correctly with your Microsoft Entra ID environment.
|
||||
|
||||

|
||||

|
||||
|
||||
To assign user permissions:
|
||||
|
||||
@@ -104,17 +104,17 @@ To assign user permissions:
|
||||
* In the search results, click on the `User` tab to expand it and view the available permissions.
|
||||
* Click on the checkbox to select and enable the `User.Read.All` permission.
|
||||
|
||||

|
||||

|
||||
|
||||
The `User.Read.All` permission allows NetBird to read the full set of profile properties, group memberships, and reports of the signed-in user and other users in your organization.
|
||||
|
||||
Next, repeat the procedure. This time, search for `Group.Read.All` and click on the checkbox to enable it as shown below:
|
||||
|
||||

|
||||

|
||||
|
||||
Once done, click the `Add permissions` button. You will see a few warnings:
|
||||
|
||||

|
||||

|
||||
|
||||
Locate the `Grant admin consent for [Your Organization Name]` button (you’ll find it next to `+Add a permission` button). Click on it to grant the required permissions.
|
||||
|
||||
@@ -122,21 +122,21 @@ A confirmation dialog will appear, asking you to verify this action. Review the
|
||||
|
||||
Once finished, the status of the permissions should change to `Granted for [Your Organization Name]`. Verify that all selected permissions now show a green checkmark, indicating they've been successfully granted:
|
||||
|
||||

|
||||

|
||||
|
||||
## Create a Client Secret for Secure NetBird-Entra ID Authentication
|
||||
|
||||
Back to the NetBird dashboard, click the `Continue →` button. A new wizard screen will appear, showing instructions for generating a client secret in Entra ID.
|
||||
|
||||

|
||||

|
||||
|
||||
On Azure, click on the `Certificates & secrets` button in the left menu to open the management page. Click on `+New client secret` as shown below. Choose an expiration time that suits your security needs and click the `Add` button.
|
||||
|
||||

|
||||

|
||||
|
||||
A new client secret will be generated and displayed on the screen. Copy and securely store the `Value` field immediately, as you will needed in the next step.
|
||||
|
||||

|
||||

|
||||
|
||||
## Enter Application ID and Directory ID in NetBird
|
||||
|
||||
@@ -144,7 +144,7 @@ Paste the secret `Value` from the previous step into NetBird and click the `Cont
|
||||
|
||||
Paste the values and click the `Continue →` button.
|
||||
|
||||

|
||||

|
||||
|
||||
## Choose Groups to Synchronize from Entra ID
|
||||
At this stage, NetBird is set to synchronize all groups from your Microsoft Entra ID by default. You have two options:
|
||||
@@ -152,7 +152,7 @@ At this stage, NetBird is set to synchronize all groups from your Microsoft Entr
|
||||
* If you want to synchronize all groups, simply click the `Continue →` button.
|
||||
* To synchronize only specific groups, click the `+ Add group filter` button, which will open a new panel where you can set criteria to include or exclude groups.
|
||||
|
||||

|
||||

|
||||
|
||||
## Choose Users to Synchronize from Entra ID
|
||||
After configuring group synchronization, you'll now set up user synchronization. Similar than before, NetBird is configured to synchronize all users from your Microsoft Entra ID by default.
|
||||
@@ -164,7 +164,7 @@ After configuring group synchronization, you'll now set up user synchronization.
|
||||
You can modify these synchronization settings later if necessary.
|
||||
</Note>
|
||||
|
||||

|
||||

|
||||
|
||||
After configuring user and group synchronization, the setup wizard will finalize the process and you'll automatically return to the main Identity Provider screen.
|
||||
|
||||
@@ -183,7 +183,7 @@ These indicators confirm that:
|
||||
You can manually trigger a sync or adjust settings by clicking on the Microsoft Entra ID section in the Identity Provider screen
|
||||
</Note>
|
||||
|
||||

|
||||

|
||||
|
||||
## Verify the Integration
|
||||
|
||||
|
||||
@@ -46,7 +46,7 @@ This allows you to:
|
||||
|
||||
Clone this repository, download, and install Terraform following the guide [here](https://learn.hashicorp.com/tutorials/terraform/install-cli?in=terraform/aws-get-started).
|
||||
|
||||
Login to https://app.netbird.io and [add your machine as a peer](https://app.netbird.io/add-peer), once you are done with the steps described there, copy your [Setup key](https://app.netbird.io/setup-keys).
|
||||
Login to https://app.netbird.io and [add your machine as a peer](https://app.netbird.io/add-peer). In the install instructions that appear, click `Generate Key` to create and copy a setup key. Alternatively, create one under `Settings` → `Setup Keys`.
|
||||
|
||||
Using a text editor, edit the [variables.tf](https://github.com/wiretrustee/wiretrustee-examples/tree/master/ecs-client-daemon/variables.tf) file, and update the `wt_setup_key` variable with your setup key. Also, make sure that `ssh_public_key_path` variable is pointing to the correct public key path. If necessary, update the remaining variables according to your requirements and their descriptions.
|
||||
|
||||
@@ -102,7 +102,7 @@ One of the simplest ways of running NetBird client application is to use a pre-b
|
||||
|
||||
You would need to obtain a [setup key](/manage/peers/register-machines-using-setup-keys) to associate NetBird client with your account.
|
||||
|
||||
The setup key could be found in the NetBird Management dashboard under `Settings` → `Setup Keys` - [https://app.netbird.io/setup-keys](https://app.netbird.io/setup-keys).
|
||||
The setup key could be found in the NetBird Management dashboard under `Settings` → `Setup Keys`.
|
||||
|
||||
Set the ```NB_SETUP_KEY``` environment variable and run the command.
|
||||
|
||||
|
||||
@@ -36,7 +36,7 @@ See the screenshot below for reference:
|
||||
With your setup key created, note it down for the next steps.
|
||||
|
||||
### Step 2: Add a network route
|
||||
Navigate to Network Routes in the NetBird management dashboard and click on `Add Route`.
|
||||
Navigate to `Network Routing` → `Routes` in the NetBird management dashboard and click on `Add Route`.
|
||||
|
||||
Set your kubernetes pod range as the destination network, and select the `Peer group` option, choosing the
|
||||
"kubernetes-routers" group. This configuration allows for scaling pods as necessary within your Kubernetes cluster.
|
||||
|
||||