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