mirror of
https://github.com/netbirdio/docs.git
synced 2026-10-11 08:09:03 +02:00
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'
This commit is contained in:
@@ -31,6 +31,11 @@ const nextConfig = {
|
|||||||
destination: '/manage/networks',
|
destination: '/manage/networks',
|
||||||
permanent: true,
|
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',
|
source: '/manage/network-routes/use-cases/by-scenario/site-to-vpn',
|
||||||
destination: '/manage/networks/use-cases/site-to-vpn',
|
destination: '/manage/networks/use-cases/site-to-vpn',
|
||||||
|
|||||||
@@ -37,10 +37,6 @@ export const docsNavigation = [
|
|||||||
title: 'Ports & Firewalls',
|
title: 'Ports & Firewalls',
|
||||||
href: '/about-netbird/ports-and-firewalls',
|
href: '/about-netbird/ports-and-firewalls',
|
||||||
},
|
},
|
||||||
{
|
|
||||||
title: 'Browser Client Architecture',
|
|
||||||
href: '/about-netbird/browser-client-architecture',
|
|
||||||
},
|
|
||||||
{ title: 'FAQ', href: '/about-netbird/faq' },
|
{ title: 'FAQ', href: '/about-netbird/faq' },
|
||||||
/*{ title: 'Whats new in version xx', href: '/welcome/how-netbird-works' },
|
/*{ title: 'Whats new in version xx', href: '/welcome/how-netbird-works' },
|
||||||
{ title: 'Release notes', href: '/about-netbird/netbird-vs-traditional-vpn' },*/
|
{ title: 'Release notes', href: '/about-netbird/netbird-vs-traditional-vpn' },*/
|
||||||
@@ -101,7 +97,17 @@ export const docsNavigation = [
|
|||||||
title: 'Bootstrap via Config File',
|
title: 'Bootstrap via Config File',
|
||||||
href: '/manage/peers/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: 'SSH', href: '/manage/peers/ssh' },
|
||||||
{ title: 'Lazy Connections', href: '/manage/peers/lazy-connection' },
|
{ title: 'Lazy Connections', href: '/manage/peers/lazy-connection' },
|
||||||
{ title: 'Remote Jobs', href: '/manage/peers/remote-jobs' },
|
{ title: 'Remote Jobs', href: '/manage/peers/remote-jobs' },
|
||||||
@@ -221,10 +227,10 @@ export const docsNavigation = [
|
|||||||
],
|
],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
title: 'Network Routes',
|
title: 'Routes',
|
||||||
isOpen: false,
|
isOpen: false,
|
||||||
links: [
|
links: [
|
||||||
{ title: 'Concept', href: '/manage/network-routes' },
|
{ title: 'Overview', href: '/manage/network-routes' },
|
||||||
{
|
{
|
||||||
title: 'Use Cases',
|
title: 'Use Cases',
|
||||||
isOpen: false,
|
isOpen: false,
|
||||||
|
|||||||
@@ -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.',
|
'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',
|
name: 'Browser Client Architecture',
|
||||||
description:
|
description:
|
||||||
'Understand how the Browser Client enables secure remote access directly from web browsers using WebAssembly.',
|
'Understand how the Browser Client enables secure remote access directly from web browsers using WebAssembly.',
|
||||||
|
|||||||
@@ -1,9 +1,13 @@
|
|||||||
import { Note, Warning, Button } from '@/components/mdx'
|
import { Note, Warning, Button } from '@/components/mdx'
|
||||||
import { Tiles } from '@/components/Tiles'
|
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).
|
<Warning>
|
||||||
|
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).
|
||||||
|
</Warning>
|
||||||
|
|
||||||
|
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).
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<img src="/docs-static/img/manage/network-routes/concepts/netbird-network-routes.png" alt="Network Routes diagram" className="imagewrapper-big"/>
|
<img src="/docs-static/img/manage/network-routes/concepts/netbird-network-routes.png" alt="Network Routes diagram" className="imagewrapper-big"/>
|
||||||
@@ -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.
|
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.
|
||||||
</Warning>
|
</Warning>
|
||||||
|
|
||||||
## 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
|
## Key Concepts
|
||||||
|
|
||||||
### Network Identifiers and Ranges
|
### Network Identifiers and Ranges
|
||||||
|
|||||||
@@ -6,11 +6,15 @@ Site-to-Site connects two networks through routing peers at each end. Neither en
|
|||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
|
<div className="not-prose w-fit max-w-full">
|
||||||
|
|
||||||
```
|
```
|
||||||
Site A device ──► Routing Peer ──► NetBird Tunnel ──► Routing Peer ──► Site B device
|
Site A device ──► Routing Peer ──► NetBird Tunnel ──► Routing Peer ──► Site B device
|
||||||
(no NetBird) (peer) (peer) (no NetBird)
|
(no NetBird) (peer) (peer) (no NetBird)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
<Note>
|
<Note>
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
|||||||
@@ -6,11 +6,15 @@ Site-to-Site connects two networks through routing peers at each end. Neither en
|
|||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
|
<div className="not-prose w-fit max-w-full">
|
||||||
|
|
||||||
```
|
```
|
||||||
Site A device ──► Routing Peer ──► NetBird Tunnel ──► Routing Peer ──► Site B device
|
Site A device ──► Routing Peer ──► NetBird Tunnel ──► Routing Peer ──► Site B device
|
||||||
(no NetBird) (peer) (peer) (no NetBird)
|
(no NetBird) (peer) (peer) (no NetBird)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
<Note>
|
<Note>
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
|||||||
@@ -141,7 +141,7 @@ The Browser Client maintains NetBird's security standards:
|
|||||||
|
|
||||||
## Technical Implementation
|
## 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
|
### SSH Requirements
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user