aboutsummaryrefslogtreecommitdiffstats
path: root/docs/example.toml
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-19 20:06:05 +0000
committertv <tv@krebsco.de>2026-11-19 21:26:49 +0100
commitfc6c7101cdb42666c1f79df4206029c7cf7e61c6 (patch)
treeb9a2f088aedcafa762d552cada23eba134f9e849 /docs/example.toml
parentd93f574d14a2e52a1d7dfd1e256f70c6eb9644ef (diff)
federated nodes: users who read the federation alone (--store-readers)
On a federated node, every user its htpasswd or proxy lets in may do everything: put events, have it drop what it took, vote through it with its party's key, make fork roots, read the document. An application or someone watching needn't act for the node. `--store-readers USER,...` names users who read the federation and do nothing else (`api::access::federated`, before the registry's checks): GET and HEAD of the events API (/events and below), checking a fork (POST /events/fork), and keeping a session (whoami, refresh, logout); anything else is 403, saying so. Its other users are its operators, as all were: a node setting nothing changes nothing.
Diffstat (limited to 'docs/example.toml')
-rw-r--r--docs/example.toml5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/example.toml b/docs/example.toml
index d318d53..6a6f7b3 100644
--- a/docs/example.toml
+++ b/docs/example.toml
@@ -143,6 +143,11 @@ htpasswd = "/etc/continuum/htpasswd"
# sync with the nodes its parties list, each as its party's, and with no others.
# store-party = "tv"
+# Behind the `federation` feature, with store-root or store-id: users of this node's
+# HTTP API who read the federation here and do nothing else (GET of the events API, and
+# fork checks). The node's other users are its operators, who may do everything.
+# store-readers = ["monitor"]
+
# Behind the `federation` feature, with store-root or store-id: parties among whose
# members, with those of its own party, this node keeps some of its neighbours, so that a
# party listing many nodes can't be all of them.