From b37befc6021e1b003f0c8bbf704a1a8133e32a07 Mon Sep 17 00:00:00 2001 From: Bruno Mercier Costa <94469565+emrcbrn@users.noreply.github.com> Date: Tue, 21 Jul 2026 15:36:19 +0200 Subject: [PATCH] Reference the config-file bootstrap workflow from install and peer pages (#868) * Reference the config-file bootstrap workflow from install and peer pages Link Bootstrap peers via config file from the setup-key sections of the Linux, Windows, macOS, and Docker install pages, from the Setup Keys page, and from the Kubernetes routing-peers guide. The page was only reachable from the sidebar, so this surfaces the unattended deployment workflow where headless and at-scale enrollment is already discussed. Co-Authored-By: Claude Opus 4.8 * Clarify the Kubernetes example demonstrates setup-key enrollment The manifest passes a setup key but does not mount a pre-populated config, so reword the cross-link: the example enrolls with a setup key, and the bootstrap guide covers the additional config-file step. Co-Authored-By: Claude Opus 4.8 --------- Co-authored-by: Claude Opus 4.8 --- src/pages/get-started/install/docker.mdx | 2 ++ src/pages/get-started/install/linux.mdx | 2 ++ src/pages/get-started/install/macos.mdx | 2 ++ src/pages/get-started/install/windows.mdx | 2 ++ src/pages/manage/peers/register-machines-using-setup-keys.mdx | 2 ++ src/pages/use-cases/kubernetes/routing-peers-and-kubernetes.mdx | 2 ++ 6 files changed, 12 insertions(+) diff --git a/src/pages/get-started/install/docker.mdx b/src/pages/get-started/install/docker.mdx index 96b30b5e..d9c3da64 100644 --- a/src/pages/get-started/install/docker.mdx +++ b/src/pages/get-started/install/docker.mdx @@ -87,6 +87,8 @@ volumes: In case you are activating a server peer, you can use a [setup key](/manage/peers/register-machines-using-setup-keys) as described in the steps below. > This is especially helpful when you are running multiple server instances with infrastructure-as-code tools like ansible and terraform. +For unattended deployments across many containers, pre-populate the client config and inject the setup key at runtime. See [Bootstrap peers via config file](/manage/peers/bootstrap-via-config-file). + 1. Login to the Management Service. You need to have a `setup key` in hand (see [setup keys](/manage/peers/register-machines-using-setup-keys)). ```bash diff --git a/src/pages/get-started/install/linux.mdx b/src/pages/get-started/install/linux.mdx index ca31052e..bf13b4d2 100644 --- a/src/pages/get-started/install/linux.mdx +++ b/src/pages/get-started/install/linux.mdx @@ -329,6 +329,8 @@ Check connection status: In case you are activating a server peer, you can use a [setup key](/manage/peers/register-machines-using-setup-keys) as described in the steps below. > This is especially helpful when you are running multiple server instances with infrastructure-as-code tools like ansible and terraform. +For unattended deployments across many machines, pre-populate the client config so each peer registers on first start. See [Bootstrap peers via config file](/manage/peers/bootstrap-via-config-file). + 1. Login to the Management Service. You need to have a `setup key` in hand (see [setup keys](/manage/peers/register-machines-using-setup-keys)). ```bash diff --git a/src/pages/get-started/install/macos.mdx b/src/pages/get-started/install/macos.mdx index c838a84a..b0d34a45 100644 --- a/src/pages/get-started/install/macos.mdx +++ b/src/pages/get-started/install/macos.mdx @@ -138,6 +138,8 @@ Check connection status: In case you are activating a server peer, you can use a [setup key](/manage/peers/register-machines-using-setup-keys) as described in the steps below. > This is especially helpful when you are running multiple server instances with infrastructure-as-code tools like ansible and terraform. +For unattended deployments across many machines, pre-populate the client config so each peer registers on first start. See [Bootstrap peers via config file](/manage/peers/bootstrap-via-config-file). + 1. Login to the Management Service. You need to have a `setup key` in hand (see [setup keys](/manage/peers/register-machines-using-setup-keys)). ```bash diff --git a/src/pages/get-started/install/windows.mdx b/src/pages/get-started/install/windows.mdx index 23840916..72bcc1bf 100644 --- a/src/pages/get-started/install/windows.mdx +++ b/src/pages/get-started/install/windows.mdx @@ -97,6 +97,8 @@ Check connection status: In case you are activating a server peer, you can use a [setup key](/manage/peers/register-machines-using-setup-keys) as described in the steps below. > This is especially helpful when you are running multiple server instances with infrastructure-as-code tools like ansible and terraform. +For unattended deployments across many machines, pre-populate the client config so each peer registers on first start. See [Bootstrap peers via config file](/manage/peers/bootstrap-via-config-file). + 1. Login to the Management Service. You need to have a `setup key` in hand (see [setup keys](/manage/peers/register-machines-using-setup-keys)). For all systems: diff --git a/src/pages/manage/peers/register-machines-using-setup-keys.mdx b/src/pages/manage/peers/register-machines-using-setup-keys.mdx index f4ad1ae4..2d74249c 100644 --- a/src/pages/manage/peers/register-machines-using-setup-keys.mdx +++ b/src/pages/manage/peers/register-machines-using-setup-keys.mdx @@ -12,6 +12,8 @@ This unlocks automated, unattended deployments and integrates cleanly with infra netbird up --setup-key ``` +You can also pre-populate the client configuration ahead of first start, so peers come up fully configured and register with no manual steps. See [Bootstrap peers via config file](/manage/peers/bootstrap-via-config-file). + ## Types of Setup Keys There are two types of setup keys: diff --git a/src/pages/use-cases/kubernetes/routing-peers-and-kubernetes.mdx b/src/pages/use-cases/kubernetes/routing-peers-and-kubernetes.mdx index 1d67cfbc..f078585c 100644 --- a/src/pages/use-cases/kubernetes/routing-peers-and-kubernetes.mdx +++ b/src/pages/use-cases/kubernetes/routing-peers-and-kubernetes.mdx @@ -70,6 +70,8 @@ Click on Name & Description to give your policy a name and description. Then cli ### Step 4: Deploy the NetBird agent You can deploy the NetBird agent using a daemon set or a deployment. Below is an example of a deployment configuration with 1 replica. +The example below enrolls the agent with a setup key. To also pre-populate the client config so it starts fully configured, see [Bootstrap peers via config file](/manage/peers/bootstrap-via-config-file). + ```yaml --- apiVersion: apps/v1