docs: agent config was not under its correct section

This commit is contained in:
Aarnav Tale
2025-04-12 10:15:08 -04:00
parent 7eda09bae8
commit dedec8f317
2 changed files with 23 additions and 21 deletions
+1
View File
@@ -26,6 +26,7 @@ FROM node:22-alpine
RUN apk add --no-cache ca-certificates RUN apk add --no-cache ca-certificates
RUN mkdir -p /var/lib/headplane RUN mkdir -p /var/lib/headplane
RUN mkdir -p /usr/libexec/headplane RUN mkdir -p /usr/libexec/headplane
RUN mkdir -p /var/lib/headplane/agent
WORKDIR /app WORKDIR /app
COPY --from=build /app/build /app/build COPY --from=build /app/build /app/build
+22 -21
View File
@@ -44,29 +44,30 @@ headscale:
# Integration configurations for Headplane to interact with Headscale # Integration configurations for Headplane to interact with Headscale
integration: integration:
# The Headplane agent allows retrieving information about nodes agent:
# This allows the UI to display version, OS, and connectivity data # The Headplane agent allows retrieving information about nodes
# You will see the Headplane agent in your Tailnet as a node when # This allows the UI to display version, OS, and connectivity data
# it connects. # You will see the Headplane agent in your Tailnet as a node when
enabled: false # it connects.
# To connect to your Tailnet, you need to generate a pre-auth key enabled: false
# This can be done via the web UI or through the `headscale` CLI. # To connect to your Tailnet, you need to generate a pre-auth key
pre_authkey: "<your-preauth-key>" # This can be done via the web UI or through the `headscale` CLI.
# Optionally change the name of the agent in the Tailnet. pre_authkey: "<your-preauth-key>"
# host_name: "headplane-agent" # Optionally change the name of the agent in the Tailnet.
# host_name: "headplane-agent"
# Configure different caching settings. By default, the agent will store # 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 # 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 # to update faster, reduce the TTL, but this will increase the frequency
# of requests to Headscale. # of requests to Headscale.
# cache_ttl: 60 # cache_ttl: 60
# cache_path: /var/lib/headplane/agent_cache.json # cache_path: /var/lib/headplane/agent_cache.json
# Do not change this unless you are running a custom deployment. # 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 # The work_dir represents where the agent will store its data to be able
# to automatically reauthenticate with your Tailnet. It needs to be # to automatically reauthenticate with your Tailnet. It needs to be
# writable by the user running the Headplane process. # writable by the user running the Headplane process.
# work_dir: "/var/lib/headplane/agent" # work_dir: "/var/lib/headplane/agent"
# Only one of these should be enabled at a time or you will get errors # 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 # This does not include the agent integration (above), which can be enabled