From ce295d6782eeb7f0cec0d289d7ee6968b10e6eaa Mon Sep 17 00:00:00 2001 From: Kristoffer Dalby Date: Wed, 11 Nov 2026 14:16:20 +0000 Subject: [PATCH] nix, docs: regenerate config reference Updates #3588 --- docs/ref/config-example.yaml | 10 +++++----- docs/ref/configuration-options.md | 4 ++-- hscontrol/types/config_docs_generated.go | 2 +- nix/options.generated.nix | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/ref/config-example.yaml b/docs/ref/config-example.yaml index 0a2a243be..de757ac14 100644 --- a/docs/ref/config-example.yaml +++ b/docs/ref/config-example.yaml @@ -309,11 +309,11 @@ dns: - 149.112.112.112:53 # The DNS provider that writes challenge records: `name` selects it, the # other keys are its settings. Keys are lowercased on load, at every depth; - # two that differ only in case are an error. A string setting may be - # `file:` to read it from a file. `headscale generate config - # --running` and `/debug/config` show `name` and `file:` references; every - # other setting is ``, as any may be a credential. See [DNS-01 - # challenge + # two that differ only in case are an error. Any setting may be + # `file:` to read it from a file; a non-string one, such as acme-dns + # `config`, is the JSON in it. `headscale generate config --running` and + # `/debug/config` show `name` and `file:` references; every other setting is + # ``, as any may be a credential. See [DNS-01 challenge # provider](https://headscale.net/stable/ref/dns/#dns-01-challenge-provider) # to set a provider up, acme-dns included, and to set it from environment # variables. diff --git a/docs/ref/configuration-options.md b/docs/ref/configuration-options.md index eaffe6bea..3943ff53a 100644 --- a/docs/ref/configuration-options.md +++ b/docs/ref/configuration-options.md @@ -73,7 +73,7 @@ is trimmed; an empty file is an error. Headscale reads the file only where the s `headscale check config` and `headscale check all` never read it. `headscale generate config --running` and `/debug/config` show a literal secret as `` and a `file:` reference as written. -The secrets are [`database.postgres.pass`](#database.postgres.pass), [`oidc.client_secret`](#oidc.client_secret), [`cli.api_key`](#cli.api_key) and every string setting of [`dns.challenge.provider`](#dns.challenge.provider). +The secrets are [`database.postgres.pass`](#database.postgres.pass), [`oidc.client_secret`](#oidc.client_secret), [`cli.api_key`](#cli.api_key) and every setting of [`dns.challenge.provider`](#dns.challenge.provider), where a non-string one, such as acme-dns `config`, is the JSON in the file. On NixOS, keep a secret out of the Nix store: load it as a systemd credential and point the key at it. @@ -2271,7 +2271,7 @@ The servers asked for the zone's nameservers, each an IP or host with an optiona - **Default:** `{}` - **Env:** `HEADSCALE_DNS_CHALLENGE_PROVIDER` ([JSON object](#env)) -The DNS provider that writes challenge records: `name` selects it, the other keys are its settings. Keys are lowercased on load, at every depth; two that differ only in case are an error. A string setting may be `file:` to read it from a file. `headscale generate config --running` and `/debug/config` show `name` and `file:` references; every other setting is ``, as any may be a credential. See [DNS-01 challenge provider](dns.md#dns-01-challenge-provider) to set a provider up, acme-dns included, and to set it from environment variables. +The DNS provider that writes challenge records: `name` selects it, the other keys are its settings. Keys are lowercased on load, at every depth; two that differ only in case are an error. Any setting may be `file:` to read it from a file; a non-string one, such as acme-dns `config`, is the JSON in it. `headscale generate config --running` and `/debug/config` show `name` and `file:` references; every other setting is ``, as any may be a credential. See [DNS-01 challenge provider](dns.md#dns-01-challenge-provider) to set a provider up, acme-dns included, and to set it from environment variables. | Provider | Settings | | ------------ | ----------------------------------------------------------- | diff --git a/hscontrol/types/config_docs_generated.go b/hscontrol/types/config_docs_generated.go index 53cc629fa..d5495c966 100644 --- a/hscontrol/types/config_docs_generated.go +++ b/hscontrol/types/config_docs_generated.go @@ -55,7 +55,7 @@ var configFieldDocs = map[string]string{ "DERPServerConfig.STUNAddr": "The UDP host:port of the STUN server, which helps clients with NAT traversal; required when `derp.server.enabled` is true.", "DERPServerConfig.VerifyClients": "Admits only nodes registered with this server.", "DNSChallengeConfig.PropagationTimeout": "How long to wait for a challenge record to show up on every authoritative nameserver. Zero skips the check.", - "DNSChallengeConfig.ProviderSettings": "The DNS provider that writes challenge records: `name` selects it, the other keys are its settings. Keys are lowercased on load, at every depth; two that differ only in case are an error. A string setting may be `file:` to read it from a file. `headscale generate config --running` and `/debug/config` show `name` and `file:` references; every other setting is ``, as any may be a credential. See [DNS-01 challenge provider](https://headscale.net/stable/ref/dns/#dns-01-challenge-provider) to set a provider up, acme-dns included, and to set it from environment variables.", + "DNSChallengeConfig.ProviderSettings": "The DNS provider that writes challenge records: `name` selects it, the other keys are its settings. Keys are lowercased on load, at every depth; two that differ only in case are an error. Any setting may be `file:` to read it from a file; a non-string one, such as acme-dns `config`, is the JSON in it. `headscale generate config --running` and `/debug/config` show `name` and `file:` references; every other setting is ``, as any may be a credential. See [DNS-01 challenge provider](https://headscale.net/stable/ref/dns/#dns-01-challenge-provider) to set a provider up, acme-dns included, and to set it from environment variables.", "DNSChallengeConfig.Resolvers": "The servers asked for the zone's nameservers, each an IP or host with an optional port (53 if omitted). Empty uses the default public resolvers. The system resolver is never used: on a host running MagicDNS it answers for `dns.base_domain` itself.", "DNSConfig.BaseDomain": "The domain MagicDNS names live under, without a trailing dot, e.g. `example.com`. The host of `server_url` must not be this domain or a name below it: clients take the domain over. The default is a private-use name, so `dns.certificates` needs a public domain you control.", "DNSConfig.Certificates": "Lets nodes get TLS certificates for their MagicDNS names with `tailscale cert`. The node runs ACME itself; headscale publishes its DNS-01 challenge through `dns.challenge.provider`.", diff --git a/nix/options.generated.nix b/nix/options.generated.nix index 0bc76c1db..62b8f04fe 100644 --- a/nix/options.generated.nix +++ b/nix/options.generated.nix @@ -715,7 +715,7 @@ in type = lib.types.attrsOf lib.types.anything; default = { }; description = '' - The DNS provider that writes challenge records: `name` selects it, the other keys are its settings. Keys are lowercased on load, at every depth; two that differ only in case are an error. A string setting may be `file:` to read it from a file. `headscale generate config --running` and `/debug/config` show `name` and `file:` references; every other setting is ``, as any may be a credential. See [DNS-01 challenge provider](https://headscale.net/stable/ref/dns/#dns-01-challenge-provider) to set a provider up, acme-dns included, and to set it from environment variables. + The DNS provider that writes challenge records: `name` selects it, the other keys are its settings. Keys are lowercased on load, at every depth; two that differ only in case are an error. Any setting may be `file:` to read it from a file; a non-string one, such as acme-dns `config`, is the JSON in it. `headscale generate config --running` and `/debug/config` show `name` and `file:` references; every other setting is ``, as any may be a credential. See [DNS-01 challenge provider](https://headscale.net/stable/ref/dns/#dns-01-challenge-provider) to set a provider up, acme-dns included, and to set it from environment variables. On NixOS, keep a secret setting out of the Nix store: load it as a systemd credential with `systemd.services.headscale.serviceConfig.LoadCredential = [ "dns_challenge_provider_:/run/secrets/dns_challenge_provider_" ];` and set the setting to `"file:\''${CREDENTIALS_DIRECTORY}/dns_challenge_provider_"`. `name` is not a secret. '';