aboutsummaryrefslogtreecommitdiff
path: root/doc/snac.8
diff options
context:
space:
mode:
authorltning <ltning@noreply.codeberg.org>2025-01-27 18:07:00 +0000
committerltning <ltning@noreply.codeberg.org>2025-01-27 18:07:00 +0000
commitf6044d3aa0241a832b0ad1d2c394c0a1b814dbe3 (patch)
tree72334e7a24b997957d201490681552b6b1ad2e2f /doc/snac.8
parent4528029dabb7d79cddefaa5677ae314e16ab51f4 (diff)
parent5d267968cb0d2670f8a4bd7587e505f812dfa3bc (diff)
Merge branch 'master' into master
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
.Ic X-Forwarded-For
HTTP header (unless you use the FastCGI interface; if that's the case, you don't have
to do anything).
+.Pp
+.Ss Subscribing to Fediverse Relays
+Since version 2.69, a
+.Nm
+instance can subscribe to LitePub (Pleroma-style) Fediverse Relays. Doing this improves
+visibility and allows following hashtags. To do this, you must create a special user named
+relay and, from it, follow the relay actor(s) like you do with regular actor URLs. This
+special user will start receiving boosts from the relay server of posts from other instances
+also following it. If any other user of the same
+.Nm
+instance follows any of the hashtags included in these boosted posts coming from the relay,
+they will be received as if they were for them.
+.Pp
+Example:
+.Bd -literal -offset indent
+snac adduser $SNAC_BASEDIR relay # only needed once
+snac follow $SNAC_BASEDIR relay https://relay.example.com/actor
+.Ed
+.Pp
+Users on your instance do NOT need to follow the local relay user to benefit from following
+hashtags.
+.Pp
+Please take note that subscribing to relays can increase the traffic towards your instance
+significantly. In any case, lowering the "Maximum days to keep posts" value for the relay
+special user is recommended (e.g. setting to just 1 day).
.Sh ENVIRONMENT
.Bl -tag -width Ds
.It Ev DEBUG
@@ -685,6 +710,12 @@ location /share {
proxy_set_header Host $http_host;
proxy_set_header X-Forwarded-For $remote_addr;
}
+# optional (Mastodon-like "authorize interaction" entrypoint)
+location /authorize_interaction {
+ proxy_pass http://localhost:8001;
+ proxy_set_header Host $http_host;
+ proxy_set_header X-Forwarded-For $remote_addr;
+}
.Ed
.Pp
Restart the nginx daemon and connect to
@@ -738,6 +769,11 @@ ProxyPreserveHost On
<Location /share>
ProxyPass http://127.0.0.1:8001/share
</Location>
+
+# optional (Mastodon-like "authorize interaction" entrypoint)
+<Location /authorize_interaction>
+ ProxyPass http://127.0.0.1:8001/share
+</Location>
.Ed
.Pp
Since version 2.43,
@@ -797,6 +833,10 @@ location "/.well-known/host-meta" {
location "/share" {
fastcgi socket tcp "127.0.0.1" 8001
}
+
+location "/authorize_interaction" {
+ fastcgi socket tcp "127.0.0.1" 8001
+}
.Ed
.Sh SEE ALSO
.Xr snac 1 ,