Connect your devices into a single secure private WireGuard®-based mesh network with SSO/MFA and simple access controls.
Go to file
Maycon Santos 01f2b0ecb7
Add support to force using binary install (#1082)
Check if the USE_BIN_INSTALL variable is set to true and skip package manager discovery
2023-08-16 15:10:57 +02:00
.github Add support to force using binary install (#1082) 2023-08-16 15:10:57 +02:00
base62 move into separate package 2023-05-16 12:57:56 +02:00
client Update client Dockerfile to use Alpine as base image and install necessary packages (#1078) 2023-08-12 16:12:09 +02:00
dns Add more activity events (#663) 2023-01-25 16:29:59 +01:00
docs/media Update README.md (#524) 2022-10-22 16:19:16 +02:00
encryption Fix slice bounds out of range in msg decryption (#768) 2023-03-29 10:40:31 +02:00
formatter Mobile (#735) 2023-03-17 10:37:27 +01:00
iface Wg ebpf proxy (#911) 2023-07-26 14:00:47 +02:00
infrastructure_files Fix input reading for NetBird domain in getting-started-with-zitadel.sh (#1064) 2023-08-08 20:10:14 +02:00
management Add domain validation for nameserver groups (#1077) 2023-08-16 11:25:38 +02:00
release_files Add support to force using binary install (#1082) 2023-08-16 15:10:57 +02:00
route Use Peer.ID instead of Peer.Key as peer identifier (#664) 2023-02-03 10:33:28 +01:00
sharedsock Fix sharedsock build on android (#837) 2023-05-05 10:55:23 +02:00
signal Feature/android route notification (#868) 2023-05-31 18:25:24 +02:00
util move into separate package 2023-05-16 12:57:56 +02:00
version Add version info command to signal server (#739) 2023-03-15 07:54:51 +01:00
.gitignore extend gitignore to ignore multiple config files 2023-06-19 15:07:27 +02:00
.goreleaser_ui_darwin.yaml Add version info command to signal server (#739) 2023-03-15 07:54:51 +01:00
.goreleaser_ui.yaml Remove unused netbird UI dependencies (#1007) 2023-07-10 21:09:16 +02:00
.goreleaser.yaml Add getting started script with Zitadel (#1005) 2023-08-03 19:19:17 +02:00
AUTHORS chore: update license and AUTHORS 2022-01-19 16:22:40 +01:00
CODE_OF_CONDUCT.md Add contribution guide (#595) 2022-12-02 13:31:31 +01:00
CONTRIBUTING.md Add contribution guide (#595) 2022-12-02 13:31:31 +01:00
CONTRIBUTOR_LICENSE_AGREEMENT.md Add contribution guide (#595) 2022-12-02 13:31:31 +01:00
go.mod Routemgr error handling (#1073) 2023-08-12 11:42:36 +02:00
go.sum Routemgr error handling (#1073) 2023-08-12 11:42:36 +02:00
LICENSE chore: update license and AUTHORS 2022-01-19 16:22:40 +01:00
README.md Update new release banner (#1072) 2023-08-10 21:10:12 +02:00
SECURITY.md Add security policy file (#600) 2022-12-02 13:54:22 +01:00

🐣 New Release! Self-hosting in under 5 min. Learn more


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


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.

Secure peer-to-peer VPN with SSO and MFA in minutes

https://user-images.githubusercontent.com/700848/197345890-2e2cded5-7b7a-436f-a444-94e80dd24f46.mov

Key features

Connectivity Management Automation Platforms
  • - [x] Kernel WireGuard
  • - [x] Linux
  • - [x] Peer-to-peer connections
  • - [x] Auto peer discovery and configuration
  • - [x] Mac
  • - [x] Peer-to-peer encryption
  • - [x] Windows
  • - [x] Connection relay fallback
  • - [x] IdP groups sync with JWT
  • - [x] Android
  • - [ ] iOS
  • - [x] NAT traversal with BPF
  • - [x] Docker
  • - [x] OpenWRT
  • - [x] SSH access management

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:

  • A Linux VM with at least 1CPU and 2GB of memory.
  • The VM should be publicly accessible on TCP ports 80 and 443 and UDP ports: 3478, 49152-65535.
  • Public domain name pointing to the VM.

Software requirements:

  • Docker installed on the VM with the docker compose plugin (Docker installation guide) or docker with docker-compose in version 2 or higher.
  • jq installed. In most distributions Usually available in the official repositories and can be installed with sudo apt install jq or sudo yum install jq
  • curl installed. Usually available in the official repositories and can be installed with sudo apt install curl or sudo yum install curl

Steps

  • Download and run the installation script:
export NETBIRD_DOMAIN=netbird.example.com; curl -fsSL https://github.com/netbirdio/netbird/releases/latest/download/getting-started-with-zitadel.sh | bash
  • Once finished, you can manage the resources via docker-compose

A bit on NetBird internals

  • Every machine in the network runs NetBird Agent (or Client) that manages WireGuard.
  • Every agent connects to Management Service that holds network state, manages peer IPs, and distributes network updates to agents (peers).
  • NetBird agent uses WebRTC ICE implemented in pion/ice library to discover connection candidates when establishing a peer-to-peer connection between machines.
  • Connection candidates are discovered with a help of STUN servers.
  • Agents negotiate a connection through Signal Service 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, and a secure WireGuard tunnel is established via the TURN server.

Coturn is the one that has been successfully used for STUN and TURN in NetBird setups.

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 CISPA Helmholtz Center for Information Security NetBird brings the security best practices and simplicity to private networking.

CISPA_Logo_BLACK_EN_RZ_RGB (1)

Testimonials

We use open-source technologies like WireGuard®, Pion ICE (WebRTC), Coturn, and Rosenpass. 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).

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