mirrors/snac2
3
0
Fork 0
mirror of https://codeberg.org/grunfink/snac2.git synced 2024-09-20 02:10:22 +03:00
Code Issues Packages Projects Releases Wiki Activity

Some documentation tweaks.

Browse Source
This commit is contained in:
default 2022-10-03 20:25:09 +02:00
parent 99c43fbc41
commit daaba2b52e
2 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/snac.5
View File

@ -60,6 +60,8 @@ The base directory contains the following files and folders:
Server configuration. Server configuration.
.It Pa user/ .It Pa user/
Directory holding user subdirectories. Directory holding user subdirectories.
.It Pa archive/
If this directory exists, all input and output messages are stored into.
.El .El
.Pp .Pp
Each user directory is a subdirectory of Each user directory is a subdirectory of
@ -117,8 +119,7 @@ web interface.
This directory contains generated HTML files. They may be snapshots of the This directory contains generated HTML files. They may be snapshots of the
local timeline in previous months or other cached data. local timeline in previous months or other cached data.
.It Pa archive/ .It Pa archive/
This directory stores all input/output traffic of ActivityPub messages. There This directory is no longer used in version 2.x and later. It can be deleted.
is a different file for each day. This information is only stored if
.Nm .Nm
is run with a debug level >= 1. is run with a debug level >= 1.
.El .El

17
doc/snac.8
View File

@ -14,8 +14,16 @@ This is the admin manual. For user operation, see
.Xr snac 1 . .Xr snac 1 .
For file and data formats, see For file and data formats, see
.Xr snac 5 . .Xr snac 5 .
.Ss Installation .Ss Building and Installation
Install the OpenSSL and urllib3 Python3 external packages, and run as root A C compiler must be installed in the system, as well as the development
headers and libraries for OpenSSL and curl. To build
.Nm ,
run
.Bd -literal -offset indent
make
.Ed
.Pp
And, after that, run as root
.Bd -literal -offset indent .Bd -literal -offset indent
make install make install
.Ed .Ed
@ -179,11 +187,6 @@ user's crontab:
0 4 * * 0 /usr/local/bin/snac purge /path/to/snac-data 0 4 * * 0 /usr/local/bin/snac purge /path/to/snac-data
.Ed .Ed
.Pp .Pp
Other directories, like
.Pa archive/ ,
can grow very quickly if the debug level is greater than 0. These
files must be deleted manually.
.Pp
The user-generated data (the local timeline) is never deleted. The user-generated data (the local timeline) is never deleted.
.Ss ActivityPub Support .Ss ActivityPub Support
These are the following activities and objects that These are the following activities and objects that