diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/snac.1 | 9 | ||||
| -rw-r--r-- | doc/snac.5 | 7 | ||||
| -rw-r--r-- | doc/snac.8 | 40 |
3 files changed, 54 insertions, 2 deletions
@@ -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 @@ -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 @@ -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 @@ -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 , |