aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/example.toml5
-rw-r--r--docs/guides/federation/running-a-node.md12
2 files changed, 13 insertions, 4 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.
diff --git a/docs/guides/federation/running-a-node.md b/docs/guides/federation/running-a-node.md
index 94781d4..e08a47e 100644
--- a/docs/guides/federation/running-a-node.md
+++ b/docs/guides/federation/running-a-node.md
@@ -63,10 +63,14 @@ alone, so that a party listing many nodes can't be all of a node's neighbours.
## Its API
* **Who it lets in** is its own (`--htpasswd`, or a reverse proxy naming the user):
- there is no user registry, and every user it lets in may do everything at it: put
- events, read, have it drop what it took and take it back, vote through it, make a
- fork's root. A token is taken by the node that issued it only. Let in those who act
- for the node, and give a party without nodes of its own a user to put its events.
+ there is no user registry. Its users are its operators, and may do everything at it:
+ put events, read, have it drop what it took and take it back, vote through it, make a
+ fork's root. Those named in `--store-readers` read the federation and do nothing
+ else: `GET` of the events API below, and checking a fork (`POST /events/fork`), but
+ nothing of the document (`/store`, `/stream`), the node (`/peers`, `/admin/…`), nor
+ what an operator does to the store (`/admin/events/…`): for an application, or
+ someone watching, that needn't act for the node. A token is taken by the node that
+ issued it only, and gives what its user may do.
* **The events** (`docs/openapi.yaml`, Events): `GET /events` (the store's ID, its
checkpoint, its heads, how many events it took, the node's party, and whether it votes
for it by itself), `POST /events` (an event, whoever signed it), `GET /events/{id}`,