How netbirdio/netbird works
NetBird is a cross-platform WireGuard overlay-network agent paired with a centralized management and access-control platform. A user starts or configures the client through its CLI or platform SDK; the daemon authenticates and receives network configuration, then brings up the encrypted tunnel, discovers peers, and applies routes, DNS, and firewall policy. The README also documents relay fallback, SSH, and reverse-proxy capabilities. The tree and sampled excerpts support the client-side architecture; management, signal, and relay interactions are based on README documentation, not inspected server source.
Main entry points: engine.go Client engine · conn.go Peer negotiation · service_controller.go Daemon service · root.go CLI commands
Components 21
Client entry points
- CLI commands
client/cmd/root.go - Platform SDKs
client/mobile/profile_manager.go - Daemon service
client/cmd/service_controller.go
Control and configuration
- Client engine
client/internal/engine.go - Authentication
client/internal/auth/auth.go - Profile management
client/internal/profilemanager/profilemanager.go - Local state
client/internal/state.go
Peer connectivity
- WireGuard interface
client/iface/device/interface.go - Peer negotiation
client/internal/peer/conn.go - ICE discovery
client/internal/peer/ice/agent.go
Network policy
- Access policies
client/internal/acl/manager.go - Host firewall
client/firewall/manager/firewall.go - Route manager
client/internal/routemanager/manager.go - Private DNS
client/internal/dns/server.go
Access features
- Policy-based SSH
client/internal/engine_ssh.go - Reverse proxy
client/internal/expose/manager.go - Port forwarding
client/internal/portforward/manager.go
Other components
- User
- Management service
management - Signal service
signal - Relay service
relay
Connections 24
- User → CLI commands: runs commands
- User → Platform SDKs: uses app
- CLI commands → Daemon service: controls daemon
- Platform SDKs → Daemon service: controls daemon
- Daemon service → Client engine: hosts engine
- Client engine → Authentication: authenticates
- Authentication → Management service: requests identity
- Client engine → Management service: syncs configuration
- Client engine → Profile management: manages profiles
- Profile management → Local state: persists settings
- Client engine → Local state: stores state
- Client engine → Access policies: applies policy
- Access policies → Host firewall: installs rules
- Client engine → Route manager: configures routes
- Client engine → Private DNS: configures DNS
- Client engine → WireGuard interface: configures tunnel
- Client engine → Peer negotiation: manages peers
- Peer negotiation → ICE discovery: discovers candidates
- Peer negotiation → Signal service: negotiates peers
- ICE discovery → WireGuard interface: establishes direct path
- Peer negotiation → Relay service: relays fallback traffic
- Client engine → Policy-based SSH: manages SSH
- Client engine → Reverse proxy: manages proxy
- Client engine → Port forwarding: manages forwarding