From 0a43d8ab56928db6233cd49b2ab04684543aa747 Mon Sep 17 00:00:00 2001
From: Aarnav Tale <aarnavtale@icloud.com>
Date: Sat, 12 Apr 2025 10:15:08 -0400
Subject: [PATCH] docs: agent config was not under its correct section

---
 Dockerfile          |  1 +
 config.example.yaml | 43 ++++++++++++++++++++++---------------------
 2 files changed, 23 insertions(+), 21 deletions(-)

diff --git a/Dockerfile b/Dockerfile
index efcfcdd..30b76a0 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -26,6 +26,7 @@ FROM node:22-alpine
 RUN apk add --no-cache ca-certificates
 RUN mkdir -p /var/lib/headplane
 RUN mkdir -p /usr/libexec/headplane
+RUN mkdir -p /var/lib/headplane/agent
 
 WORKDIR /app
 COPY --from=build /app/build /app/build
diff --git a/config.example.yaml b/config.example.yaml
index e1adb4e..94f9eab 100644
--- a/config.example.yaml
+++ b/config.example.yaml
@@ -44,29 +44,30 @@ headscale:
 
 # Integration configurations for Headplane to interact with Headscale
 integration:
-  # The Headplane agent allows retrieving information about nodes
-  # This allows the UI to display version, OS, and connectivity data
-  # You will see the Headplane agent in your Tailnet as a node when
-  # it connects.
-  enabled: false
-  # To connect to your Tailnet, you need to generate a pre-auth key
-  # This can be done via the web UI or through the `headscale` CLI.
-  pre_authkey: "<your-preauth-key>"
-  # Optionally change the name of the agent in the Tailnet.
-  # host_name: "headplane-agent"
+  agent:
+    # The Headplane agent allows retrieving information about nodes
+    # This allows the UI to display version, OS, and connectivity data
+    # You will see the Headplane agent in your Tailnet as a node when
+    # it connects.
+    enabled: false
+    # To connect to your Tailnet, you need to generate a pre-auth key
+    # This can be done via the web UI or through the `headscale` CLI.
+    pre_authkey: "<your-preauth-key>"
+    # Optionally change the name of the agent in the Tailnet.
+    # host_name: "headplane-agent"
 
-  # Configure different caching settings. By default, the agent will store
-  # caches in the path below for a maximum of 1 minute. If you want data
-  # to update faster, reduce the TTL, but this will increase the frequency
-  # of requests to Headscale.
-  # cache_ttl: 60
-  # cache_path: /var/lib/headplane/agent_cache.json
+    # Configure different caching settings. By default, the agent will store
+    # caches in the path below for a maximum of 1 minute. If you want data
+    # to update faster, reduce the TTL, but this will increase the frequency
+    # of requests to Headscale.
+    # cache_ttl: 60
+    # cache_path: /var/lib/headplane/agent_cache.json
 
-  # Do not change this unless you are running a custom deployment.
-  # The work_dir represents where the agent will store its data to be able
-  # to automatically reauthenticate with your Tailnet. It needs to be
-  # writable by the user running the Headplane process.
-  # work_dir: "/var/lib/headplane/agent"
+    # Do not change this unless you are running a custom deployment.
+    # The work_dir represents where the agent will store its data to be able
+    # to automatically reauthenticate with your Tailnet. It needs to be
+    # writable by the user running the Headplane process.
+    # work_dir: "/var/lib/headplane/agent"
 
   # Only one of these should be enabled at a time or you will get errors
   # This does not include the agent integration (above), which can be enabled