mirror of
https://github.com/juanfont/headscale.git
synced 2026-11-19 20:04:32 +09:00
types, docs, nix: regenerate config docs for write_ahead_log
Updates #1926
This commit is contained in:
1 parent
b7995a311c
commit
07859e5ff6
4 files changed
+8
-6
No files matched your search
Generated
+5
-3
@@ -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
|
||||
|
||||
Generated
+1
-1
@@ -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"
|
||||
|
||||
|
||||
Generated
+1
-1
@@ -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.",
|
||||
|
||||
Generated
+1
-1
@@ -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;
|
||||
};
|
||||
|
||||
Reference in new issue
Block a user