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…

30K ·GitHub
Netbird
Что это такое?NetBird — это Open Source-платформа сетей с нулевым доверием (Zero Trust): она строит одноранговую overlay-сеть на WireGuard без необходимости что-либо настраивать, с централизованным контролем доступа. Это позволяет создавать защищённые частные сети без открытых портов, сложных правил файрвола или VPN-шлюзов.
Это приложение, которое я устанавливаю, или целая платформа, которую нужно развернуть?И то и другое: на каждой машине работает агент NetBird, который управляет WireGuard, а сервис управления (Management Service) хранит состояние сети — это либо облако NetBird Cloud, либо ваш собственный self-hosted-экземпляр; всё управляется через веб-интерфейс администратора.
С чего мне начать?Установите приложение NetBird и зарегистрируйтесь через Google, Microsoft, GitHub или свою почту, затем откройте веб-интерфейс администратора. Для самостоятельного размещения запустите скрипт быстрой установки на Linux-виртуалке (1 CPU, 2 ГБ ОЗУ) с Docker Compose v2+ и публичным доменом — это займёт около 5 минут.
Прямое соединение между устройствами работает всегда?Нет, не всегда — за carrier-grade NAT прямое p2p-соединение может не установиться, и тогда NetBird организует защищённый туннель WireGuard через Relay-сервис.
На каких устройствах и системах это работает?Linux, macOS, Windows, FreeBSD, iOS, Android и Apple TV, Raspberry Pi, а также pfSense, OPNsense, MikroTik RouterOS, OpenWRT, Synology, TrueNAS, Proxmox, контейнеры и serverless.
Проект полностью открытый?Почти: лицензия BSD-3-Clause покрывает весь репозиторий, кроме каталогов management/, signal/ и relay/, которые распространяются под AGPLv3.
Как мне настроить, кто и к чему имеет доступ в сети?Через веб-интерфейс администратора: политики доступа на основе групп и правил, поддержка SSO и MFA, интеграции с IdP, проверки состояния устройств (device posture checks), а также SSH под контролем централизованных политик доступа.
Что такое NetBird Agent Network?Это бета-функция: контроль доступа с учётом личности для AI-агентов — доступ к LLM API и приватным ресурсам без ключей через зашифрованный туннель NetBird.
Можно ли направлять трафик дальше моих собственных устройств в сети?Да: маршруты во внешние сети, DNS-маршруты по доменам, exit-узлы, приватные и кастомные DNS-зоны, а также IPv6 dual-stack overlay.
Как подключить много машин сразу?Используйте setup-ключи для массового подключения, публичный API, Terraform-провайдер или коллекцию Ansible; синхронизация групп IdP через JWT держит состав участников сети в соответствии с вашим провайдером идентификации.
Безопасно ли разворачивать ветку main?Нет — во время разработки она может быть нестабильной и даже сломанной; для стабильных версий используйте релизы.
What are similar projects?pangolin, nebula, tailscale, algo, EasyTier, netmaker, SoftEtherVPN, tailcat
Which topics is it in?wireguard-vpn, nat-traversal, ansible, terraform, wireguard, firewall, remote-access, sso, network-security, p2p, raspberry-pi, vpn
Creator
netbirdio
Size
171.1 MB
Stars
30K
Updated
CommitOct 16Releasev0.81.2Oct 16
Age
5y
Commits · 90 Days