From f83b1b65a437607824b67db4cc8b6501c8c0cbef Mon Sep 17 00:00:00 2001 From: Jack Carter <128555021+SunsetDrifter@users.noreply.github.com> Date: Mon, 15 Jun 2026 15:57:55 +0200 Subject: [PATCH] docs: rename Network Routes to Routes, deprecate, and relocate Browser Client Architecture (#792) * docs: rename Network Routes to Routes, deprecate, and relocate Browser Client Architecture - Rename the docs sidebar entry "Network Routes" to "Routes" and the page H1 - Add a deprecation note to the Routes page: all use cases except exit nodes have moved to Networks; reconcile the body framing accordingly - Move Browser Client Architecture under Peers > Browser Client (/manage/peers/browser-client/architecture), nest the nav, add a redirect, and update cross-links - Shrink the site-to-site Architecture diagram boxes to fit their content * docs: rename Routes nav 'Concept' link to 'Overview' --- next.config.mjs | 5 +++++ src/components/NavigationDocs.jsx | 20 ++++++++++++------- src/pages/introduction.mdx | 2 +- src/pages/manage/network-routes/index.mdx | 14 ++++++------- .../network-routes/use-cases/site-to-site.mdx | 4 ++++ .../networks/use-cases/site-to-site.mdx | 4 ++++ src/pages/manage/peers/browser-client.mdx | 2 +- .../peers/browser-client/architecture.mdx} | 0 8 files changed, 34 insertions(+), 17 deletions(-) rename src/pages/{about-netbird/browser-client-architecture.mdx => manage/peers/browser-client/architecture.mdx} (100%) diff --git a/next.config.mjs b/next.config.mjs index 8add4bb0..38a8a032 100644 --- a/next.config.mjs +++ b/next.config.mjs @@ -31,6 +31,11 @@ const nextConfig = { destination: '/manage/networks', permanent: true, }, + { + source: '/about-netbird/browser-client-architecture', + destination: '/manage/peers/browser-client/architecture', + permanent: true, + }, { source: '/manage/network-routes/use-cases/by-scenario/site-to-vpn', destination: '/manage/networks/use-cases/site-to-vpn', diff --git a/src/components/NavigationDocs.jsx b/src/components/NavigationDocs.jsx index 791b296a..4d579c0f 100644 --- a/src/components/NavigationDocs.jsx +++ b/src/components/NavigationDocs.jsx @@ -37,10 +37,6 @@ export const docsNavigation = [ title: 'Ports & Firewalls', href: '/about-netbird/ports-and-firewalls', }, - { - title: 'Browser Client Architecture', - href: '/about-netbird/browser-client-architecture', - }, { title: 'FAQ', href: '/about-netbird/faq' }, /*{ title: 'Whats new in version xx', href: '/welcome/how-netbird-works' }, { title: 'Release notes', href: '/about-netbird/netbird-vs-traditional-vpn' },*/ @@ -101,7 +97,17 @@ export const docsNavigation = [ title: 'Bootstrap via Config File', href: '/manage/peers/bootstrap-via-config-file', }, - { title: 'Browser Client', href: '/manage/peers/browser-client' }, + { + title: 'Browser Client', + isOpen: false, + links: [ + { title: 'Overview', href: '/manage/peers/browser-client' }, + { + title: 'Architecture', + href: '/manage/peers/browser-client/architecture', + }, + ], + }, { title: 'SSH', href: '/manage/peers/ssh' }, { title: 'Lazy Connections', href: '/manage/peers/lazy-connection' }, { title: 'Remote Jobs', href: '/manage/peers/remote-jobs' }, @@ -221,10 +227,10 @@ export const docsNavigation = [ ], }, { - title: 'Network Routes', + title: 'Routes', isOpen: false, links: [ - { title: 'Concept', href: '/manage/network-routes' }, + { title: 'Overview', href: '/manage/network-routes' }, { title: 'Use Cases', isOpen: false, diff --git a/src/pages/introduction.mdx b/src/pages/introduction.mdx index 4af0f1e5..65624e5a 100644 --- a/src/pages/introduction.mdx +++ b/src/pages/introduction.mdx @@ -102,7 +102,7 @@ It literally takes less than 5 minutes to deploy a secure point-to-point VPN wit 'Compare NetBird Cloud with the self-hosted version and decide which deployment fits your needs.', }, { - href: '/about-netbird/browser-client-architecture', + href: '/manage/peers/browser-client/architecture', name: 'Browser Client Architecture', description: 'Understand how the Browser Client enables secure remote access directly from web browsers using WebAssembly.', diff --git a/src/pages/manage/network-routes/index.mdx b/src/pages/manage/network-routes/index.mdx index a7771500..bd8fb927 100644 --- a/src/pages/manage/network-routes/index.mdx +++ b/src/pages/manage/network-routes/index.mdx @@ -1,9 +1,13 @@ import { Note, Warning, Button } from '@/components/mdx' import { Tiles } from '@/components/Tiles' -# Network Routes +# Routes -Network Routes let you route traffic from NetBird peers to private networks without installing the NetBird agent on every device. A routing peer forwards packets between your NetBird mesh network and your internal networks (LANs, VPCs, data centers). + +Routes are deprecated. Every use case except [exit nodes](/manage/network-routes/use-cases/exit-nodes) has moved to [Networks](/manage/networks). Use Networks for all new configurations. For a side-by-side comparison of the two models, see [How Routing Peers Work](/manage/networks/how-routing-peers-work). + + +Network Routes let you route traffic from NetBird peers to private networks without installing the NetBird client on every device. A routing peer forwards packets between your NetBird mesh network and your internal networks (LANs, VPCs, data centers).

Network Routes diagram @@ -17,12 +21,6 @@ Network Routes require NetBird [v0.9.0](https://github.com/netbirdio/netbird/rel By default, Network Routes bypass Access Control rules. Traffic flows freely to routed networks unless you [configure access control explicitly](/manage/network-routes/access-control). See [Network Routes caveats](#network-routes-caveats) for details. -## Network Routes vs Networks - -[Networks](/manage/networks) is the newer, simpler replacement for Network Routes. We recommend using Networks where possible; however, Networks do not yet support all remote access scenarios. Network Routes will continue to be maintained, so choose whichever fits your use case. - -For a detailed comparison, see our [site-to-site documentation](/use-cases/site-to-site). - ## Key Concepts ### Network Identifiers and Ranges diff --git a/src/pages/manage/network-routes/use-cases/site-to-site.mdx b/src/pages/manage/network-routes/use-cases/site-to-site.mdx index cdb7df99..bdee98c2 100644 --- a/src/pages/manage/network-routes/use-cases/site-to-site.mdx +++ b/src/pages/manage/network-routes/use-cases/site-to-site.mdx @@ -6,11 +6,15 @@ Site-to-Site connects two networks through routing peers at each end. Neither en ## Architecture +

+ ``` Site A device ──► Routing Peer ──► NetBird Tunnel ──► Routing Peer ──► Site B device (no NetBird) (peer) (peer) (no NetBird) ``` +
+ For most site-to-site setups, prefer [Networks Site-to-Site](/manage/networks/use-cases/site-to-site) — it has per-Resource access control and is the actively developed system. diff --git a/src/pages/manage/networks/use-cases/site-to-site.mdx b/src/pages/manage/networks/use-cases/site-to-site.mdx index 200bde01..88dd7b23 100644 --- a/src/pages/manage/networks/use-cases/site-to-site.mdx +++ b/src/pages/manage/networks/use-cases/site-to-site.mdx @@ -6,11 +6,15 @@ Site-to-Site connects two networks through routing peers at each end. Neither en ## Architecture +
+ ``` Site A device ──► Routing Peer ──► NetBird Tunnel ──► Routing Peer ──► Site B device (no NetBird) (peer) (peer) (no NetBird) ``` +
+ Networks is the recommended way to build site-to-site. It has per-Resource access control, is Zero Trust by default, and is the actively developed system. diff --git a/src/pages/manage/peers/browser-client.mdx b/src/pages/manage/peers/browser-client.mdx index d971ac8b..cd5203bd 100644 --- a/src/pages/manage/peers/browser-client.mdx +++ b/src/pages/manage/peers/browser-client.mdx @@ -141,7 +141,7 @@ The Browser Client maintains NetBird's security standards: ## Technical Implementation -For technical details on the Browser Client architecture, see the [Browser Client Technical Architecture](/about-netbird/browser-client-architecture) documentation. +For technical details on the Browser Client architecture, see the [Browser Client Technical Architecture](/manage/peers/browser-client/architecture) documentation. ### SSH Requirements diff --git a/src/pages/about-netbird/browser-client-architecture.mdx b/src/pages/manage/peers/browser-client/architecture.mdx similarity index 100% rename from src/pages/about-netbird/browser-client-architecture.mdx rename to src/pages/manage/peers/browser-client/architecture.mdx