diff options
| author | 2022-10-03 20:25:09 +0200 | |
|---|---|---|
| committer | 2022-10-03 20:25:09 +0200 | |
| commit | daaba2b52e999cb3ac3d8537614629b123410bd8 (patch) | |
| tree | 29fda826dcac9df45cb016ac90add47a747bd5c6 | |
| parent | Imported documentation from snac 1.x. (diff) | |
| download | penes-snac2-daaba2b52e999cb3ac3d8537614629b123410bd8.tar.gz penes-snac2-daaba2b52e999cb3ac3d8537614629b123410bd8.tar.xz penes-snac2-daaba2b52e999cb3ac3d8537614629b123410bd8.zip | |
Some documentation tweaks.
| -rw-r--r-- | doc/snac.5 | 5 | ||||
| -rw-r--r-- | doc/snac.8 | 17 |
2 files changed, 13 insertions, 9 deletions
| @@ -60,6 +60,8 @@ The base directory contains the following files and folders: | |||
| 60 | Server configuration. | 60 | Server configuration. |
| 61 | .It Pa user/ | 61 | .It Pa user/ |
| 62 | Directory holding user subdirectories. | 62 | Directory holding user subdirectories. |
| 63 | .It Pa archive/ | ||
| 64 | If this directory exists, all input and output messages are stored into. | ||
| 63 | .El | 65 | .El |
| 64 | .Pp | 66 | .Pp |
| 65 | Each user directory is a subdirectory of | 67 | Each user directory is a subdirectory of |
| @@ -117,8 +119,7 @@ web interface. | |||
| 117 | This directory contains generated HTML files. They may be snapshots of the | 119 | This directory contains generated HTML files. They may be snapshots of the |
| 118 | local timeline in previous months or other cached data. | 120 | local timeline in previous months or other cached data. |
| 119 | .It Pa archive/ | 121 | .It Pa archive/ |
| 120 | This directory stores all input/output traffic of ActivityPub messages. There | 122 | This directory is no longer used in version 2.x and later. It can be deleted. |
| 121 | is a different file for each day. This information is only stored if | ||
| 122 | .Nm | 123 | .Nm |
| 123 | is run with a debug level >= 1. | 124 | is run with a debug level >= 1. |
| 124 | .El | 125 | .El |
| @@ -14,8 +14,16 @@ 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 Installation | 17 | .Ss Building and Installation |
| 18 | Install the OpenSSL and urllib3 Python3 external packages, and run as root | 18 | A C compiler must be installed in the system, as well as the development |
| 19 | headers and libraries for OpenSSL and curl. To build | ||
| 20 | .Nm , | ||
| 21 | run | ||
| 22 | .Bd -literal -offset indent | ||
| 23 | make | ||
| 24 | .Ed | ||
| 25 | .Pp | ||
| 26 | And, after that, run as root | ||
| 19 | .Bd -literal -offset indent | 27 | .Bd -literal -offset indent |
| 20 | make install | 28 | make install |
| 21 | .Ed | 29 | .Ed |
| @@ -179,11 +187,6 @@ user's crontab: | |||
| 179 | 0 4 * * 0 /usr/local/bin/snac purge /path/to/snac-data | 187 | 0 4 * * 0 /usr/local/bin/snac purge /path/to/snac-data |
| 180 | .Ed | 188 | .Ed |
| 181 | .Pp | 189 | .Pp |
| 182 | Other directories, like | ||
| 183 | .Pa archive/ , | ||
| 184 | can grow very quickly if the debug level is greater than 0. These | ||
| 185 | files must be deleted manually. | ||
| 186 | .Pp | ||
| 187 | The user-generated data (the local timeline) is never deleted. | 190 | The user-generated data (the local timeline) is never deleted. |
| 188 | .Ss ActivityPub Support | 191 | .Ss ActivityPub Support |
| 189 | These are the following activities and objects that | 192 | These are the following activities and objects that |