[Feature Request] NetBird service widget

[tycoon1807]

Description

Description
Add a service widget for NetBird — an open-source, self-hostable overlay network built on WireGuard. NetBird exposes a local REST API that can be queried without authentication, making it a straightforward candidate for a Homepage widget.

What the widget should display

• Connection status (connected / disconnected)
• Number of connected peers
• TX / RX traffic stats

API
NetBird runs a local management daemon that exposes a REST API, typically at:

http://localhost:8080/api/status

No API key required for local access.

Example relevant fields from the response:

• state – connection state
• peers – list of connected peers
• bytesRx / bytesTx – traffic counters

Why this fits Homepage
NetBird is widely used in self-hosted setups (Unraid, Proxmox, Docker, etc.) and aligns perfectly with the Homepage user base. A widget would give users instant visibility into their network connectivity directly from their dashboard.

References

• NetBird GitHub: https://github.com/netbirdio/netbird
• NetBird Docs: https://docs.netbird.io

Other

No response

[tobee89]

I built a working NetBird widget and I am happy to contribute it once this request reaches the vote threshold.

Branch: https://github.com/tobee89/homepage/tree/netbird-widget

Two corrections to original request by @tycoon1807, based on testing against a self-hosted NetBird 0.76.2:

1. There is no unauthenticated REST API at http://localhost:8080/api/status. The local agent speaks gRPC over a
   unix socket. What works is the management API of your NetBird server, using a personal access token in the
   Authorization: Token <PAT> header, the same pattern the Tailscale widget already uses.
2. The management API does not expose traffic counters, so TX and RX cannot be shown.

What the widget reads:

• /api/peers for total peers, connected peers, expired logins and client versions
• /api/instance/version for the update status
• /api/users only when the users field is displayed

Fields: peers, online (shown as 6 / 8), users, login_expired, outdated, version, current_version.
Default is online, users, version, current_version.

Worth highlighting: /api/instance/version returns management_update_available and the latest release. The NetBird
server fetches that from GitHub itself, so the widget never talks to anything outside your own instance. The
outdated field counts peers running a client older than the management server, which is hard to see anywhere else
without clicking through the dashboard.

Config example:

widget:
  type: netbird
  url: https://netbird.host.or.ip
  key: netbirdpersonalaccesstoken

The widget stays within the service widget guidelines: one row, four blocks, read only, no custom proxy, two API
calls by default.

I know this discussion sits below the 20 up-vote threshold, so I am not opening a pull request yet. If there is
interest, the branch is ready.

Built with Claude's help, tested against my own NetBird 0.76.2 instance. Every field was verified against the raw
API responses.