From b2bd4e18b9d7691cfae7be3e5e08a0c00ff4ac0e Mon Sep 17 00:00:00 2001
From: default
Date: Tue, 7 Jan 2025 03:28:53 +0100
Subject: Updated documentation.

---
 doc/snac.1 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'doc')

diff --git a/doc/snac.1 b/doc/snac.1
index 71dcf4a..7611600 100644
--- a/doc/snac.1
+++ b/doc/snac.1
@@ -256,7 +256,7 @@ it's - (a lonely hyphen), the post content will be read from stdin.
 The rest of command line arguments are treated as media files to be
 attached to the post.
 .It Cm note_unlisted Ar basedir Ar uid Ar text Op file file ...
-Like the previous one, but creates an "unlisted" (or "quiet public") one.
+Like the previous one, but creates an "unlisted" (or "quiet public") post.
 .It Cm block Ar basedir Ar instance_url
 Blocks a full instance, given its URL or domain name. All subsequent
 incoming activities with identifiers from that instance will be immediately
-- 
cgit v1.2.3


From 9de9295837b6b7536be4d9b621d41fd1c22bd750 Mon Sep 17 00:00:00 2001
From: default
Date: Thu, 16 Jan 2025 14:21:54 +0100
Subject: Updated documentation.

---
 doc/snac.8 | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

(limited to 'doc')

diff --git a/doc/snac.8 b/doc/snac.8
index 3a4bfcf..3c36f7b 100644
--- a/doc/snac.8
+++ b/doc/snac.8
@@ -683,6 +683,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
@@ -736,6 +742,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,
@@ -795,6 +806,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 ,
-- 
cgit v1.2.3


From a80b15e478e303feaddb5d357502896f3d53dff8 Mon Sep 17 00:00:00 2001
From: default
Date: Sun, 19 Jan 2025 17:32:24 +0100
Subject: Updated documentation.

---
 doc/snac.8 | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

(limited to 'doc')

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
-- 
cgit v1.2.3


From e56e30f0c64f12ea12413aaf4229975543e1bdbf Mon Sep 17 00:00:00 2001
From: default
Date: Mon, 20 Jan 2025 10:13:06 +0100
Subject: Updated documentation.

---
 doc/snac.8 | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'doc')

diff --git a/doc/snac.8 b/doc/snac.8
index 141fa27..c0e1af5 100644
--- a/doc/snac.8
+++ b/doc/snac.8
@@ -602,8 +602,9 @@ 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.
+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
-- 
cgit v1.2.3


From fbc5015dc4f7b8fbc5901022b3252b5edbcf6ebf Mon Sep 17 00:00:00 2001
From: default
Date: Mon, 20 Jan 2025 10:47:23 +0100
Subject: Documented the SNAC_BASEDIR environment variable.

---
 doc/snac.1 | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'doc')

diff --git a/doc/snac.1 b/doc/snac.1
index 7611600..d33bccb 100644
--- a/doc/snac.1
+++ b/doc/snac.1
@@ -377,6 +377,13 @@ https://$SNAC_HOST/oauth/x-snac-get-token
 .Pp
 .Sh ENVIRONMENT
 .Bl -tag -width Ds
+.It SNAC_BASEDIR
+This optional environment variable can be set to the base directory of
+your installation; if set, you don't have to add the base directory as an
+argument to command-line operations. This may prove useful if you only
+have one
+.Nm
+instance in you system (which is probably your case).
 .It Ev DEBUG
 Overrides the debugging level from the server 'dbglevel' configuration
 variable. Set it to an integer value. The higher, the deeper in meaningless
-- 
cgit v1.2.3


From 468b7a38885152cb2d61537abfdd9a4cda9c847a Mon Sep 17 00:00:00 2001
From: default
Date: Tue, 21 Jan 2025 14:39:49 +0100
Subject: Updated documentation.

---
 doc/snac.5 | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

(limited to 'doc')

diff --git a/doc/snac.5 b/doc/snac.5
index be7bfd7..3550995 100644
--- a/doc/snac.5
+++ b/doc/snac.5
@@ -24,9 +24,11 @@ A special subset of Markdown is allowed, including:
 .It bold
 **text between two pairs of asterisks**
 .It italic
-*text between a pair of asterisks*
+*text between a pair of asterisks* or _between a pair of underscores_
 .It strikethrough text
 ~~text between a pair of tildes~~
+.It underlined text
+__text between two pairs of underscores__
 .It code
 Text `between backticks` is formatted as code.
 .Bd -literal
@@ -53,6 +55,9 @@ Horizonal rules can be inserted by typing three minus symbols
 alone in a line.
 .It quoted text
 Lines starting with >.
+.It headers
+One, two or three # at the beginning of a line plus a space plus
+some text are converted to HTML headers.
 .It user mentions
 Strings in the format @user@host are requested using the Webfinger
 protocol and converted to links and mentions if something reasonable
-- 
cgit v1.2.3


From ced28f931928fac1ded3e435868c3ca204b9280b Mon Sep 17 00:00:00 2001
From: default
Date: Wed, 22 Jan 2025 15:31:20 +0100
Subject: Updated documentation.

---
 doc/snac.8 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'doc')

diff --git a/doc/snac.8 b/doc/snac.8
index c0e1af5..1ca5d4b 100644
--- a/doc/snac.8
+++ b/doc/snac.8
@@ -599,7 +599,7 @@ they will received as if they were for them.
 Example:
 .Bd -literal -offset indent
 snac adduser $SNAC_BASEDIR relay # only needed once
-snac follow $SNAC_BASEDIR relay https://fedi-relay.gyptazy.com/actor
+snac follow $SNAC_BASEDIR relay https://relay.example.com/actor
 .Ed
 .Pp
 Please take note that subscribing to relays can increase the traffic towards your instance
-- 
cgit v1.2.3


From 3f3419d8dbc810fe3ba8c8b1b33b7cb529900c61 Mon Sep 17 00:00:00 2001
From: default
Date: Fri, 24 Jan 2025 08:12:57 +0100
Subject: Updated documentation.

---
 doc/snac.8 | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

(limited to 'doc')

diff --git a/doc/snac.8 b/doc/snac.8
index 1ca5d4b..e228495 100644
--- a/doc/snac.8
+++ b/doc/snac.8
@@ -591,10 +591,10 @@ instance can subscribe to LitePub (Pleroma-style) Fediverse Relays. Doing this i
 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
+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 received as if they were for them.
+they will be received as if they were for them.
 .Pp
 Example:
 .Bd -literal -offset indent
@@ -602,6 +602,9 @@ 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).
-- 
cgit v1.2.3