commit de5345e

default  ·  2022-11-25 10:04:23 +0000 UTC
parent 1acfe8f
Updated documentation.
3 files changed,  +15, -1
M data.c
M data.c
+1, -1
1@@ -73,7 +73,7 @@ int srv_open(char *basedir, int auto_upgrade)
2                     ret = db_upgrade(&error);
3                 else {
4                     if (xs_number_get(xs_dict_get(srv_config, "layout")) < db_layout)
5-                        error = xs_fmt("ERROR: db layout changed - execute 'snac upgrade' first");
6+                        error = xs_fmt("ERROR: disk layout changed - execute 'snac upgrade' first");
7                     else
8                         ret = 1;
9                 }
+5, -0
 1@@ -145,6 +145,11 @@ Initializes the database. This is an interactive command; necessary
 2 information will be prompted for. The
 3 .Ar basedir
 4 directory must not exist.
 5+.It Cm upgrade Ar basedir
 6+Upgrades the database disk layout after installing a new version.
 7+Only necessary if
 8+.Nm
 9+complains and demands it.
10 .It Cm purge Ar basedir
11 Purges old data from the timeline of all users.
12 .It Cm adduser Ar basedir Op uid
+9, -0
 1@@ -69,6 +69,15 @@ startup scripts and configuration data in the
 2 directory.
 3 For other operating systems, please read the appropriate documentation
 4 on how to install a daemon as a non-root service.
 5+.Ss Upgrading to a new version
 6+Sometimes, the database disk layout changes between versions. If there
 7+is such a change,
 8+.Nm
 9+will refuse to run and require an upgrade. Do this by running
10+.Bd -literal -offset indent
11+snac upgrade $HOME/snac-data
12+.Ed
13+.Pp
14 .Ss Server Setup
15 .Pp
16 An http server with TLS and proxying support must already be