aboutsummaryrefslogtreecommitdiffstats
path: root/docs/guides
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guides')
-rw-r--r--docs/guides/federation/common-changes.md10
-rw-r--r--docs/guides/federation/keys.md17
-rw-r--r--docs/guides/federation/running-a-node.md2
-rw-r--r--docs/guides/federation/when-things-go-wrong.md4
4 files changed, 18 insertions, 15 deletions
diff --git a/docs/guides/federation/common-changes.md b/docs/guides/federation/common-changes.md
index 1f7f331..1dd30c1 100644
--- a/docs/guides/federation/common-changes.md
+++ b/docs/guides/federation/common-changes.md
@@ -86,8 +86,9 @@ jq --arg key "$(cut -d' ' -f1,2 tv-new.key.pub)" '
## What a party does by itself
-* **Its node list**, signed with a key its version names, no vote: the list whole, or the
- list as it counts at the node with nodes added (`--add`) or taken off (`--remove`):
+* **Its node list**, signed with a key its version names, no vote: the list as it counts
+ at the node with nodes added (`--add`) or taken off (`--remove`), or set whole
+ (`--set`); `nodes` alone shows it:
```sh
continuum-party --node http://tv:secret@localhost:3000 --key tv.key \
@@ -96,8 +97,9 @@ jq --arg key "$(cut -d' ' -f1,2 tv-new.key.pub)" '
# 9b2c… taken
```
- The client checks first that the current version names the key it signs with for the
- party, and says otherwise: then only a version naming the party's keys or its list
+ A list left empty, taking all of the party's nodes out of the swarm, is written with
+ `--force` only. The client checks first that the current version names the key it
+ signs with for the party, and says otherwise: then only a version naming the party's keys or its list
anew changes it, which a party proposes and the parties pass. A version names a
party's list anew only where it must: when the party is let in, or when it can't write
its own.
diff --git a/docs/guides/federation/keys.md b/docs/guides/federation/keys.md
index 6f9fc10..7f5bd7a 100644
--- a/docs/guides/federation/keys.md
+++ b/docs/guides/federation/keys.md
@@ -18,16 +18,17 @@ So keep the keys a version names apart, offline, on one machine with the party's
```sh
ssh-keygen -t ed25519 -N '' -f laptop.key
continuum-party --node http://tv:secret@localhost:3000 --key tv.key --record tv.record \
- keys "$(cat laptop.key.pub)" "$(cat desk.key.pub)"
+ keys --set "$(cat laptop.key.pub)" "$(cat desk.key.pub)"
continuum-party --node http://tv:secret@localhost:3000 --key laptop.key \
--record tv.record write home/tv/motd '"from the laptop"'
```
-Each key goes as one argument, an `authorized_keys` line; its comment is left out. With
-`--add` and `--remove` instead, the client writes the set as it counts at the node with
-those keys added or taken off (`keys --add "$(cat phone.pub)"`). A set holds up to 16
-keys, signed with a key the current version names for the party, which the client checks
-first. A node voting by itself keeps a key its version names on that
+Each key goes as one argument, an `authorized_keys` line; its comment is left out.
+`--set` writes the set whole; `--add` and `--remove` write it as it counts at the node,
+with those keys added or taken off (`keys --add "$(cat phone.pub)"`); `keys` alone shows
+it. A set left empty, so that none of the party's writes count, is written with
+`--force` only. A set holds up to 16 keys, signed with a key the current version names
+for the party, which the client checks first. A node voting by itself keeps a key its version names on that
node (`--store-vote-key`), an Ed25519 key in a file: one stolen there votes for the
party.
@@ -69,7 +70,7 @@ A write counts only while the key that signed it is among the party's keys: what
signed counts no more once the party's set drops it, wherever in history it is. So
before dropping a key, sign again with a new one what should stay:
-1. Write a set with the new keys beside the old.
+1. Add the new keys to the set, beside the old (`keys --add`).
2. Write again, with a new key, every value the party wants kept, on heads that hold that
set (the client signs on the heads its node shows). For a namespace:
@@ -82,7 +83,7 @@ before dropping a key, sign again with a new one what should stay:
done
```
-3. Write a set without the old keys.
+3. Take the old keys off the set (`keys --remove`).
A key added back, from a backup say, brings back what it signed, where nothing the party
signed since replaced it and no checkpoint left it out.
diff --git a/docs/guides/federation/running-a-node.md b/docs/guides/federation/running-a-node.md
index 371bd10..a423376 100644
--- a/docs/guides/federation/running-a-node.md
+++ b/docs/guides/federation/running-a-node.md
@@ -52,7 +52,7 @@ with it (`This node is a member of its store`). A party that takes a node off it
takes it out of the swarm.
A party writes its node list itself, without a vote, signed with a key its version names
-(`continuum-party nodes`,
+(`continuum-party nodes --add`,
[`common-changes.md`](common-changes.md#what-a-party-does-by-itself)): a node it adds
is a member as soon as the list is taken.
diff --git a/docs/guides/federation/when-things-go-wrong.md b/docs/guides/federation/when-things-go-wrong.md
index e4a3b81..de2e34a 100644
--- a/docs/guides/federation/when-things-go-wrong.md
+++ b/docs/guides/federation/when-things-go-wrong.md
@@ -71,8 +71,8 @@ record.
document (yet)`), or its document's root is no store's (`The document's root is no
store's: not reading it`).
* **Nobody syncs with it** (`This node isn't a member of its store`): its party's node
- list doesn't name it, as the store reads now. The party writes its list
- (`continuum-party nodes`), through any member.
+ list doesn't name it, as the store reads now. The party adds it to its list
+ (`continuum-party nodes --add`), through any member.
* **An event waits** (`waiting` when put): the node lacks an event it builds on. It
takes it once that one arrives.
* **It doesn't start**: its store file doesn't read, or an option of a swarm that isn't