aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-19 16:18:16 +0000
committertv <tv@krebsco.de>2026-11-19 17:36:15 +0100
commit9784111bd3b95be5352669b74e174920c101f349 (patch)
treef443549f96da3d58f4c7e4d9f56b58dcf4af8fa2 /docs
parent9d3350f996ddba2a8e4636dd3705d9bd1c7aa4fb (diff)
continuum-party: a directory for each federation, the only one used unasked
A party named its node, key and record on every command, or a file of them with --config; one voting in several federations kept files apart by hand. Without --config, the client now reads a federation's own directory, `continuum/federations/NAME` in $XDG_CONFIG_HOME or ~/.config: its `party.toml` of the client's options, its record (`record`) and, where there, its key (`key`); options on the command line, or `record` and `key` in `party.toml`, win. `--federation NAME` chooses one; where there is only one, it is used without being named; where there are several, the client says which there are and asks for one. `root`, `judge` and `twice`, using no options, read none. `init --federation NAME` begins a federation's directory, only its owner reading it, its `party.toml` holding the options given on the command line with it (`node`, `token`, `key`, the key's path made absolute; the node's default left out), and the record in it.
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.md15
-rw-r--r--docs/guides/federation/getting-started.md7
2 files changed, 19 insertions, 3 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index f48f288..1b7bd44 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -257,6 +257,21 @@ record = "/home/tv/.config/continuum/tv.record"
continuum-party --config tv.toml write home/tv/motd '"hello"'
```
+Without `--config`, the client reads a federation's own directory, as one party may vote
+in several federations: `~/.config/continuum/federations/NAME/` (in `$XDG_CONFIG_HOME`
+where that is set), holding its `party.toml` of the options above, its record (`record`),
+and, where given there, its key (`key`); `record` and `key` in `party.toml`, or on the
+command line, win over those. `--federation NAME` chooses one; where there is only one,
+the client uses it without being told, and where there are several, it asks which.
+`init --federation NAME` begins one, its `party.toml` holding the options given with it
+(`node`, `token`, `key`, the key's path made absolute), readable by its owner alone:
+
+```sh
+continuum-party --federation krebs --node http://tv:secret@localhost:3000 \
+ --key tv.key init tv --root root
+continuum-party vote 8d02 yes # krebs, the only one
+```
+
`key` is an OpenSSH private key file, or a public key an ssh-agent holds: the key itself
(`key = "ecdsa-sha2-nistp256 AAAA…"`), or a file of such lines, whose first signs
([`guides/federation/keys.md`](guides/federation/keys.md),
diff --git a/docs/guides/federation/getting-started.md b/docs/guides/federation/getting-started.md
index 003d56e..fb4c791 100644
--- a/docs/guides/federation/getting-started.md
+++ b/docs/guides/federation/getting-started.md
@@ -119,9 +119,10 @@ continuum-party --node http://tv:secret@localhost:3000 --key tv.key --record tv.
```
The value is JSON. The client's options can go in a configuration file instead, as the
-node's do ([`configuration.md`](../../configuration.md),
-[The party's client](../../configuration.md#the-partys-client)):
-`continuum-party --config tv.toml write …`.
+node's do, and a federation's directory keeps them, with the record, so that a party
+names them once, when it begins its record (`init --federation NAME`), and never again
+([`configuration.md`](../../configuration.md),
+[The party's client](../../configuration.md#the-partys-client)).
lass reads it on its node, with everything else that counts: