From 07859e5ff6a310a2c066a965d53a0000ced41086 Mon Sep 17 00:00:00 2001 From: Kristoffer Dalby Date: Tue, 10 Nov 2026 05:44:41 +0000 Subject: [PATCH] types, docs, nix: regenerate config docs for write_ahead_log Updates #1926 --- docs/ref/config-example.yaml | 8 +++++--- docs/ref/configuration-options.md | 2 +- hscontrol/types/config_docs_generated.go | 2 +- nix/options.generated.nix | 2 +- 4 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/ref/config-example.yaml b/docs/ref/config-example.yaml index e61d0d76b..0a2a243be 100644 --- a/docs/ref/config-example.yaml +++ b/docs/ref/config-example.yaml @@ -199,9 +199,11 @@ database: # The database file, relative to the configuration file; `:memory:` keeps # the database in memory. path: /var/lib/headscale/db.sqlite - # Applies `database.sqlite.wal_autocheckpoint` and compacts the database - # (`VACUUM`) on shutdown. SQLite runs in WAL mode either way; false keeps - # SQLite's default checkpoint of 1000 frames. + # Runs SQLite in write-ahead log (WAL) mode, applies + # `database.sqlite.wal_autocheckpoint` and compacts the database (`VACUUM`) + # on shutdown. False uses SQLite's rollback journal (`DELETE`) with + # `synchronous=FULL`, and converts a database left in WAL mode when + # headscale opens it. write_ahead_log: true # The number of WAL frames after which the WAL is checkpointed # automatically; zero disables automatic checkpoints. Applied only when diff --git a/docs/ref/configuration-options.md b/docs/ref/configuration-options.md index 623566ec1..eaffe6bea 100644 --- a/docs/ref/configuration-options.md +++ b/docs/ref/configuration-options.md @@ -1456,7 +1456,7 @@ Replaces `db_path` ([removed](#db_path)). - **Default:** `true` - **Env:** `HEADSCALE_DATABASE_SQLITE_WRITE_AHEAD_LOG` -Applies [`database.sqlite.wal_autocheckpoint`](#database.sqlite.wal_autocheckpoint) and compacts the database (`VACUUM`) on shutdown. SQLite runs in WAL mode either way; false keeps SQLite's default checkpoint of 1000 frames. +Runs SQLite in write-ahead log (WAL) mode, applies [`database.sqlite.wal_autocheckpoint`](#database.sqlite.wal_autocheckpoint) and compacts the database (`VACUUM`) on shutdown. False uses SQLite's rollback journal (`DELETE`) with `synchronous=FULL`, and converts a database left in WAL mode when headscale opens it. === "YAML" diff --git a/hscontrol/types/config_docs_generated.go b/hscontrol/types/config_docs_generated.go index 84405ceb7..53cc629fa 100644 --- a/hscontrol/types/config_docs_generated.go +++ b/hscontrol/types/config_docs_generated.go @@ -118,7 +118,7 @@ var configFieldDocs = map[string]string{ "RouteConfig.HA": "Health probing of HA subnet routers. When two or more nodes advertise the same route, headscale pings each over Noise and moves the route away from one that does not answer in time. See [High availability](https://headscale.net/stable/ref/routes/#high-availability).", "SqliteConfig.Path": "The database file, relative to the configuration file; `:memory:` keeps the database in memory.", "SqliteConfig.WALAutoCheckPoint": "The number of WAL frames after which the WAL is checkpointed automatically; zero disables automatic checkpoints. Applied only when `database.sqlite.write_ahead_log` is true.", - "SqliteConfig.WriteAheadLog": "Applies `database.sqlite.wal_autocheckpoint` and compacts the database (`VACUUM`) on shutdown. SQLite runs in WAL mode either way; false keeps SQLite's default checkpoint of 1000 frames.", + "SqliteConfig.WriteAheadLog": "Runs SQLite in write-ahead log (WAL) mode, applies `database.sqlite.wal_autocheckpoint` and compacts the database (`VACUUM`) on shutdown. False uses SQLite's rollback journal (`DELETE`) with `synchronous=FULL`, and converts a database left in WAL mode when headscale opens it.", "TLSConfig.ACME": "Gets the certificate from an ACME CA such as Let's Encrypt, and renews it. Setting `tls.acme.hostname` turns it on.", "TLSConfig.CertPath": "The PEM certificate file, relative to the configuration file. Setting it turns TLS on.", "TLSConfig.KeyPath": "The PEM private key file of `tls.cert_path`, relative to the configuration file.", diff --git a/nix/options.generated.nix b/nix/options.generated.nix index 74d6a5e96..0bc76c1db 100644 --- a/nix/options.generated.nix +++ b/nix/options.generated.nix @@ -452,7 +452,7 @@ in type = lib.types.bool; default = true; description = '' - Applies `database.sqlite.wal_autocheckpoint` and compacts the database (`VACUUM`) on shutdown. SQLite runs in WAL mode either way; false keeps SQLite's default checkpoint of 1000 frames. + Runs SQLite in write-ahead log (WAL) mode, applies `database.sqlite.wal_autocheckpoint` and compacts the database (`VACUUM`) on shutdown. False uses SQLite's rollback journal (`DELETE`) with `synchronous=FULL`, and converts a database left in WAL mode when headscale opens it. ''; example = false; };