Home Assistant Community Add-on: Netbird Client

NetBird now maintain their own official homeassistant add-on, please use that instead: GitHub - netbirdio/addon-netbird: NetBird Home Assistant Add-on

NetBird is a simple and fast alternative to corporate VPNs built on top of WireGuard® making it easy to create secure private networks for your organization or home.
It requires near zero configuration effort leaving behind the hassle of opening ports, complex firewall rules, vpn gateways, and so forth.

There is no centralized VPN server with NetBird - your computers, devices, machines, and servers connect to each other directly over a fast encrypted tunnel.
NetBird can connect machines running anywhere in just a few clicks. It literally takes less than 5 minutes to deploy a secure peer-to-peer VPN with NetBird.

Add-on is build using the latest NetBird client. (0.24.0 at time of writing)

Installation

Add to Home Assistant
After adding the repository, install the add-on “NetBird Client”
Check Add-on documentation for additional details

Asking naively, as i have very limited knowledge, what is the additional benefit/advantages on top of wire guard?

I would think of NetBird as a wrapper around WireGuard.
NetBird adds the ability to easily provision peers, add firewall rules (based on tags) - and add users to the same control-plane.
It also does NAT transversial - so you do not need to manually open ports in your router.
I can recommed looking at Why Wireguard with NetBird? - NetBird Docs

NOTE: I am in no way affiliated with NetBird… I just happen to like their product, and felt it was well suited for HomeAssistant.
I use it to have a private mesh-network between our home devices (including phones) - to always have secure access to Home Assistant outside our home. :slight_smile:

Thanks appreciated

Tailscale alternative I guess.

Indeed ! They offer about the same capabilities :slight_smile:
Personally, I prefer the way the NetBird admin panel provisions firewall between peers - it seems much more intuitive compared to Tailscale.
And - as NetBird seems to be more “Linux first” mindset, that is a plus in my book as well :slight_smile:

For those who are intested, Netbird now allows “exit nodes”…same as tailscale.
Here is the link https://docs.netbird.io/how-to/configuring-default-routes-for-internet-traffic

Hello everybody, totally new here and with hope to find help. Got a self-hosted Netbird VPS which works perfect with my other clients. The HomeAssistant Add-on starts but it does not register. This is the log:

s6-rc: info: service s6rc-oneshot-runner: starting
s6-rc: info: service s6rc-oneshot-runner successfully started
s6-rc: info: service fix-attrs: starting
s6-rc: info: service fix-attrs successfully started
s6-rc: info: service legacy-cont-init: starting
s6-rc: info: service legacy-cont-init successfully started
s6-rc: info: service netbird-client: starting
s6-rc: info: service netbird-client successfully started
s6-rc: info: service legacy-services: starting
s6-rc: info: service legacy-services successfully started
[15:51:57] INFO: Config file found at /config/netbird/config.json. Ignoring other options
[15:51:57] INFO: Netbird version: 0.26.3
[15:51:57] INFO: NetBird options: -F --config /config/netbird/config.json
[15:51:57] INFO: Starting NetBird client…
Please do the SSO login in your browser.
If your browser didn’t open automatically, use this URL to log in:

The URL shown is also the managed one and not mine. :thinking:

The setup key is set, the address to the admin-url is https://server-url.de:443 and and management-url is https://server-url.de:33073/
Have no idea why it is not working/registering but hopefully one of you has.
At the moment I’ve set one of the other clients as router. It works but it’s not the real McCoy. It’s a 150W Tower and not a 7W Raspi :slightly_smiling_face:
Thank you for bothering.

Don’t know a solution for your problem because I am fairly new to netbird. But the latest client is at version 0.29.4 already, yours is at 0.26.3. Probably they changed something between the versions ?!?

Hi @donpillo
My NetBird repository was archived at the 2nd of April 2024 - due to NetBird now officially maintain a homeassistant add-on.
Hence, I will recommend to use their official client at GitHub - netbirdio/addon-netbird: NetBird Home Assistant Add-on

Hi @glemsom , I already use the official netbird client add-on from

But thanks for your work in the past.
Just wanted to give @lamar856 a hint of the newer client version.