summaryrefslogtreecommitdiff
path: root/doc/snac.8
diff options
context:
space:
mode:
Diffstat (limited to 'doc/snac.8')
-rw-r--r--doc/snac.840
1 files changed, 40 insertions, 0 deletions
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 ,