aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-17 16:18:58 +0000
committertv <tv@krebsco.de>2026-11-17 17:36:10 +0100
commit7fc844ff0167fb0943e3fa85af671d8f3bbf005d (patch)
treeea7a759bfdfbd1705b64f6a1083ae42d9c84515c /docs
parente9b1ea18694c88abe1e31f8236f8d8beb6362be9 (diff)
continuum-party: options from configuration files, as the node's
`continuum-party` takes its options (`node`, `token`, `key`, `record`: `config::PARTY_OPTIONS`) on the command line and in configuration files of the node's format: `--config`, repeatable, arguments winning, `--unset`, includes and imports. The configuration's loader takes the options it reads as a table (`config::with_options`, `config::merged`, `file::load_with`), the node's or the client's, and a key naming none of them is an error in either; `node` and `token` are secrets, never logged.
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.md19
-rw-r--r--docs/guides/federation/getting-started.md6
2 files changed, 24 insertions, 1 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index d3f7e56..d246082 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -238,3 +238,22 @@ placeholders is shown as written instead.
```sh
continuum --config /etc/continuum.toml --print-config | jq .options.seeds
```
+
+## The party's client
+
+`continuum-party` (with the `federation` feature) takes its options, `node`, `token`,
+`key` and `record`, the same ways: on the command line, and in configuration files of
+the same format (`--config`, repeatable, later files winning, arguments winning over
+them; `--unset`; includes and imports), whose keys are those options alone:
+
+```toml
+node = "http://tv:${file:/run/secrets/tv-password}@localhost:3000"
+key = "/home/tv/.config/continuum/tv.key"
+record = "/home/tv/.config/continuum/tv.record"
+```
+
+```sh
+continuum-party --config tv.toml write home/tv/motd '"hello"'
+```
+
+`node` and `token` are secrets: never logged, however they are given.
diff --git a/docs/guides/federation/getting-started.md b/docs/guides/federation/getting-started.md
index 8ce4c19..5d46192 100644
--- a/docs/guides/federation/getting-started.md
+++ b/docs/guides/federation/getting-started.md
@@ -114,7 +114,11 @@ continuum-party --node http://tv:secret@localhost:3000 --key tv.key --record tv.
# 3a9f… taken
```
-The value is JSON. lass reads it on its node, with everything else that counts:
+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):
+`continuum-party --config tv.toml write …`.
+
+lass reads it on its node, with everything else that counts:
```sh
curl -s -u lass:secret localhost:3000/events/counts | jq .values