:hatching_chick: New release! Beta Update May 2022. Learn more

Start using NetBird at app.netbird.io
See Documentation
Join our Slack channel

**NetBird is an open-source VPN management platform built on top of WireGuard® making it easy to create secure private networks for your organization or home.** It requires zero configuration effort leaving behind the hassle of opening ports, complex firewall rules, VPN gateways, and so forth. NetBird creates an overlay peer-to-peer network connecting machines automatically regardless of their location (home, office, datacenter, container, cloud or edge environments) unifying virtual private network management experience. **Key features:** - \[x] Automatic IP allocation and network management with a Web UI ([separate repo](https://github.com/netbirdio/dashboard)) - \[x] Automatic WireGuard peer (machine) discovery and configuration. - \[x] Encrypted peer-to-peer connections without a central VPN gateway. - \[x] Connection relay fallback in case a peer-to-peer connection is not possible. - \[x] Desktop client applications for Linux, MacOS, and Windows (systray). - \[x] Multiuser support - sharing network between multiple users. - \[x] SSO and MFA support. - \[x] Multicloud and hybrid-cloud support. - \[x] Kernel WireGuard usage when possible. **Coming soon:** - \[ ] Access Controls - groups & rules. - \[ ] Private DNS. - \[ ] Mobile clients. - \[ ] Network Activity Monitoring. ### Secure peer-to-peer VPN with SSO and MFA in minutes

**Note**: The `main` branch may be in an *unstable or even broken state* during development. For stable versions, see [releases](https://github.com/netbirdio/netbird/releases). ### Start using NetBird - Hosted version: [https://app.netbird.io/](https://app.netbird.io/). - See our documentation for [Quickstart Guide](https://netbird.io/docs/getting-started/quickstart). - If you are looking to self-host NetBird, check our [Self-Hosting Guide](https://netbird.io/docs/getting-started/self-hosting). - Step-by-step [Installation Guide](https://netbird.io/docs/getting-started/installation) for different platforms. - Web UI [repository](https://github.com/netbirdio/dashboard). - 5 min [demo video](https://youtu.be/Tu9tPsUWaY0) on YouTube. ### A bit on NetBird internals - Every machine in the network runs [NetBird Agent (or Client)](client/) that manages WireGuard. - Every agent connects to [Management Service](management/) that holds network state, manages peer IPs, and distributes network updates to agents (peers). - NetBird agent uses WebRTC ICE implemented in [pion/ice library](https://github.com/pion/ice) to discover connection candidates when establishing a peer-to-peer connection between machines. - Connection candidates are discovered with a help of [STUN](https://en.wikipedia.org/wiki/STUN) servers. - Agents negotiate a connection through [Signal Service](signal/) passing p2p encrypted messages with candidates. - Sometimes the NAT traversal is unsuccessful due to strict NATs (e.g. mobile carrier-grade NAT) and p2p connection isn't possible. When this occurs the system falls back to a relay server called [TURN](https://en.wikipedia.org/wiki/Traversal_Using_Relays_around_NAT), and a secure WireGuard tunnel is established via the TURN server. [Coturn](https://github.com/coturn/coturn) is the one that has been successfully used for STUN and TURN in NetBird setups.

See a complete [architecture overview](https://netbird.io/docs/overview/architecture) for details. ### Roadmap - [Public Roadmap](https://github.com/netbirdio/netbird/projects/2) ### Community projects - [NetBird on OpenWRT](https://github.com/messense/openwrt-netbird) ### Testimonials We use open-source technologies like [WireGuard®](https://www.wireguard.com/), [Pion ICE (WebRTC)](https://github.com/pion/ice), and [Coturn](https://github.com/coturn/coturn). We very much appreciate the work these guys are doing and we'd greatly appreciate if you could support them in any way (e.g. giving a star or a contribution). ### Legal [WireGuard](https://wireguard.com/) is a registered trademark of Jason A. Donenfeld.