Commit Graph
5182 Commits
Author SHA1 Message Date
Kristoffer Dalby eff078ffa2 config, cli, packaging, nix: stop restarting headscale on a configuration error
serve exits 78 (EX_CONFIG) when the configuration file it loaded is
wrong: format, syntax, keys or values. No file, an unreadable one, the
database and ports still exit 1, so systemd keeps retrying what can
heal. The deb unit and the NixOS module set RestartPreventExitStatus=78.
A parse error gives a position and fixed words, never the file's text.

Updates #1926
2026-11-11 12:19:29 +01:00
Kristoffer Dalby 73ef19c0ab packaging: start headscale only with a configuration it accepts
postinst starts or restarts headscale only when check config passes.

Updates #1926
2026-11-11 12:19:29 +01:00
Kristoffer Dalby e37bb3f3a5 nix: keep only distro facts as module defaults
State paths, socket and disable_check_updates; headscale's defaults cover
the rest. headscale-docker gains a CA bundle to fetch HTTPS DERP maps.

Updates #1926
2026-11-11 12:19:29 +01:00
Kristoffer Dalby c2023823b2 nix, docs: regenerate NixOS options and the configuration reference
Updates #1926
2026-11-11 12:19:29 +01:00
Kristoffer Dalby cac78c856b cli: print only the required keys with generate config --minimal
With every other key defaulted, server_url alone is a configuration.

Updates #1926
2026-11-11 12:19:29 +01:00
Kristoffer Dalby 73127e4baa servertest: start a server from a loaded configuration
NewServerFromConfig serves a config unchanged; TestServerURLOnly proves a
server_url-only file or env config serves both ranges, tailnet.internal
and no DNS resolvers.

Updates #1926
2026-11-11 12:19:29 +01:00
Kristoffer Dalby c41c47b282 config: require listen_addr and the sqlite path
Empty values serve cannot use; empty server_url reads "is required".

Updates #1926
2026-11-11 12:19:29 +01:00
Kristoffer Dalby 7edc15ce70 config: clear a key from the environment with ""
A HEADSCALE_* value of "" means what key: "" means in a file, errors
included, so an env-only setup can clear a defaulted key. An empty
variable still counts as unset.

Updates #1926
2026-11-11 12:19:29 +01:00
Kristoffer Dalby 63e518f112 config: give every key but server_url a working default
server_url alone, in a file or HEADSCALE_SERVER_URL, now passes check config.

Fixes #3567
Updates #1926
2026-11-11 12:19:29 +01:00
Kristoffer Dalby 5af7d585bd hscontrol: refresh the DERP map without blocking other scheduled tasks
Updates #1926
2026-11-11 12:19:29 +01:00
Kristoffer Dalby 29c4269866 nix: check the configuration while building the system
check.config also runs `check config -f` on the generated file at build
time, native only, under the unit's environment.

Updates #1926
2026-11-11 12:19:29 +01:00
Kristoffer Dalby 7e0e423fbf nix: build the module on the generated options
settings mirrors headscale's keys one to one, headscale's checks judge the
rest, and the local CLI gets the socket from a variable instead of a file.

headscale always runs as headscale:headscale, which the module creates;
user and group are read-only, so setting either fails evaluation, and stay
only because nixpkgs' headplane module reads them. A settings.cli key
fails evaluation instead of being dropped with a warning, and the unit no
longer gets CAP_CHOWN.
nix/example-configuration.nix goes: the options carry its examples and
defaults.

Updates #1926
2026-11-11 12:19:29 +01:00
Kristoffer Dalby bff13ee823 config: pin what the NixOS module writes for a minimal configuration
The module is about to move to the generated options; this frozen output
is what its effective configuration must still load to.

Updates #1926
2026-11-11 12:19:29 +01:00
Kristoffer Dalby cdd13b4e59 nix, docs: regenerate NixOS options and the configuration reference
Read-only file options take Nix paths; key and state file options take
only absolute paths outside the Nix store; DNS records pass unknown
fields; db_password_file and dns.split appear as removed keys.

Updates #1926
2026-11-11 12:19:29 +01:00
Kristoffer Dalby 6db6129b62 config: let NixOS DNS records pass unknown fields to headscale
Updates #1926
2026-11-11 12:19:29 +01:00
Kristoffer Dalby a6c914efb8 config: log a missing config file only for serve
The environment alone is a complete configuration and client commands
need a file only for an API key, so the loader stops warning; serve logs
at info level that it runs on defaults and the environment.

Updates #1926
2026-11-11 12:19:29 +01:00
Kristoffer Dalby 8c89030d48 config: name the NixOS module's old settings keys as removed
db_password_file and dns.split were rejected only by the NixOS module;
Go now names their replacements, so the module can drop its list.

Updates #1926
2026-11-11 12:19:29 +01:00
Kristoffer Dalby f43583cbc6 config: let NixOS options for read-only files take Nix paths
A nix:"path" tag types policy.path, dns.extra_records_path and
tls.cert_path as an absolute path or "", and derp.paths as a list of
paths, so pkgs.writeText and ./policy.hujson work. A nix:"external" tag
types key and state files as an absolute path outside the Nix store, so
no private key is copied into the world-readable store.

Updates #1926
2026-11-11 12:19:29 +01:00
Kristoffer Dalby 4185b2481c nix: check the policy at build time and the config before a switch
Store-path policy: check policy -f in system.checks.
Pre-switch: check all as the headscale user.
Adapted: no file: secret warning; groups as after activation; a new primary
group skips; the policy the unit's env selects; docs say which check covers
the policy; VM case for the unit's env.

(cherry picked from commit b6ba6e42ee)

Fixes #2898
Updates #1926
2026-11-11 12:19:29 +01:00
Kristoffer Dalby 3dcc107efa goreleaser: generate shipped config files, remove config-example.yaml
Updates #1926
2026-11-11 12:19:28 +01:00
Kristoffer Dalby 4c8f74775f docs: add generated configuration reference and example
Updates #1926
2026-11-11 12:19:28 +01:00
Kristoffer Dalby b92d27b7db config: generate the configuration reference
Updates #1926
2026-11-11 12:19:28 +01:00
Kristoffer Dalby 63fdd50505 nix: add generated NixOS options
Updates #1926
2026-11-11 12:19:28 +01:00
Kristoffer Dalby cd77d50bf6 cli: generate NixOS options from the config schema
Updates #1926
2026-11-11 12:19:28 +01:00
Kristoffer Dalby 439ea1b676 cli: add generate config, replacing dumpConfig
Updates #1926
2026-11-11 12:19:28 +01:00
Kristoffer Dalby d247395ad7 gen/client/v1: regenerate for the running configuration endpoint
Updates #1926
2026-11-11 12:19:28 +01:00
Kristoffer Dalby 408ab0e947 api: serve the running configuration
Updates #1926
2026-11-11 12:19:28 +01:00
Kristoffer Dalby 76a6c24777 config: render the example configuration
Updates #1926
2026-11-11 12:19:28 +01:00
Kristoffer Dalby b9c839b761 config: describe every key for the generators
Updates #1926
2026-11-11 12:19:28 +01:00
Kristoffer Dalby 0578c2a571 types: generate a table of config field docs
Updates #1926
2026-11-11 12:19:28 +01:00
Kristoffer Dalby caecddd249 config: keep every default in Default
The DNS-01 challenge resolvers, dns.challenge.resolvers, now default to
Quad9 (9.9.9.9:53, 149.112.112.112:53) instead of Cloudflare and
Google.

Updates #1926
2026-11-11 12:19:28 +01:00
Kristoffer Dalby 7d2f2a1b37 types: document every config field
Updates #1926
2026-11-11 11:19:27 +00:00
Kristoffer Dalby cca1221ec7 hscontrol: validate configuration in NewHeadscale
Updates #1926
2026-11-11 11:19:27 +00:00
Kristoffer Dalby 48b5cffc96 config: make the loaded configuration round-trip
Configuration keys now match only as written, in lower case. BREAKING:
Server_URL is an unknown key, where 0.29 and the previous commits
ignored case. Each key has one spelling, the one the dump prints.
Open-map entry names keep their own rule: split DNS domains and
provider settings are lowercased, oidc.extra_params keeps case.

Updates #1926
2026-11-11 11:19:27 +00:00
Kristoffer Dalby e8e82ffe71 config: load configuration outside types
Updates #1926
2026-11-11 11:19:27 +00:00
Kristoffer Dalby c6d25d12e1 types: decode configuration strictly
Fixes #2899
Updates #1926
2026-11-11 11:19:27 +00:00
Kristoffer Dalby 3a3a10edf9 types: give config values their own types
Updates #1926
2026-11-11 11:19:27 +00:00
Kristoffer Dalby 565aaf7e49 types: compute derived config values where they are used
Updates #1926
2026-11-11 11:19:27 +00:00
Kristoffer Dalby c27285f224 types: remove viper
Updates #1926
2026-11-11 11:19:27 +00:00
Kristoffer Dalby 960c9a3f1d types: reject unknown and removed config keys
Fixes #1926
2026-11-11 11:19:27 +00:00
Kristoffer Dalby 65e9ccedf6 types: load configuration with koanf
Updates #1926
2026-11-11 11:19:27 +00:00
Kristoffer Dalby 443f3a0ecd types: pin effective config of shipped examples
Updates #1926
2026-11-11 12:19:23 +01:00
Kristoffer Dalby 167f4f646f prek: run treefmt hook serially
Parallel nix fmt batches time out on treefmt's cache lock.

Updates #1926
2026-11-11 12:19:23 +01:00
Kristoffer Dalby 8a291dfc9d types: add config compatibility fixtures
Frozen real-world config inputs for the compat goldens; formatter skips them.

Updates #1926
2026-11-11 12:19:23 +01:00
Kristoffer Dalby bd3495d8d2 types: reject unknown policy.mode
A typo booted with no policy, allowing all traffic.

Updates #1926
2026-11-11 12:19:22 +01:00
Kristoffer Dalby ae6ea2cce4 cli: add check config and check all
check config validates only the config; check all adds one
ok/FAIL/skip line per named file.

Fixes #3443
2026-11-11 12:19:22 +01:00
Kristoffer Dalby 0208434691 config: validate the files a config names
New package hscontrol/config: Files lists each file a config
names with its validator; ReadPrivateKey moves here.

Updates #3443
2026-11-11 12:19:22 +01:00
Kristoffer Dalby 5de40d9528 github: regenerate integration test list
Updates #3355
2026-11-11 12:06:27 +01:00
Kristoffer Dalby f5fd1d16cf cli: add check policy
check policy and policy set share ValidatePolicy; tests and sshTests
run against stand-ins built from the policy. Replaces policy check.

Fixes #3355
2026-11-11 12:06:27 +01:00
Kristoffer Dalby 0fe0545b3d cli: add check command group that loads config on demand
Updates #3355
2026-11-11 12:06:27 +01:00