summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar default2023-01-08 10:31:15 +0100
committerGravatar default2023-01-08 10:31:15 +0100
commiteb22dc5f0185cda733fa3dcdac15f15afdc2b8e9 (patch)
tree762c8949aaebee9661b8756d6026b47b90827968
parentMore work in check_signature() error archiving. (diff)
downloadsnac2-eb22dc5f0185cda733fa3dcdac15f15afdc2b8e9.tar.gz
snac2-eb22dc5f0185cda733fa3dcdac15f15afdc2b8e9.tar.xz
snac2-eb22dc5f0185cda733fa3dcdac15f15afdc2b8e9.zip
Updated documentation.
-rw-r--r--doc/snac.58
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/snac.5 b/doc/snac.5
index 0b58a2d..a09702d 100644
--- a/doc/snac.5
+++ b/doc/snac.5
@@ -63,8 +63,7 @@ span i b pre code em strong
63.Ed 63.Ed
64.Pp 64.Pp
65.Ss Disk Layout 65.Ss Disk Layout
66This section documents version 1 of the disk storage layout. It's still 66This section documents version 2.7 of the disk storage layout.
67subject to change.
68.Pp 67.Pp
69The base directory contains the following files and folders: 68The base directory contains the following files and folders:
70.Bl -tag -width tenletters 69.Bl -tag -width tenletters
@@ -79,6 +78,9 @@ of the hash.
79.It Pa archive/ 78.It Pa archive/
80If this directory exists, all input and output messages are logged inside it, 79If this directory exists, all input and output messages are logged inside it,
81including HTTP headers. Only useful for debugging. May grow to enormous sizes. 80including HTTP headers. Only useful for debugging. May grow to enormous sizes.
81.It Pa error/
82If this directory exists, HTTP signature check error headers are logged here.
83Only useful for debugging.
82.El 84.El
83.Pp 85.Pp
84Each user directory is a subdirectory of 86Each user directory is a subdirectory of
@@ -88,7 +90,7 @@ has the user id as name and contains the following subdirectories and files:
88.It Pa user.json 90.It Pa user.json
89User configuration file. 91User configuration file.
90.It Pa key.json 92.It Pa key.json
91SHA-1 secret/public key PEM data. 93Secret/public key PEM data.
92.It Pa followers.idx 94.It Pa followers.idx
93This file contains the list of followers as a list of hashed object identifiers. 95This file contains the list of followers as a list of hashed object identifiers.
94.It Pa followers/ 96.It Pa followers/