sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-05-01 14:56:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Final Doc Restructure (#497)

Browse Source
This commit is contained in:
Brandon Hopkins
2025-11-27 09:50:03 -08:00
committed by GitHub
parent 846cae1fb0
commit e45bb7ce11
372 changed files with 353 additions and 536 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/pages/about-netbird/how-netbird-works.mdx
View File

@@ -20,14 +20,14 @@ A **Peer** is a machine or any device that is connected to the network.
It can be a Linux server running in the cloud or on-premises, a personal laptop, mobile phone, or even a Raspberry Pi.
<p>
<img src="/docs-static/img/architecture/high-level-dia.png" alt="high-level-dia" className="imagewrapper-big"/>
<img src="/docs-static/img/about-netbird/high-level-dia.png" alt="high-level-dia" className="imagewrapper-big"/>
</p>
With NetBird clients installed and authorized on the Management service, machines form a mesh network connecting
to each other directly via an encrypted point-to-point WireGuard tunnel.
<p>
<img src="/docs-static/img/architecture/mesh.png" alt="high-level-dia" className="imagewrapper"/>
<img src="/docs-static/img/about-netbird/mesh.png" alt="high-level-dia" className="imagewrapper"/>
</p>
While it is possible to create a full mesh network, it might be not a desirable outcome.
@@ -58,7 +58,7 @@ After that, they are able to establish a connection to the new peer.
The Management service runs in the cloud NetBird-managed. It can also be self-hosted.
<p>
<img src="/docs-static/img/architecture/management.png" alt="management-dia" className="imagewrapper-big"/>
<img src="/docs-static/img/about-netbird/management.png" alt="management-dia" className="imagewrapper-big"/>
</p>
### Client Application
@@ -99,7 +99,7 @@ peers need to find each other and exchange the most suitable connection candidat
This is done through Signal. After a connection has been established, Signal steps out.
<p>
<img src="/docs-static/img/architecture/signal.png" alt="signal-dia" className="imagewrapper-big"/>
<img src="/docs-static/img/about-netbird/signal.png" alt="signal-dia" className="imagewrapper-big"/>
</p>
<Note>
@@ -115,7 +115,7 @@ The Relay service is a [TURN server](https://webrtc.org/getting-started/turn-ser
In fact, we use an open-source implementation called [Coturn](https://github.com/coturn/coturn).
The purpose of the Relay service is to gracefully implement a "Plan B" by relaying traffic between peers when a direct point-to-point connection is not possible. However, starting with v0.29.0, a new WebSocket-based relay has been introduced with the intent of replacing the previous TURN relay (Coturn). [More info](https://netbird.io/knowledge-hub/september-newsletter).
<p>
<img src="/docs-static/img/architecture/relay.png" alt="relay-dia" className="imagewrapper-big"/>
<img src="/docs-static/img/about-netbird/relay.png" alt="relay-dia" className="imagewrapper-big"/>
</p>
<Note>