diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/snac.1 | 5 | ||||
| -rw-r--r-- | doc/snac.8 | 26 |
2 files changed, 31 insertions, 0 deletions
@@ -145,6 +145,11 @@ Initializes the database. This is an interactive command; necessary information will be prompted for. The .Ar basedir directory must not exist. +.It Cm upgrade Ar basedir +Upgrades the database disk layout after installing a new version. +Only necessary if +.Nm +complains and demands it. .It Cm purge Ar basedir Purges old data from the timeline of all users. .It Cm adduser Ar basedir Op uid @@ -14,6 +14,19 @@ This is the admin manual. For user operation, see .Xr snac 1 . For file and data formats, see .Xr snac 5 . +.Ss Special cares about your snac you must know beforehand +.Nm +makes heavy use of hard links and link reference counts for its work, so +don't even think of using it on a filesystem that doesn't support this +feature. Most UNIX-like operating systems (Linux, the BSDs, the old DEC +Ultrix machine in your grandfather basement, probably MacOS) support hard +links on their native filesystems. Don't do fancy things like moving the +subdirectories to different filesystems. Also, if you move your +.Nm +installation to another server, do it with a tool that respect hard +link counts. Remember: +.Nm +is a very UNIXy program that loves hard links. .Ss Building and Installation A C compiler must be installed in the system, as well as the development headers and libraries for OpenSSL and curl. To build @@ -69,6 +82,19 @@ startup scripts and configuration data in the directory. For other operating systems, please read the appropriate documentation on how to install a daemon as a non-root service. +.Ss Upgrading to a new version +Sometimes, the database disk layout changes between versions. If there +is such a change, +.Nm +will refuse to run and require an upgrade. Do this by running +.Bd -literal -offset indent +snac upgrade $HOME/snac-data +.Ed +Take special care to execute this upgrade operation without any +.Nm +processes serving on the same folder. You can break everything. I know +this because Tyler knows this. +.Pp .Ss Server Setup .Pp An http server with TLS and proxying support must already be |