mirror of
https://github.com/netbirdio/docs.git
synced 2026-05-01 23:06:37 +00:00
General Docs Improvements (#542)
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
import {Note} from "@/components/mdx";
|
||||
|
||||
export const title = 'FAQ'
|
||||
# FAQ
|
||||
|
||||
## What firewall ports should I open to use NetBird (Network Firewalls)?
|
||||
|
||||
|
||||
@@ -1,10 +1,7 @@
|
||||
import {Note} from "@/components/mdx";
|
||||
|
||||
export const title = 'How NetBird Works'
|
||||
# How NetBird Works
|
||||
|
||||
## Architecture
|
||||
|
||||
### Overview
|
||||
NetBird is an open source platform consisting of a collection of components, responsible for handling peer-to-peer
|
||||
connections, tunneling, authentication, and network management (IPs, keys, ACLs, etc).
|
||||
|
||||
@@ -35,7 +32,7 @@ In this case, [groups and access controls](/manage/access-control/manage-network
|
||||
|
||||
Let's now take a closer look at each of NetBird's components.
|
||||
|
||||
### Management Service
|
||||
## Management Service
|
||||
|
||||
The Management service is the central coordination component for NetBird with a UI dashboard.
|
||||
It keeps the network state, public WireGuard keys of the peers, authenticates and distributes network changes to peers.
|
||||
@@ -61,7 +58,7 @@ The Management service runs in the cloud NetBird-managed. It can also be self-ho
|
||||
<img src="/docs-static/img/about-netbird/management.png" alt="management-dia" className="imagewrapper-big"/>
|
||||
</p>
|
||||
|
||||
### Client Application
|
||||
## Client Application
|
||||
|
||||
The NetBird Client application (or agent) is a software that is installed on the machines within a NetBird network.
|
||||
It is an entry point to your private network that makes it possible for machines to communicate with each other.
|
||||
@@ -88,7 +85,7 @@ The client also applies other DNS settings that are received from the Management
|
||||
The **private key**, generated by the NetBird client, **never leaves the machine**, ensuring that only the machine that owns the key can decrypt traffic addressed to it.
|
||||
</Note>
|
||||
|
||||
### Signal Service
|
||||
## Signal Service
|
||||
|
||||
The Signal Service, or simply Signal, is a lightweight piece of software that helps peers to negotiate direct connections.
|
||||
It does not store any data and no traffic passes through it.
|
||||
@@ -109,7 +106,7 @@ This is done through Signal. After a connection has been established, Signal ste
|
||||
NetBird Signal is very similar to the signaling servers used in [WebRTC](https://developer.mozilla.org/en-US/Web/API/WebRTC_API/Signaling_and_video_calling#the_signaling_server).
|
||||
It runs in the cloud NetBird-managed and can be self-hosted.
|
||||
|
||||
### Relay Service
|
||||
## Relay Service
|
||||
|
||||
The Relay service is a [TURN server](https://webrtc.org/getting-started/turn-server) in WebRTC terminology.
|
||||
In fact, we use an open-source implementation called [Coturn](https://github.com/coturn/coturn).
|
||||
|
||||
Reference in New Issue
Block a user