mirror of
https://github.com/netbirdio/docs.git
synced 2026-09-19 21:39:04 +02:00
docs: standardize on "NetBird client" over "agent" for the client software (#940)
* docs: standardize on "NetBird client" over "agent" for the client software * docs: address review feedback - fix "a software" grammar and use lowercase "NetBird client" - define routing peer as a peer whose client bridges, keeping peer and client distinct - correct kernel-space claim: the kernel WireGuard data path is what runs in the kernel - clarify which address the application uses to reach the SOCKS5 proxy from a separate container
This commit is contained in:
Jack Carter
@@ -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:
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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 />
|
||||
|
||||
Reference in New Issue
Block a user