jose1711/netbird-ha

This project connects Home Assistant, a popular home automation platform, to NetBird, a private networking service similar to a VPN. It does not make your Home Assistant instance reachable through NetBird. Instead it works the other way around: it lets Home Assistant watch and report on the state of your NetBird network from inside its own dashboard. Once installed, it creates a device in Home Assistant for every peer, route, and network resource in your NetBird setup. Each of these gets sensors showing things like whether it is connected or active, its IP address, when it was last seen or logged in, whether SSH access is enabled, whether its login has expired, whether it needs approval, and how many other peers it can reach. It works whether you use NetBird's own cloud service or a self-hosted management server, and it automatically re-authenticates if your access token is revoked or expires. Devices for peers, routes, or resources that get removed from NetBird are cleaned up automatically rather than left behind as stale entries. The project also includes an example dashboard file that displays all of your peers, routes, and resources automatically, without anyone needing to type in a fixed list of entity names by hand, so it keeps working as your NetBird network changes over time. Installation is done either through HACS, a popular add-on manager for Home Assistant, by adding this repository as a custom source, or manually by copying a folder into Home Assistant's configuration directory. After either method, Home Assistant needs a restart, and then you connect it to NetBird using an access token generated from the NetBird dashboard. The project is written in Python and released under the MIT license.