summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar default2025-01-19 17:32:24 +0100
committerGravatar default2025-01-19 17:32:24 +0100
commita80b15e478e303feaddb5d357502896f3d53dff8 (patch)
tree90b9411e275fe93d918c8b176f96c9997fbde8c6
parentUpdated RELEASE_NOTES. (diff)
downloadpenes-snac2-a80b15e478e303feaddb5d357502896f3d53dff8.tar.gz
penes-snac2-a80b15e478e303feaddb5d357502896f3d53dff8.tar.xz
penes-snac2-a80b15e478e303feaddb5d357502896f3d53dff8.zip
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
583.Ic X-Forwarded-For 583.Ic X-Forwarded-For
584HTTP header (unless you use the FastCGI interface; if that's the case, you don't have 584HTTP header (unless you use the FastCGI interface; if that's the case, you don't have
585to do anything). 585to do anything).
586.Pp
587.Ss Subscribing to Fediverse Relays
588Since version 2.69, a
589.Nm
590instance can subscribe to LitePub (Pleroma-style) Fediverse Relays. Doing this improves
591visibility and allows following hashtags. To do this, you must create a special user named
592relay and, from it, follow the relay actor(s) like you do with regular actor URLs. This
593special user will start receiving boosts from the relay server of posts from other instances
594also following it. It any other user of the same
595.Nm
596instance follows any of the hashtags included in these boosted posts coming from the relay,
597they will received as if they were for them.
598.Pp
599Example:
600.Bd -literal -offset indent
601snac adduser $SNAC_BASEDIR relay # only needed once
602snac follow $SNAC_BASEDIR relay https://fedi-relay.gyptazy.com/actor
603.Ed
604.Pp
605Lowering the data retention time for this special user is recommended, as the amount of
606received posts can be big.
586.Sh ENVIRONMENT 607.Sh ENVIRONMENT
587.Bl -tag -width Ds 608.Bl -tag -width Ds
588.It Ev DEBUG 609.It Ev DEBUG