Browse Source

Updated documentation.

default 3 months ago
parent
commit
a80b15e478
1 changed files with 21 additions and 0 deletions
  1. 21 0
      doc/snac.8

+ 21 - 0
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