aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordefault <nobody@localhost>2025-01-19 17:32:24 +0100
committerdefault <nobody@localhost>2025-01-19 17:32:24 +0100
commita80b15e478e303feaddb5d357502896f3d53dff8 (patch)
tree90b9411e275fe93d918c8b176f96c9997fbde8c6
parent9be32a3061f20add0f159e2e9c805754aa4ecaf5 (diff)
Updated documentation.
-rw-r--r--doc/snac.821
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/snac.8 b/doc/snac.8
index 3c36f7b..141fa27 100644
--- a/doc/snac.8
+++ b/doc/snac.8
@@ -583,6 +583,27 @@ 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. It any other user of the same
+.Nm
+instance follows any of the hashtags included in these boosted posts coming from the relay,
+they will 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://fedi-relay.gyptazy.com/actor
+.Ed
+.Pp
+Lowering the data retention time for this special user is recommended, as the amount of
+received posts can be big.
.Sh ENVIRONMENT
.Bl -tag -width Ds
.It Ev DEBUG