From 3bac72719b5753131d97f31c33d3b4e49ae7472f Mon Sep 17 00:00:00 2001 From: Misha Bragin Date: Tue, 26 May 2026 10:35:24 +0200 Subject: [PATCH] Align docs with the simplified layout changes (#766) --- src/pages/get-started/install/proxmox-ve.mdx | 2 +- src/pages/get-started/install/synology.mdx | 2 +- src/pages/manage/network-routes/use-cases/exit-nodes.mdx | 4 ++-- ...cess-internal-resources-from-autoscaled-environments.mdx | 2 +- .../peer-approval-for-remote-worker-access.mdx | 2 +- .../secure-remote-webserver-access.mdx | 6 +++--- .../setup-keys-add-servers-to-network.mdx | 2 +- src/pages/manage/peers/add-machines-to-your-network.mdx | 4 ++-- src/pages/manage/peers/approve-peers.mdx | 2 +- src/pages/manage/peers/browser-client.mdx | 2 +- .../manage/peers/register-machines-using-setup-keys.mdx | 6 +++--- .../settings/enforce-periodic-user-authentication.mdx | 2 +- src/pages/use-cases/cloud/aws-ecs-terraform.mdx | 2 +- src/pages/use-cases/cloud/routing-peers-and-kubernetes.mdx | 2 +- 14 files changed, 20 insertions(+), 20 deletions(-) diff --git a/src/pages/get-started/install/proxmox-ve.mdx b/src/pages/get-started/install/proxmox-ve.mdx index d20a1dae..bd6140e3 100644 --- a/src/pages/get-started/install/proxmox-ve.mdx +++ b/src/pages/get-started/install/proxmox-ve.mdx @@ -80,7 +80,7 @@ ls /dev/net Before we install NetBird, we are going to want to generate a one-off setup key to use with our LXC installation. While [NetBird's documentation offers comprehensive guidance on this process](https://docs.netbird.io/manage/peers/register-machines-using-setup-keys), let's quickly review the essential steps: - Access your [NetBird dashboard](https://app.netbird.io/) -- Navigate to the `Setup Keys` section +- Navigate to `Peers` → `Setup Keys` - Click the `Create Setup Key` button on the right - Name your key (e.g., "ProxmoxLXC") - Set an expiration date (recommended for enhanced security) diff --git a/src/pages/get-started/install/synology.mdx b/src/pages/get-started/install/synology.mdx index e9483f74..8f3ae81e 100644 --- a/src/pages/get-started/install/synology.mdx +++ b/src/pages/get-started/install/synology.mdx @@ -116,7 +116,7 @@ rm -rf /var/lib/netbird 4. Remove the Peer from the NetBird UI. -For a complete cleanup, you should also remove the Synology NAS as a peer from your NetBird account. Log in to the NetBird web UI. Navigate to the Peers section. Find the peer corresponding to your Synology NAS and delete it. +For a complete cleanup, you should also remove the Synology NAS as a peer from your NetBird account. Log in to the NetBird web UI and navigate to `Peers` → `Servers`. Find the peer corresponding to your Synology NAS and delete it. ## Video Walkthrough diff --git a/src/pages/manage/network-routes/use-cases/exit-nodes.mdx b/src/pages/manage/network-routes/use-cases/exit-nodes.mdx index 4fc0933e..56d66042 100644 --- a/src/pages/manage/network-routes/use-cases/exit-nodes.mdx +++ b/src/pages/manage/network-routes/use-cases/exit-nodes.mdx @@ -53,9 +53,9 @@ Clients running v0.55.0 or later auto-apply these routes unless the user has exp ## Configuration Steps -### 1. Open the Peers Tab +### 1. Open the Servers list -Navigate to the NetBird dashboard and select the **Peers** tab. +Navigate to the NetBird dashboard and open **Peers** → **Servers** (exit nodes are typically unattended machines like a VPS, router, or always-on host).

Dashboard peers view diff --git a/src/pages/manage/peers/access-infrastructure/access-internal-resources-from-autoscaled-environments.mdx b/src/pages/manage/peers/access-infrastructure/access-internal-resources-from-autoscaled-environments.mdx index 1d0f4382..16cbdb6d 100644 --- a/src/pages/manage/peers/access-infrastructure/access-internal-resources-from-autoscaled-environments.mdx +++ b/src/pages/manage/peers/access-infrastructure/access-internal-resources-from-autoscaled-environments.mdx @@ -45,7 +45,7 @@ The first step in this process is [creating a NetBird setup key](/manage/peers/r To create an appropriate setup key for this use case: 1. Log in to your NetBird dashboard. -2. Navigate to the `Setup Keys` section. +2. Navigate to `Peers` → `Setup Keys`. 3. Click on `Add Setup Key` to create a new key. 4. Provide a descriptive name for your key. 5. Enable the `Reusable` option to allow multiple pods to use the same key. diff --git a/src/pages/manage/peers/access-infrastructure/peer-approval-for-remote-worker-access.mdx b/src/pages/manage/peers/access-infrastructure/peer-approval-for-remote-worker-access.mdx index 0951ca09..ee5bcde1 100644 --- a/src/pages/manage/peers/access-infrastructure/peer-approval-for-remote-worker-access.mdx +++ b/src/pages/manage/peers/access-infrastructure/peer-approval-for-remote-worker-access.mdx @@ -109,7 +109,7 @@ Back to your primary account, you'll notice the newly added user's status is now However, your approval is required before the user's device can fully connect to the NetBird network. To grant network access: -* Navigate to the `Peers` dashboard +* Navigate to `Peers` → `User Devices` * Locate the newly added device * Click the `Approve` button next to the device * Confirm the action when prompted diff --git a/src/pages/manage/peers/access-infrastructure/secure-remote-webserver-access.mdx b/src/pages/manage/peers/access-infrastructure/secure-remote-webserver-access.mdx index 1a7bbecd..e3b8be28 100644 --- a/src/pages/manage/peers/access-infrastructure/secure-remote-webserver-access.mdx +++ b/src/pages/manage/peers/access-infrastructure/secure-remote-webserver-access.mdx @@ -41,7 +41,7 @@ Login to NetBird and navigate to `Peers`. Ensure you see your local peer connect To add your remote web server to NetBird's peer network, first you need to generate a setup key: -* Navigate to `Setup Keys` in the left menu +* Navigate to `Peers` → `Setup Keys` in the left menu * Click `Create Setup Key` * Configure the key by assigning it a descriptive name (e.g., "Remote Web Server"), setting an expiration date, and defining auto-assigned groups (if required). Read the documentation for [detailed setup key configuration](/manage/peers/register-machines-using-setup-keys). * Copy the generated key to a secure location as you'll need it shortly @@ -96,7 +96,7 @@ Routes: - Peers count: 0/0 Connected ``` -Now, go back to NetBird's `Peers` dashboard and ensure your remote web server is connected. +Now, go back to NetBird's `Peers` → `Servers` view and ensure your remote web server is connected. ![NetBird Peers Network](/docs-static/img/manage/peers/access-infrastructure/secure-remote-webserver-access/8I1WVEx.png) @@ -122,7 +122,7 @@ This policy restricts SSH access to the `Testing Environment`, permitting only a After establishing the policy, assign peers to their respective groups. To add the remote web server to the `Testing Environment` group: -* Navigate to `Peers` in the left menu +* Navigate to `Peers` → `Servers` in the left menu * Click on the name of the peer you want to edit, in this case, `webserver` * Find the `Assigned Groups` field and select `Testing Environment` from the dropdown list. diff --git a/src/pages/manage/peers/access-infrastructure/setup-keys-add-servers-to-network.mdx b/src/pages/manage/peers/access-infrastructure/setup-keys-add-servers-to-network.mdx index 245c0e2d..5ad8b175 100644 --- a/src/pages/manage/peers/access-infrastructure/setup-keys-add-servers-to-network.mdx +++ b/src/pages/manage/peers/access-infrastructure/setup-keys-add-servers-to-network.mdx @@ -41,7 +41,7 @@ This process will demonstrate how Setup Keys simplify and secure the addition of To seamlessly integrate virtual machines or Docker containers into your NetBird network, you'll start by creating a setup key. While [NetBird's documentation offers comprehensive guidance on this process](https://docs.netbird.io/manage/peers/register-machines-using-setup-keys), let's quickly review the essential steps: * Access your NetBird dashboard -* Navigate to the `Setup Keys` section +* Navigate to `Peers` → `Setup Keys` * Click the `Create Setup Key` button on the right * Name your key (e.g., "VM-Docker-Demo") * Set an expiration date (recommended for enhanced security) diff --git a/src/pages/manage/peers/add-machines-to-your-network.mdx b/src/pages/manage/peers/add-machines-to-your-network.mdx index b61735b3..96b52b30 100644 --- a/src/pages/manage/peers/add-machines-to-your-network.mdx +++ b/src/pages/manage/peers/add-machines-to-your-network.mdx @@ -15,7 +15,7 @@ For details on adding machines to your network, part of our "Getting started wit ## Use NetBird web UI to add new peers To add a new peer to your network follow these steps: -1. Sign-in to your NetBird account at https://app.netbird.io/ and go to the Peers tab. +1. Sign-in to your NetBird account at https://app.netbird.io/ and go to `Peers` → `User Devices` (or `Peers` → `Servers` for unattended machines like VMs and containers). 2. Hit `Add Peer` button

@@ -28,7 +28,7 @@ To add a new peer to your network follow these steps: high-level-dia

-4. Refresh the Peers tab, and it will display new machines +4. Refresh the Peers view, and it will display new machines

high-level-dia diff --git a/src/pages/manage/peers/approve-peers.mdx b/src/pages/manage/peers/approve-peers.mdx index 3b86e662..01fce2e8 100644 --- a/src/pages/manage/peers/approve-peers.mdx +++ b/src/pages/manage/peers/approve-peers.mdx @@ -28,7 +28,7 @@ To enable peer approval, navigate to [Settings » Authentication](https://a ## Approve peer -To approve a peer, navigate to the [peers tab](https://app.netbird.io/peers) and click the `Approve` button on the right side of the peers table. +To approve a peer, navigate to the [Peers section](https://app.netbird.io/peers) (pending peers appear under both `User Devices` and `Servers`) and click the `Approve` button on the right side of the peers table.

peer-needs-approval diff --git a/src/pages/manage/peers/browser-client.mdx b/src/pages/manage/peers/browser-client.mdx index a497699d..d971ac8b 100644 --- a/src/pages/manage/peers/browser-client.mdx +++ b/src/pages/manage/peers/browser-client.mdx @@ -31,7 +31,7 @@ Before using the Browser Client, ensure: The easiest way to connect is directly from the Peers dashboard: -1. Navigate to the **Peers** section in your NetBird dashboard +1. Navigate to **Peers** → **Servers** in your NetBird dashboard (SSH and RDP targets are typically servers) 2. Find the peer you want to access 3. In the **Remote Access** section, click the **SSH** or **RDP** button diff --git a/src/pages/manage/peers/register-machines-using-setup-keys.mdx b/src/pages/manage/peers/register-machines-using-setup-keys.mdx index 8bce52e9..1a0639d1 100644 --- a/src/pages/manage/peers/register-machines-using-setup-keys.mdx +++ b/src/pages/manage/peers/register-machines-using-setup-keys.mdx @@ -30,7 +30,7 @@ This is useful when you want to add containers or auto scaling instances to your ## Using setup keys -Setup keys are available in the NetBird Management Dashboard under the `Setup Keys` tab [https://app.netbird.io/setup-keys](https://app.netbird.io/setup-keys). +Setup keys are available in the NetBird Management Dashboard under `Peers` → `Setup Keys` [https://app.netbird.io/setup-keys](https://app.netbird.io/setup-keys). You can easily add new or revoke keys.

@@ -70,7 +70,7 @@ Starting NetBird [v0.9.2](https://github.com/netbirdio/netbird/releases), when c it is possible to specify a list of auto-assign groups. Every peer registered with this key will be automatically added to these groups. All the access control rules enabled for these groups will apply automatically. -To add `Auto-assign groups`, open the `Setup Keys` tab and create or update any existing setup key. +To add `Auto-assign groups`, open `Peers` → `Setup Keys` and create or update any existing setup key. Then use this key to enroll new machine.

@@ -83,7 +83,7 @@ Then use this key to enroll new machine. ## Create setup key -Go to the `Setup Keys` tab and click the `Create Setup Key` button +Go to `Peers` → `Setup Keys` and click the `Create Setup Key` button In the opened popup, give your new key an easily identifiable name, choose type, set usage limit, and assign auto groups. The defaults should be suitable for most of the cases. We recommend using one-off keys for security reasons. diff --git a/src/pages/manage/settings/enforce-periodic-user-authentication.mdx b/src/pages/manage/settings/enforce-periodic-user-authentication.mdx index 3de6385a..ffa922cd 100644 --- a/src/pages/manage/settings/enforce-periodic-user-authentication.mdx +++ b/src/pages/manage/settings/enforce-periodic-user-authentication.mdx @@ -32,7 +32,7 @@ You can also disable the expiration for the whole network in the same section. ## Disable expiration individually per peer Sometimes, you might want to disable peer expiration for some peers. With NetBird you can disable login expiration per peer without disabling expiration globally. -In the Peers tab of the web UI click on the peer you want to disable expiration for and use the Login Expiration switch. +In `Peers` → `User Devices` click on the peer you want to disable expiration for and use the Login Expiration switch. (Session expiration only applies to peers with a user behind them; peers enrolled with a setup key under `Servers` are already exempt.) Peers with `Expiration disabled` will be marked with a corresponding label in the Peers table.

diff --git a/src/pages/use-cases/cloud/aws-ecs-terraform.mdx b/src/pages/use-cases/cloud/aws-ecs-terraform.mdx index 70c89628..793665fb 100644 --- a/src/pages/use-cases/cloud/aws-ecs-terraform.mdx +++ b/src/pages/use-cases/cloud/aws-ecs-terraform.mdx @@ -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 the Setup Keys tab - [https://app.netbird.io/setup-keys](https://app.netbird.io/setup-keys). +The setup key could be found in the NetBird Management dashboard under `Peers` → `Setup Keys` - [https://app.netbird.io/setup-keys](https://app.netbird.io/setup-keys). Set the ```NB_SETUP_KEY``` environment variable and run the command. diff --git a/src/pages/use-cases/cloud/routing-peers-and-kubernetes.mdx b/src/pages/use-cases/cloud/routing-peers-and-kubernetes.mdx index 597471d4..e5342e07 100644 --- a/src/pages/use-cases/cloud/routing-peers-and-kubernetes.mdx +++ b/src/pages/use-cases/cloud/routing-peers-and-kubernetes.mdx @@ -20,7 +20,7 @@ from hosts running on a Hetzner without exposing them to the public internet. ## Step-by-Step guide ### Step 1: Create a setup key -Navigate to Setup Keys in the NetBird management dashboard and click on "Create setup key". +Navigate to `Peers` → `Setup Keys` in the NetBird management dashboard and click on "Create setup key". Choose a name, e.g. `Kubernetes routing peers`, mark the key as `reusable` and enable `Ephemeral peers`. This option is ideal for stateless workloads like containers, where peers that are offline for over 10 minutes are automatically removed.