avm/hassio-addons
1
0
Fork 0
mirror of https://github.com/alexbelgium/hassio-addons.git synced 2026-05-09 10:21:48 +02:00
Code Issues Packages Projects Releases Wiki Activity

Simplify netbird-server config

Browse Source
This commit is contained in:
Alexandre
2026-02-06 15:59:53 +01:00
parent 58b7628c32
commit 3ade90256d
8 changed files with 51 additions and 137 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
netbird-server/DOCS.md
View File

@@ -1,6 +1,6 @@
# NetBird Server (monolithic)
This add-on runs the NetBird self-hosted server stack in a single container (Management + Signal + Dashboard + Coturn; Relay optional). It does **not** use Home Assistant ingress. Access the Dashboard directly via the configured port.
This add-on runs the NetBird self-hosted server stack in a single container (Management + Signal + Dashboard + Coturn). It does **not** use Home Assistant ingress. Access the Dashboard directly via the configured port.
NetBird relies on gRPC. If you place the Management/Signal endpoints behind a reverse proxy, it **must** support HTTP/2 + gRPC proxying. See the NetBird reverse-proxy guide for supported configurations: <https://docs.netbird.io/selfhosted/reverse-proxy>.
@@ -11,22 +11,13 @@ The Dashboard container requires the `NETBIRD_MGMT_API_ENDPOINT` environment var
## Quick start
1. Install the add-on.
2. Configure your Identity Provider (IdP) and set the required `auth_*` options (or edit the generated `management.json`).
3. Start the add-on and verify all services are running in the log output.
4. Access the dashboard at `http://<HA_HOST>:<dashboard_port>`.
> **Tip:** If you are using your own reverse proxy, set `external_base_url` to the public URL and keep TLS termination in your proxy.
2. Start the add-on and verify all services are running in the log output.
3. Stop the add-on, edit the generated `management.json` to configure your Identity Provider (IdP), then start the add-on again.
4. Access the dashboard at `http://<HA_HOST>:8080`.
## Configuration
### Required options
- `data_dir`: Where NetBird stores persistent data. Default: `/config/netbird`.
- `auth_authority`, `auth_client_id`, `auth_audience`, `auth_jwt_certs`, `auth_oidc_configuration_endpoint`: OIDC values used by the Management service and Dashboard.
### Optional options
- `disable_dashboard`: Disable the dashboard service entirely.
- `enable_relay`: Enable the NetBird relay service (requires `relay_exposed_address` and `relay_auth_secret`).
- `turn_external_ip`: Public IP to advertise when Coturn is behind NAT.
This add-on starts with zero configuration options. It writes default configs into `/config/netbird` and runs on the standard NetBird ports.
### Generated configuration
On first start, the add-on creates:
@@ -43,14 +34,9 @@ Default ports exposed by this add-on:
- `10000/tcp`: Signal gRPC
- `8080/tcp`: Dashboard
- `3478/udp`: Coturn STUN/TURN
- `33080/tcp`: Relay (optional)
If you have legacy (< v0.29) clients, review the legacy port notes in the NetBird self-hosted guide and ensure your firewall/forwarding rules are compatible.
## Logs
Use `log_level: debug` for more verbose logging.
## Notes
- This add-on does **not** handle TLS certificates. Place it behind your existing reverse proxy if you need HTTPS.