From 78838af53018f33880338cf376a2ec6b9726dc0f Mon Sep 17 00:00:00 2001 From: Hammy Havoc Date: Wed, 28 May 2025 23:35:38 +0100 Subject: [PATCH] Updated docs to be more clear about to diferentiate on installing the NetBird client versus self-hosted deployment (#352) * Update NavigationDocs.jsx to be more clear about installing the NetBird client I've seen several people get very confused about setting up NetBird in terms of self-hosting when this is the first thing they see on the docs. Reminds me of the problem with 'Plex Media Server' versus 'Plex' with a lot of people installing the server on their computer instead of the client software. * Update installation.mdx * Update getting-started.mdx --- src/components/NavigationDocs.jsx | 2 +- src/pages/how-to/getting-started.mdx | 4 ++-- src/pages/how-to/installation.mdx | 2 ++ 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/src/components/NavigationDocs.jsx b/src/components/NavigationDocs.jsx index b2787fb5..535063b6 100644 --- a/src/components/NavigationDocs.jsx +++ b/src/components/NavigationDocs.jsx @@ -30,7 +30,7 @@ export const docsNavigation = [ title: 'GET STARTED', links: [ { title: 'Quickstart Guide', href: '/how-to/getting-started' }, - {title: 'Install NetBird', href: '/how-to/installation' }, + {title: 'Install NetBird (Client)', href: '/how-to/installation' }, { title: 'CLI', href: '/how-to/cli' }, /* { title: 'Update NetBird', href: '/how-to/enforce-periodic-user-authentication' },*/ diff --git a/src/pages/how-to/getting-started.mdx b/src/pages/how-to/getting-started.mdx index e5777430..57cb3002 100644 --- a/src/pages/how-to/getting-started.mdx +++ b/src/pages/how-to/getting-started.mdx @@ -11,9 +11,9 @@ export const title = 'Getting Started' This guide describes how to quickly get started with NetBird and create a secure private network with two connected machines. For this tutorial we will use a Macbook and an EC2 node running Linux on AWS. -## Install NetBird +## Install NetBird client -NetBird works on almost any platform including Windows, macOS, Linux, iOS, Android, Docker, routers, and even serverless environments. +The NetBird client works on almost any platform, including Windows, macOS, Linux, iOS, Android, Docker, routers, and even serverless environments. To get started, install NetBird on your laptop by following the instructions on the [installation page](https://app.netbird.io/install):

diff --git a/src/pages/how-to/installation.mdx b/src/pages/how-to/installation.mdx index 51977094..39a9ae34 100644 --- a/src/pages/how-to/installation.mdx +++ b/src/pages/how-to/installation.mdx @@ -4,6 +4,8 @@ export const title = 'Installation' ## 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. + ### Linux **Install with one command**