aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-16 19:44:37 +0000
committertv <tv@krebsco.de>2026-11-16 21:25:59 +0100
commit0ba4c7363cfa2a9963ecd6a06392ea5c4dac3ad1 (patch)
treefa40cfbfda010601eff9f9db148c5aa793aca0b2 /docs
parent3fccc4f6859cf0b4d93e7d166142e1ab9255723f (diff)
node: a swarm holding a store, started from its root or joined by its ID
Behind the `federation` feature, two options: * `--store-root PATH` starts a swarm holding a store, or goes on with one, from the store's root, as bytes in the file, which the federation must take as a root. With no document to start on, the node builds the genesis change from it, as every node given the root does, and is ready at once; a document to start on must be of the root's swarm. * `--store-id ID` joins one through seeds by its ID, the root's SHA-256 in hex. An empty document of the first epoch takes as its root only that store's genesis change, built again from the root it holds (`document::events::is_genesis`), whatever peers name: the root pin doesn't wait for seeds, nor is disputed. Either names the swarm the node joins, which a state file must remember too, and can't be combined with the other, nor with what makes a new swarm's first change (`--genesis`, `--bootstrap-users`, `--bootstrap-keys`, `--bootstrap-policy`, `--remake`, `--genesis-root`). The root is read as a file of its own kind (`store`), counted among the node's files.
Diffstat (limited to 'docs')
-rw-r--r--docs/example.toml7
-rw-r--r--docs/openapi.yaml3
2 files changed, 9 insertions, 1 deletions
diff --git a/docs/example.toml b/docs/example.toml
index 3e189fe..d7f8d08 100644
--- a/docs/example.toml
+++ b/docs/example.toml
@@ -119,6 +119,13 @@ htpasswd = "/etc/continuum/htpasswd"
# passed since the first did, none while they name different ones (docs/access.md).
# genesis-root = "…"
+# Behind the `federation` feature: start a swarm holding a store (docs/store.md), or go
+# on with one, from the store's root, as bytes in this file; the swarm's ID is the
+# root's SHA-256, in hex. Or join one through seeds by that ID: joining with an empty
+# document, the node takes as its root only that store's genesis change.
+# store-root = "/var/lib/continuum/root.json"
+# store-id = "…"
+
# SSH keys, as authorized_keys lines (ssh-ed25519 <base64> [comment]), whose signature
# on a strict remake's manifest this node takes: the values kept when the swarm turns
# strict (docs/access.md). Without, it votes for no strict remake; a majority of the
diff --git a/docs/openapi.yaml b/docs/openapi.yaml
index 678cfe3..bfb5ba3 100644
--- a/docs/openapi.yaml
+++ b/docs/openapi.yaml
@@ -2802,7 +2802,8 @@ components:
description: |
This node's own files, by kind (`state`: the state file, `document`: the
document file, `backup`: a backup recovered from, `remake`: the input of a
- genesis remake), since it started.
+ genesis remake, and behind the `federation` feature `store`: a store's root),
+ since it started.
additionalProperties:
type: object
required: [reads, readBytes, writes, writtenBytes, appends, appendedBytes, errors]