aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-16 22:25:31 +0000
committertv <tv@krebsco.de>2026-11-16 23:32:50 +0100
commitc77f4a88dfd0f4ed423951da6535244aea4a0fa1 (patch)
treea50e0fae72f2cb2184cfa4c143e077c8c6866bfe /docs
parent023bc8ca4e571b6eb2095b8f1f34ea4363452db9 (diff)
node: votes it casts by itself, for its party
A node may vote and propose for its party by itself, by its operator's rules (`docs/federation.md`, Votes a node casts by itself; `federation::vote`): * `--store-vote-key`: the party's key it signs with, an OpenSSH private key file, one the party's version names, kept on the node; * `--store-vote-record`: its party's one record of its votes, which it votes by, written before each vote is sent, begun where there is none on the version current then; * `--store-follow`, `--store-follow-any`: the parties it follows, by default only on a version that only moves to a checkpoint; * `--store-propose-events`, `--store-propose-every`: when it proposes a checkpoint, once it holds so many events beyond its checkpoint, or so long after its store moved there; * `--store-held-for` (10 minutes): how long it holds an event before it holds it for a while, for the heads it proposes and the voters' rule. Its store keeps when, by the node's own clock, it took each event, and when it moved to its checkpoint. Whenever the worker reads the store, the node decides what to sign (`Holding::act`), records it, writes the record, offers it to its store, and puts it into the document (`held::write`). A vote by hand through the node, by the record and the voters' rule, is `Holding::vote_by_hand`.
Diffstat (limited to 'docs')
-rw-r--r--docs/example.toml14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/example.toml b/docs/example.toml
index d101964..36a4ae2 100644
--- a/docs/example.toml
+++ b/docs/example.toml
@@ -148,6 +148,20 @@ htpasswd = "/etc/continuum/htpasswd"
# party listing many nodes can't be all of them.
# store-neighbour-parties = ["lass"]
+# Behind the `federation` feature: this node votes and proposes for its party by itself
+# (docs/federation.md, Votes a node casts by itself), with a key its party's version
+# names, kept here, and its party's one record of its votes; its party then votes by
+# hand only through it (POST /admin/events/vote). It follows the parties named (by
+# default only on versions that only move to a checkpoint), and proposes a checkpoint
+# once it holds so many events beyond its checkpoint, or so long after it moved there.
+# store-vote-key = "/var/lib/continuum/party.key"
+# store-vote-record = "/var/lib/continuum/party-record.json"
+# store-follow = ["lass"]
+# store-follow-any = false
+# store-propose-events = 10000
+# store-propose-every = "7d"
+# store-held-for = "10m"
+
# 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