Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/pages/about-netbird/how-netbird-works.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ connections, tunneling, authentication, and network management (IPs, keys, ACLs,
It uses open-source technologies like [WireGuard®](https://www.wireguard.com/), [Pion ICE (WebRTC)](https://github.com/pion/ice), [Coturn](https://github.com/coturn/coturn),
and [software](https://github.com/netbirdio/netbird) developed by NetBird to make secure private networks deployment and management simple.

NetBird relies on four components - **Client** application (or agent), **Management**, **Signal** and **Relay** services.
NetBird relies on four components - **Client** application, **Management**, **Signal** and **Relay** services.

The combination of these elements ensures that direct point-to-point connections are established and only authenticated
users (or machines) have access to the resources for which they are authorized.
Expand Down Expand Up @@ -60,7 +60,7 @@ The Management service runs in the cloud NetBird-managed. It can also be self-ho

## Client Application

The NetBird Client application (or agent) is a software that is installed on the machines within a NetBird network.
The NetBird client is software installed on the machines within a NetBird network.
It is an entry point to your private network that makes it possible for machines to communicate with each other.
Once installed and registered, a machine becomes a peer within the network.

Expand Down
4 changes: 2 additions & 2 deletions src/pages/about-netbird/self-hosted-vs-cloud.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ e.g., control network access.
When running the self-hosted version, you are responsible for installing and maintaining all the components as well as backing up
and securing the data. With local user management built into the Management service, this burden is significantly reduced—you no longer need to maintain separate identity provider infrastructure.

The cloud-hosted NetBird only requires you to install the client software (NetBird agent) on your machines and log them in to the network.
The cloud-hosted NetBird only requires you to install the NetBird client on your machines and log them in to the network.
The cloud-hosted version is more suitable for organizations that want a hassle-free solution that is easy to set up and maintain.

## Features
Expand All @@ -65,7 +65,7 @@ SCIM provisioning and some enterprise features require a [Commercial License](ht
NetBird uses relay servers to establish connections between machines when a direct point-to-point connections isn't possible.

When using the cloud-hosted version, you benefit from the geo-distributed relay server clusters that are located in multiple regions
around the world ensuring that your machines can always establish a connection. The NetBird agents pick the closest relay server.
around the world ensuring that your machines can always establish a connection. The NetBird clients pick the closest relay server.

When using the self-hosted version, you need to set up your own relay servers. This a complex task and requires additional
maintenance effort.
Expand Down
4 changes: 2 additions & 2 deletions src/pages/client/desktop-app.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ export const description = "Overview of the redesigned NetBird desktop app: Defa

# NetBird Desktop App

Starting with NetBird v0.75.0, the desktop app uses a [Wails](https://wails.io/) webview with a React frontend. The management server and wire protocol are unchanged, but the UI and agent need to be updated together. If their versions do not match, the app displays an update notification.
Starting with NetBird v0.75.0, the desktop app uses a [Wails](https://wails.io/) webview with a React frontend. The management server and wire protocol are unchanged, but the UI and the daemon need to be updated together. If their versions do not match, the app displays an update notification.

## First Launch

Expand Down Expand Up @@ -38,7 +38,7 @@ Clicking a peer opens a detail panel with the information you would otherwise lo

## A Reactive UI

Changes made by the NetBird agent or the CLI are reflected in the app immediately. Connect or disconnect from the CLI and the toggle flips on its own. Switch profiles and the window catches up. There is no need to refresh or relaunch the app.
Changes made by the NetBird daemon or the CLI are reflected in the app immediately. Connect or disconnect from the CLI and the toggle flips on its own. Switch profiles and the window catches up. There is no need to refresh or relaunch the app.

## System Tray

Expand Down
2 changes: 1 addition & 1 deletion src/pages/client/mdm-integration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ NetBird's client honors policies pushed by your Mobile Device Management
(MDM) channel, so an administrator can enforce configuration across a
fleet of devices instead of touching each machine. On every supported
platform the daemon reads from the **OS-native managed-configuration
store** that your MDM already writes to. No agent of ours sits between
store** that your MDM already writes to. No extra NetBird software sits between
you and the MDM provider; whatever you can push to that store (manually,
via Group Policy, via a Configuration Profile, via your MDM console)
becomes effective NetBird policy.
Expand Down
4 changes: 2 additions & 2 deletions src/pages/client/post-quantum-cryptography.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The software is [open-source](https://github.com/rosenpass/rosenpass) and design
It ensures future-proof security against quantum threats by continuously generating and rotating WireGuard pre-shared keys every two minutes.
Rosenpass can also be used as a generic key-exchange mechanism for other protocols.

Starting [v0.25.4](https://github.com/netbirdio/netbird/releases), the NetBird agent runs an embedded Rosenpass server
Starting [v0.25.4](https://github.com/netbirdio/netbird/releases), the NetBird client runs an embedded Rosenpass server
that automatically rotates and applies WireGuard pre-shared keys to every point-to-point connection.
<Note>
NetBird uses a [Golang implementation](https://github.com/cunicu/go-rosenpass) of the Rosenpass protocol by the [cunīcu](https://cunicu.li) project.
Expand All @@ -41,7 +41,7 @@ Rosenpass respects a provided pre-shared key and uses it for its initial key gen
```bash
netbird up --enable-rosenpass --preshared-key <preshared-key>
```
This configuration is persistent and preserved by the agent during restarts.
This configuration is persistent and preserved by the client during restarts.

<Note>
If the Rosenpass feature is enabled on a peer it will only be able to communicate with other peers that have Rosenpass enabled.
Expand Down
2 changes: 1 addition & 1 deletion src/pages/get-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ A [routing peer](https://docs.netbird.io/manage/network-routes) is a NetBird pee

1. The dashboard will now prompt you to "Add a routing peer." First, click Generate Setup Key. This creates a one-time key used to enroll the gateway machine into your NetBird account.
2. Next, click Install Routing Peer. Select the operating system of your gateway machine (the video uses Linux).
3. The installation modal will provide two commands: a curl script to install the NetBird agent and a netbird up command that includes your setup key.
3. The installation modal will provide two commands: a curl script to install the NetBird client and a netbird up command that includes your setup key.
4. SSH into your gateway machine (which must be inside the 10.0.0.0/24 subnet) and run the commands:
5. SSH into your Linux server and run the commands:

Expand Down
2 changes: 1 addition & 1 deletion src/pages/get-started/install/docker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import {Note} from "@/components/mdx";

# Docker Installation

The NetBird client (agent) allows a peer to join a pre-existing NetBird deployment. If a NetBird deployment is not yet available, there are both managed and [self-hosted](https://docs.netbird.io/selfhosted/selfhosted-quickstart) options available.
The NetBird client allows a peer to join a pre-existing NetBird deployment. If a NetBird deployment is not yet available, there are both managed and [self-hosted](https://docs.netbird.io/selfhosted/selfhosted-quickstart) options available.

## Docker Run Command

Expand Down
2 changes: 1 addition & 1 deletion src/pages/get-started/install/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ If you're a new user you should visit the [Quickstart Guide](https://docs.netbir

<Button href="https://app.netbird.io/install" arrow="right" children="Download NetBird" />

The NetBird client (agent) allows a peer to join a pre-existing NetBird deployment. If a NetBird deployment is not yet available, there are both managed and [self-hosted](https://docs.netbird.io/selfhosted/selfhosted-quickstart) options available.
The NetBird client allows a peer to join a pre-existing NetBird deployment. If a NetBird deployment is not yet available, there are both managed and [self-hosted](https://docs.netbird.io/selfhosted/selfhosted-quickstart) options available.

## Install and Update Instructions
* [Install on Linux](/get-started/install/linux)
Expand Down
2 changes: 1 addition & 1 deletion src/pages/get-started/install/linux.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import {Note} from "@/components/mdx";

# Linux Installation

The NetBird client (agent) allows a peer to join a pre-existing NetBird deployment. If a NetBird deployment is not yet available, there are both managed and [self-hosted](https://docs.netbird.io/selfhosted/selfhosted-quickstart) options available.
The NetBird client allows a peer to join a pre-existing NetBird deployment. If a NetBird deployment is not yet available, there are both managed and [self-hosted](https://docs.netbird.io/selfhosted/selfhosted-quickstart) options available.

## Desktop App Dependencies

Expand Down
2 changes: 1 addition & 1 deletion src/pages/get-started/install/macos.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import {Note, Warning} from "@/components/mdx";

# MacOS Installation

The NetBird client (agent) allows a peer to join a pre-existing NetBird deployment. If a NetBird deployment is not yet available, there are both managed and [self-hosted](https://docs.netbird.io/selfhosted/selfhosted-quickstart) options available.
The NetBird client allows a peer to join a pre-existing NetBird deployment. If a NetBird deployment is not yet available, there are both managed and [self-hosted](https://docs.netbird.io/selfhosted/selfhosted-quickstart) options available.

## Install with one command

Expand Down
2 changes: 1 addition & 1 deletion src/pages/get-started/install/opnsense.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OPNsense Installation

The NetBird client (agent) allows a peer to join a pre-existing NetBird deployment. If a NetBird deployment is not yet available,
The NetBird client allows a peer to join a pre-existing NetBird deployment. If a NetBird deployment is not yet available,
there are both managed and [self-hosted](https://docs.netbird.io/selfhosted/selfhosted-quickstart) options available.


Expand Down
2 changes: 1 addition & 1 deletion src/pages/get-started/install/pfsense.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# pfSense Installation

The NetBird client (agent) allows a peer to join a pre-existing NetBird deployment. If a NetBird deployment is not yet available,
The NetBird client allows a peer to join a pre-existing NetBird deployment. If a NetBird deployment is not yet available,
there are both managed and [self-hosted](https://docs.netbird.io/selfhosted/selfhosted-quickstart) options available.

<Note>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/get-started/install/proxmox-ve.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import {Note} from "@/components/mdx";

# Install NetBird on Proxmox VE

Proxmox VE (Virtual Environment) is an open-source server virtualization platform that combines KVM-based virtualization and LXC containerization. It provides a web-based management interface for deploying and managing virtual machines and containers, making it ideal for running the NetBird agent in a containerized environment.
Proxmox VE (Virtual Environment) is an open-source server virtualization platform that combines KVM-based virtualization and LXC containerization. It provides a web-based management interface for deploying and managing virtual machines and containers, making it ideal for running the NetBird client in a containerized environment.

## Installing in an LXC

Expand Down
2 changes: 1 addition & 1 deletion src/pages/get-started/install/synology.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import {Note} from "@/components/mdx";

# Synology Installation

The NetBird client (agent) allows a peer to join a pre-existing NetBird deployment. If a NetBird deployment is not yet available, there are both managed and [self-hosted](https://docs.netbird.io/selfhosted/selfhosted-quickstart) options available.
The NetBird client allows a peer to join a pre-existing NetBird deployment. If a NetBird deployment is not yet available, there are both managed and [self-hosted](https://docs.netbird.io/selfhosted/selfhosted-quickstart) options available.

## Installation

Expand Down
2 changes: 1 addition & 1 deletion src/pages/get-started/install/windows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import {Note} from "@/components/mdx";

# Windows Installation

The NetBird client (agent) allows a peer to join a pre-existing NetBird deployment. If a NetBird deployment is not yet available, there are both managed and [self-hosted](https://docs.netbird.io/selfhosted/selfhosted-quickstart) options available.
The NetBird client allows a peer to join a pre-existing NetBird deployment. If a NetBird deployment is not yet available, there are both managed and [self-hosted](https://docs.netbird.io/selfhosted/selfhosted-quickstart) options available.

1. Download the latest Windows release:
- <Button href="https://pkgs.netbird.io/windows/x64" variant="text">EXE Installer</Button><br />
Expand Down
4 changes: 2 additions & 2 deletions src/pages/manage/access-control/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ Understanding policy directionality is essential for implementing Zero Trust acc

### Policies Between Peers

When both source and destination are peers running the NetBird agent, you have full control over directionality:
When both source and destination are peers running the NetBird client, you have full control over directionality:

**Unidirectional:** Traffic flows only from source to destination. In the NetBird UI, this appears as a single arrow (→).

Expand Down Expand Up @@ -277,7 +277,7 @@ Direction: ALWAYS Source → Destination (cannot be bidirectional)

**Why is this always unidirectional?**

Network resources don't have the NetBird agent installed. They don't know the NetBird network exists. The routing peer acts as a gateway, forwarding traffic from NetBird peers to these resources, but the resources themselves cannot initiate connections back through the NetBird network.
Network resources don't have the NetBird client installed. They don't know the NetBird network exists. The routing peer acts as a gateway, forwarding traffic from NetBird peers to these resources, but the resources themselves cannot initiate connections back through the NetBird network.

Think of it this way:

Expand Down
2 changes: 1 addition & 1 deletion src/pages/manage/activity/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ The current version of NetBird tracks a wide range of network changes that occur

</details>

Future versions will also support connection events that occur in NetBird agents (e.g., peer A connected to peer B).
Future versions will also support connection events that occur in NetBird clients (e.g., peer A connected to peer B).

<Note>
The `unknown` name or `unknown@unknown.com` email address may be displayed in the activity event store if the encryption key has been corrupted or lost. This issue is most relevant for self-hosted setups. In this case, the events returned by the API could show `unknown@unknown.com` for the email address field and `unknown` for the name field.
Expand Down
2 changes: 1 addition & 1 deletion src/pages/manage/network-routes/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ In this example, peers in `berlin-office` use `aws-nb-europe-router-az-a` to acc

Disable masquerade when you need source IP transparency or want to manage routing on your external network. The routing peer forwards packets with the original NetBird peer IP intact.

This requires configuring your external network router with a return route to your NetBird network through the routing peer. Devices without the agent can then communicate with your NetBird peers.
This requires configuring your external network router with a return route to your NetBird network through the routing peer. Devices without the client can then communicate with your NetBird peers.

<p>
<img src="/docs-static/img/manage/network-routes/concepts/netbird-network-routes-masquerading.png" alt="Routes without masquerading" className="imagewrapper-big"/>
Expand Down
14 changes: 7 additions & 7 deletions src/pages/manage/networks/how-routing-peers-work.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@ import { Tiles } from '@/components/Tiles'

# How Routing Peers Work

A routing peer is a NetBird agent that bridges your overlay network to private networks and resources that do not run the agent. This page covers what routing peers are, how traffic flows through them, the requirements they impose on the host, how high availability and access control behave, and how to harden them.
A routing peer is a NetBird peer whose client bridges your overlay network to private networks and resources that do not run the client. This page covers what routing peers are, how traffic flows through them, the requirements they impose on the host, how high availability and access control behave, and how to harden them.

## What is a routing peer

A routing peer is a NetBird peer installed inside a private network that forwards traffic between the NetBird overlay and resources that cannot or should not run the agent themselves. It is the bridge between your Zero Trust mesh and the LANs, VPCs, datacenter networks, or individual hosts you need to reach.
A routing peer is a NetBird peer installed inside a private network that forwards traffic between the NetBird overlay and resources that cannot or should not run the client themselves. It is the bridge between your Zero Trust mesh and the LANs, VPCs, datacenter networks, or individual hosts you need to reach.

A single peer can serve multiple roles at once. The same machine can be a client peer, a routing peer for one or more networks, and an exit node simultaneously.

Because routing peers are typically headless servers, register them with [setup keys](/manage/peers/register-machines-using-setup-keys) rather than interactive login.

## When to use a routing peer

- **Site or LAN access.** NetBird peers need to reach resources on a remote subnet, office network, datacenter, or cloud VPC without installing the agent on every host.
- **Site or LAN access.** NetBird peers need to reach resources on a remote subnet, office network, datacenter, or cloud VPC without installing the client on every host.
- **Domain-based access.** Traffic must be routed by FQDN or wildcard domain to services whose IPs change.
- **Exit node.** All internet-bound traffic from a group of peers must egress through a controlled location.
- **Kubernetes.** Pods or services need to be reachable from NetBird peers without putting an agent on every node.
- **Kubernetes.** Pods or services need to be reachable from NetBird peers without putting the client on every node.

## Networks vs Network Routes

Expand Down Expand Up @@ -52,11 +52,11 @@ The walkthrough below describes the **Linux kernel-mode** path, where forwarding

### Operating system

Linux, Windows, macOS, FreeBSD, Android, tvOS, and Docker peers can act as routing peers. Linux is the most common production choice because the agent runs in kernel space and integrates with native kernel firewalls (`nftables` / `iptables`). On other platforms the forwarding path runs in userspace.
Linux, Windows, macOS, FreeBSD, Android, tvOS, and Docker peers can act as routing peers. Linux is the most common production choice because it uses the kernel WireGuard data path by default and integrates with native kernel firewalls (`nftables` / `iptables`). On other platforms the forwarding path runs in userspace.

### IP forwarding

The agent enables IP forwarding automatically on Linux. If the agent cannot modify sysctl on its own, set it yourself on the host and persist it:
The client enables IP forwarding automatically on Linux. If the client cannot modify sysctl on its own, set it yourself on the host and persist it:

```bash
# Runtime
Expand Down Expand Up @@ -167,7 +167,7 @@ For the full setup — the file-server scenario, the commands, the Active Direct

### Directionality is forced for routed traffic

Policies whose destination is a network resource are always unidirectional from source to destination. The resource has no agent and cannot initiate connections back through the overlay. The bidirectional toggle is disabled in the UI for these policies.
Policies whose destination is a network resource are always unidirectional from source to destination. The resource has no client and cannot initiate connections back through the overlay. The bidirectional toggle is disabled in the UI for these policies.

### Network Routes default-allow caveat

Expand Down
Loading
Loading