summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar ltning2025-01-27 18:07:00 +0000
committerGravatar ltning2025-01-27 18:07:00 +0000
commitf6044d3aa0241a832b0ad1d2c394c0a1b814dbe3 (patch)
tree72334e7a24b997957d201490681552b6b1ad2e2f /doc
parentAdd short_description_raw option (diff)
parentFixed crash in the notification area after deleting a post. (diff)
downloadsnac2-f6044d3aa0241a832b0ad1d2c394c0a1b814dbe3.tar.gz
snac2-f6044d3aa0241a832b0ad1d2c394c0a1b814dbe3.tar.xz
snac2-f6044d3aa0241a832b0ad1d2c394c0a1b814dbe3.zip
Merge branch 'master' into master
Diffstat (limited to 'doc')
-rw-r--r--doc/snac.19
-rw-r--r--doc/snac.57
-rw-r--r--doc/snac.840
3 files changed, 54 insertions, 2 deletions
diff --git a/doc/snac.1 b/doc/snac.1
index 71dcf4a..d33bccb 100644
--- a/doc/snac.1
+++ b/doc/snac.1
@@ -256,7 +256,7 @@ it's - (a lonely hyphen), the post content will be read from stdin.
256The rest of command line arguments are treated as media files to be 256The rest of command line arguments are treated as media files to be
257attached to the post. 257attached to the post.
258.It Cm note_unlisted Ar basedir Ar uid Ar text Op file file ... 258.It Cm note_unlisted Ar basedir Ar uid Ar text Op file file ...
259Like the previous one, but creates an "unlisted" (or "quiet public") one. 259Like the previous one, but creates an "unlisted" (or "quiet public") post.
260.It Cm block Ar basedir Ar instance_url 260.It Cm block Ar basedir Ar instance_url
261Blocks a full instance, given its URL or domain name. All subsequent 261Blocks a full instance, given its URL or domain name. All subsequent
262incoming activities with identifiers from that instance will be immediately 262incoming activities with identifiers from that instance will be immediately
@@ -377,6 +377,13 @@ https://$SNAC_HOST/oauth/x-snac-get-token
377.Pp 377.Pp
378.Sh ENVIRONMENT 378.Sh ENVIRONMENT
379.Bl -tag -width Ds 379.Bl -tag -width Ds
380.It SNAC_BASEDIR
381This optional environment variable can be set to the base directory of
382your installation; if set, you don't have to add the base directory as an
383argument to command-line operations. This may prove useful if you only
384have one
385.Nm
386instance in you system (which is probably your case).
380.It Ev DEBUG 387.It Ev DEBUG
381Overrides the debugging level from the server 'dbglevel' configuration 388Overrides the debugging level from the server 'dbglevel' configuration
382variable. Set it to an integer value. The higher, the deeper in meaningless 389variable. Set it to an integer value. The higher, the deeper in meaningless
diff --git a/doc/snac.5 b/doc/snac.5
index be7bfd7..3550995 100644
--- a/doc/snac.5
+++ b/doc/snac.5
@@ -24,9 +24,11 @@ A special subset of Markdown is allowed, including:
24.It bold 24.It bold
25**text between two pairs of asterisks** 25**text between two pairs of asterisks**
26.It italic 26.It italic
27*text between a pair of asterisks* 27*text between a pair of asterisks* or _between a pair of underscores_
28.It strikethrough text 28.It strikethrough text
29~~text between a pair of tildes~~ 29~~text between a pair of tildes~~
30.It underlined text
31__text between two pairs of underscores__
30.It code 32.It code
31Text `between backticks` is formatted as code. 33Text `between backticks` is formatted as code.
32.Bd -literal 34.Bd -literal
@@ -53,6 +55,9 @@ Horizonal rules can be inserted by typing three minus symbols
53alone in a line. 55alone in a line.
54.It quoted text 56.It quoted text
55Lines starting with >. 57Lines starting with >.
58.It headers
59One, two or three # at the beginning of a line plus a space plus
60some text are converted to HTML headers.
56.It user mentions 61.It user mentions
57Strings in the format @user@host are requested using the Webfinger 62Strings in the format @user@host are requested using the Webfinger
58protocol and converted to links and mentions if something reasonable 63protocol and converted to links and mentions if something reasonable
diff --git a/doc/snac.8 b/doc/snac.8
index c44a891..e9b33dd 100644
--- a/doc/snac.8
+++ b/doc/snac.8
@@ -585,6 +585,31 @@ to pass the remote connection address in the
585.Ic X-Forwarded-For 585.Ic X-Forwarded-For
586HTTP header (unless you use the FastCGI interface; if that's the case, you don't have 586HTTP header (unless you use the FastCGI interface; if that's the case, you don't have
587to do anything). 587to do anything).
588.Pp
589.Ss Subscribing to Fediverse Relays
590Since version 2.69, a
591.Nm
592instance can subscribe to LitePub (Pleroma-style) Fediverse Relays. Doing this improves
593visibility and allows following hashtags. To do this, you must create a special user named
594relay and, from it, follow the relay actor(s) like you do with regular actor URLs. This
595special user will start receiving boosts from the relay server of posts from other instances
596also following it. If any other user of the same
597.Nm
598instance follows any of the hashtags included in these boosted posts coming from the relay,
599they will be received as if they were for them.
600.Pp
601Example:
602.Bd -literal -offset indent
603snac adduser $SNAC_BASEDIR relay # only needed once
604snac follow $SNAC_BASEDIR relay https://relay.example.com/actor
605.Ed
606.Pp
607Users on your instance do NOT need to follow the local relay user to benefit from following
608hashtags.
609.Pp
610Please take note that subscribing to relays can increase the traffic towards your instance
611significantly. In any case, lowering the "Maximum days to keep posts" value for the relay
612special user is recommended (e.g. setting to just 1 day).
588.Sh ENVIRONMENT 613.Sh ENVIRONMENT
589.Bl -tag -width Ds 614.Bl -tag -width Ds
590.It Ev DEBUG 615.It Ev DEBUG
@@ -685,6 +710,12 @@ location /share {
685 proxy_set_header Host $http_host; 710 proxy_set_header Host $http_host;
686 proxy_set_header X-Forwarded-For $remote_addr; 711 proxy_set_header X-Forwarded-For $remote_addr;
687} 712}
713# optional (Mastodon-like "authorize interaction" entrypoint)
714location /authorize_interaction {
715 proxy_pass http://localhost:8001;
716 proxy_set_header Host $http_host;
717 proxy_set_header X-Forwarded-For $remote_addr;
718}
688.Ed 719.Ed
689.Pp 720.Pp
690Restart the nginx daemon and connect to 721Restart the nginx daemon and connect to
@@ -738,6 +769,11 @@ ProxyPreserveHost On
738<Location /share> 769<Location /share>
739 ProxyPass http://127.0.0.1:8001/share 770 ProxyPass http://127.0.0.1:8001/share
740</Location> 771</Location>
772
773# optional (Mastodon-like "authorize interaction" entrypoint)
774<Location /authorize_interaction>
775 ProxyPass http://127.0.0.1:8001/share
776</Location>
741.Ed 777.Ed
742.Pp 778.Pp
743Since version 2.43, 779Since version 2.43,
@@ -797,6 +833,10 @@ location "/.well-known/host-meta" {
797location "/share" { 833location "/share" {
798 fastcgi socket tcp "127.0.0.1" 8001 834 fastcgi socket tcp "127.0.0.1" 8001
799} 835}
836
837location "/authorize_interaction" {
838 fastcgi socket tcp "127.0.0.1" 8001
839}
800.Ed 840.Ed
801.Sh SEE ALSO 841.Sh SEE ALSO
802.Xr snac 1 , 842.Xr snac 1 ,