netbird README

The project's README from github.com/netbirdio/netbird. As one markdown file: README.md.

NetBird logo

SonarCloud alert status BSD-3 License NetBird Slack Community forum Gurubase: Ask NetBird Guru

Start using NetBird at netbird.io
See Documentation
Join our Slack channel or our Community forum


🚀 We are hiring! Join us at https://netbird.io/careers

🤖 NetBird Agent Network (Beta)

Identity-aware access control for AI agents — keyless access to LLM APIs and private resources over the encrypted NetBird tunnel. See agent-network/ or read the docs at netbird.ai.

NetBird combines a configuration-free peer-to-peer private network and a centralized access control system in a single platform, making it easy to create secure private networks for your organization or home.

Connect. NetBird creates a WireGuard-based overlay network that automatically connects your machines over an encrypted tunnel, leaving behind the hassle of opening ports, complex firewall rules, VPN gateways, and so forth.

Secure. NetBird enables secure remote access by applying granular access policies while allowing you to manage them intuitively from a single place. Works universally on any infrastructure.

https://github.com/user-attachments/assets/10cec749-bb56-4ab3-97af-4e38850108d2

Self-host NetBird (video)

Watch the video

Key features

Connectivity Management Security Automation Platforms
✓ Kernel WireGuard ✓ Admin Web UI ✓ SSO & MFA support ✓ Public API ✓ Linux
✓ Peer-to-peer connections ✓ Auto peer discovery and configuration ✓ Access control: groups & rules ✓ Setup keys for bulk provisioning ✓ macOS
✓ Connection relay fallback ✓ IdP integrations ✓ Activity logging ✓ Self-hosting quickstart script ✓ Windows
✓ Routes to external networks ✓ Private DNS ✓ Traffic events ✓ IdP groups sync with JWT ✓ Android
✓ Domain-based DNS routes ✓ Custom DNS zones ✓ Device posture checks ✓ Terraform provider ✓ Android TV
✓ Exit nodes ✓ Multiuser support ✓ Peer-to-peer encryption ✓ Ansible collection ✓ iOS
✓ IPv6 dual-stack overlay ✓ Multi-account profile switching ✓ SSH with central access policies ✓ Apple TV
✓ Browser SSH & RDP ✓ Quantum-resistance with Rosenpass ✓ FreeBSD
✓ Reverse proxy with auto-TLS ✓ Periodic re-authentication ✓ pfSense
✓ OPNsense
✓ MikroTik RouterOS
✓ OpenWRT
✓ Synology
✓ TrueNAS
✓ Proxmox
✓ Raspberry Pi
✓ Serverless
✓ Container

Quickstart with NetBird Cloud

Quickstart with self-hosted NetBird

This is the quickest way to try self-hosted NetBird. It should take around 5 minutes to get started if you already have a public domain and a VM. Follow the Advanced guide with a custom identity provider for installations with different IdPs.

Infrastructure requirements:

Software requirements:

Steps

export NETBIRD_DOMAIN=netbird.example.com; curl -fsSL https://github.com/netbirdio/netbird/releases/latest/download/getting-started.sh | bash

A bit on NetBird internals

NetBird high-level architecture diagram

See a complete architecture overview for details.

Community projects

Note: The main branch may be in an unstable or even broken state during development. For stable versions, see releases.

Support acknowledgement

In November 2022, NetBird joined the StartUpSecure program sponsored by the Federal Ministry of Education and Research of the Federal Republic of Germany. Together with the CISPA Helmholtz Center for Information Security, NetBird brings security best practices and simplicity to private networking.

CISPA_Logo_BLACK_EN_RZ_RGB (1)

Acknowledgements

We build on open source technologies like WireGuard®, Pion ICE, and Rosenpass. We greatly appreciate the work these projects are doing, and we'd love it if you could support them too (e.g., by starring or contributing).

This repository is licensed under the BSD-3-Clause license, which applies to all parts of the repository except for the directories management/, signal/ and relay/. Those directories are licensed under the GNU Affero General Public License version 3.0 (AGPLv3). See the respective LICENSE files inside each directory.

WireGuard and the WireGuard logo are registered trademarks of Jason A. Donenfeld.

netbird (netbirdio/netbird)

Searching Database…

What is this?NetBird is an open-source Zero Trust networking platform: it builds a configuration-free peer-to-peer WireGuard overlay network with centralized access control, so you can create secure private networks without open ports, complex firewall rules or VPN gateways.
Is this an app I install, or a whole platform I have to run?Both parts: every machine runs a NetBird agent that manages WireGuard, while a Management Service holds the network state — either NetBird Cloud or your own self-hosted instance, all managed from an admin web UI.
How do I get started with it?Install the NetBird app and sign up with Google, Microsoft, GitHub or your email, then check the admin web UI. For self-hosting, run the quickstart script on a Linux VM (1 CPU, 2 GB RAM) with Docker Compose v2+ and a public domain — it takes about 5 minutes.
Does the peer-to-peer connection always work?Not always — behind carrier-grade NAT a direct p2p connection may fail, and NetBird then establishes the secure WireGuard tunnel through a Relay Service instead.
Which devices and systems can run it?Linux, macOS, Windows, FreeBSD, iOS, Android and Apple TV, Raspberry Pi, plus pfSense, OPNsense, MikroTik RouterOS, OpenWRT, Synology, TrueNAS, Proxmox, containers and serverless.
Is it fully open source?Mostly: BSD-3-Clause covers the whole repository except the management/, signal/ and relay/ directories, which are licensed under AGPLv3.
How do I control who can access what in the network?From the admin web UI: access policies built on groups and rules, SSO and MFA support, IdP integrations, device posture checks, and SSH gated by central access policies.
What is the NetBird Agent Network?A beta feature: identity-aware access control for AI agents — keyless access to LLM APIs and private resources over the encrypted NetBird tunnel.
Can traffic be routed beyond my own peers?Yes: routes to external networks, domain-based DNS routes, exit nodes, private and custom DNS zones, and an IPv6 dual-stack overlay.
How do I provision many machines at once?Use setup keys for bulk provisioning, the public API, the Terraform provider or the Ansible collection; IdP groups sync over JWT keeps membership in step with your identity provider.
Is the main branch safe to deploy?No — it can be unstable or even broken during development; use the releases for stable versions.
Creator
netbirdio
Size
171.1 MB
Stars
30K
Age
5y
Commits · 90 Days