summaryrefslogtreecommitdiff
path: root/doc/snac.8
diff options
context:
space:
mode:
Diffstat (limited to 'doc/snac.8')
-rw-r--r--doc/snac.826
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/snac.8 b/doc/snac.8
index a241158..60671a1 100644
--- a/doc/snac.8
+++ b/doc/snac.8
@@ -14,6 +14,19 @@ This is the admin manual. For user operation, see
14.Xr snac 1 . 14.Xr snac 1 .
15For file and data formats, see 15For file and data formats, see
16.Xr snac 5 . 16.Xr snac 5 .
17.Ss Special cares about your snac you must know beforehand
18.Nm
19makes heavy use of hard links and link reference counts for its work, so
20don't even think of using it on a filesystem that doesn't support this
21feature. Most UNIX-like operating systems (Linux, the BSDs, the old DEC
22Ultrix machine in your grandfather basement, probably MacOS) support hard
23links on their native filesystems. Don't do fancy things like moving the
24subdirectories to different filesystems. Also, if you move your
25.Nm
26installation to another server, do it with a tool that respect hard
27link counts. Remember:
28.Nm
29is a very UNIXy program that loves hard links.
17.Ss Building and Installation 30.Ss Building and Installation
18A C compiler must be installed in the system, as well as the development 31A C compiler must be installed in the system, as well as the development
19headers and libraries for OpenSSL and curl. To build 32headers and libraries for OpenSSL and curl. To build
@@ -69,6 +82,19 @@ startup scripts and configuration data in the
69directory. 82directory.
70For other operating systems, please read the appropriate documentation 83For other operating systems, please read the appropriate documentation
71on how to install a daemon as a non-root service. 84on how to install a daemon as a non-root service.
85.Ss Upgrading to a new version
86Sometimes, the database disk layout changes between versions. If there
87is such a change,
88.Nm
89will refuse to run and require an upgrade. Do this by running
90.Bd -literal -offset indent
91snac upgrade $HOME/snac-data
92.Ed
93Take special care to execute this upgrade operation without any
94.Nm
95processes serving on the same folder. You can break everything. I know
96this because Tyler knows this.
97.Pp
72.Ss Server Setup 98.Ss Server Setup
73.Pp 99.Pp
74An http server with TLS and proxying support must already be 100An http server with TLS and proxying support must already be