Vassil Iordanov 96d0e12250
docs: fix setup key variable name in README
NB_SETUP_KEY seems to be the correct name

Signed-off-by: Vassil Iordanov <vassil.iordanov@gmail.com>
Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com>
(cherry picked from commit 2f45d7ccb006554421677d49e07086447a5e354c)
2026-04-24 21:19:24 +04:00
..
2025-09-22 19:29:53 +05:30
2025-09-22 19:29:53 +05:30

Netbird

Adds https://netbird.io network interfaces as system extensions. This means you can access your talos nodes from machines you have configured with netbird

Installation

See Installing Extensions.

Usage

Configure the extension via ExtensionServiceConfig document.

---
apiVersion: v1alpha1
kind: ExtensionServiceConfig
name: netbird
environment:
  - NB_SETUP_KEY=<peer setup key>

or if you are selfhosting it with something like :

---
apiVersion: v1alpha1
kind: ExtensionServiceConfig
name: netbird
environment:
  - NB_SETUP_KEY=<peer setup key>
  - NB_MANAGEMENT_URL=https://netbird.selfhosted:443
  - NB_ADMIN_URL=https://netbird.selfhosted:443

Then apply the patch to your node's MachineConfigs

talosctl patch mc -p @netbird-config.yaml

You will then be able to verify that it is in place with the following command

talosctl get extensionserviceconfigs

NODE          NAMESPACE   TYPE                     ID           VERSION
mynode   runtime     ExtensionServiceConfig   netbird   1

Configuration

For more configuration options please reffer to docs https://docs.netbird.io/