example.toml: keep-actor

With the other options of the document file: what it does, what it saves (a writer per
node and per crash or drop, rather than per start), and what it must not meet: two
nodes started from copies of one document file, or a node from an older copy of its
own, which would write as the same actor.

1 files changed, 9 insertions, 0 deletions

diff --git a/docs/example.toml b/docs/example.toml
index 9eeee20..77b9c09 100644
--- a/docs/example.toml
+++ b/docs/example.toml
@@ -222,6 +222,15 @@ htpasswd = "/etc/continuum/htpasswd"
 # outgrew its full save (a new epoch or a restart rewrites it at once).
 # document-rewrite = "1h"
 
+# Resume writing as the actor this node wrote with before it stopped, if it stopped
+# cleanly (its document file holds everything it wrote then), instead of a fresh one:
+# an epoch then gathers a writer per node and per crash or drop rather than per start,
+# and every transfer of its history carries a signature per writer. Never start two
+# nodes from copies of one document file, nor a node from an older copy of its own (a
+# restored backup, a rolled-back disk): both would write as the same actor. Needs
+# document-file.
+# keep-actor = false
+
 # --- Timings and sizes -------------------------------------------------------------------
 # Durations: seconds (30, 0.5) or with units (500ms, 30s, 1m, 1h30m, 7d).
 # Sizes: bytes or with units (64KiB, 4MiB).