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. | |||
| 256 | The rest of command line arguments are treated as media files to be | 256 | The rest of command line arguments are treated as media files to be |
| 257 | attached to the post. | 257 | attached to the post. |
| 258 | .It Cm note_unlisted Ar basedir Ar uid Ar text Op file file ... | 258 | .It Cm note_unlisted Ar basedir Ar uid Ar text Op file file ... |
| 259 | Like the previous one, but creates an "unlisted" (or "quiet public") one. | 259 | Like the previous one, but creates an "unlisted" (or "quiet public") post. |
| 260 | .It Cm block Ar basedir Ar instance_url | 260 | .It Cm block Ar basedir Ar instance_url |
| 261 | Blocks a full instance, given its URL or domain name. All subsequent | 261 | Blocks a full instance, given its URL or domain name. All subsequent |
| 262 | incoming activities with identifiers from that instance will be immediately | 262 | incoming activities with identifiers from that instance will be immediately |
| @@ -377,6 +377,13 @@ https://$SNAC_HOST/oauth/x-snac-get-token | |||
| 377 | .Pp | 377 | .Pp |
| 378 | .Sh ENVIRONMENT | 378 | .Sh ENVIRONMENT |
| 379 | .Bl -tag -width Ds | 379 | .Bl -tag -width Ds |
| 380 | .It SNAC_BASEDIR | ||
| 381 | This optional environment variable can be set to the base directory of | ||
| 382 | your installation; if set, you don't have to add the base directory as an | ||
| 383 | argument to command-line operations. This may prove useful if you only | ||
| 384 | have one | ||
| 385 | .Nm | ||
| 386 | instance in you system (which is probably your case). | ||
| 380 | .It Ev DEBUG | 387 | .It Ev DEBUG |
| 381 | Overrides the debugging level from the server 'dbglevel' configuration | 388 | Overrides the debugging level from the server 'dbglevel' configuration |
| 382 | variable. Set it to an integer value. The higher, the deeper in meaningless | 389 | 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: | |||
| 24 | .It bold | 24 | .It bold |
| 25 | **text between two pairs of asterisks** | 25 | **text between two pairs of asterisks** |
| 26 | .It italic | 26 | .It italic |
| 27 | *text between a pair of asterisks* | 27 | *text between a pair of asterisks* or _between a pair of underscores_ |
| 28 | .It strikethrough text | 28 | .It strikethrough text |
| 29 | ~~text between a pair of tildes~~ | 29 | ~~text between a pair of tildes~~ |
| 30 | .It underlined text | ||
| 31 | __text between two pairs of underscores__ | ||
| 30 | .It code | 32 | .It code |
| 31 | Text `between backticks` is formatted as code. | 33 | Text `between backticks` is formatted as code. |
| 32 | .Bd -literal | 34 | .Bd -literal |
| @@ -53,6 +55,9 @@ Horizonal rules can be inserted by typing three minus symbols | |||
| 53 | alone in a line. | 55 | alone in a line. |
| 54 | .It quoted text | 56 | .It quoted text |
| 55 | Lines starting with >. | 57 | Lines starting with >. |
| 58 | .It headers | ||
| 59 | One, two or three # at the beginning of a line plus a space plus | ||
| 60 | some text are converted to HTML headers. | ||
| 56 | .It user mentions | 61 | .It user mentions |
| 57 | Strings in the format @user@host are requested using the Webfinger | 62 | Strings in the format @user@host are requested using the Webfinger |
| 58 | protocol and converted to links and mentions if something reasonable | 63 | protocol and converted to links and mentions if something reasonable |
| @@ -585,6 +585,31 @@ to pass the remote connection address in the | |||
| 585 | .Ic X-Forwarded-For | 585 | .Ic X-Forwarded-For |
| 586 | HTTP header (unless you use the FastCGI interface; if that's the case, you don't have | 586 | HTTP header (unless you use the FastCGI interface; if that's the case, you don't have |
| 587 | to do anything). | 587 | to do anything). |
| 588 | .Pp | ||
| 589 | .Ss Subscribing to Fediverse Relays | ||
| 590 | Since version 2.69, a | ||
| 591 | .Nm | ||
| 592 | instance can subscribe to LitePub (Pleroma-style) Fediverse Relays. Doing this improves | ||
| 593 | visibility and allows following hashtags. To do this, you must create a special user named | ||
| 594 | relay and, from it, follow the relay actor(s) like you do with regular actor URLs. This | ||
| 595 | special user will start receiving boosts from the relay server of posts from other instances | ||
| 596 | also following it. If any other user of the same | ||
| 597 | .Nm | ||
| 598 | instance follows any of the hashtags included in these boosted posts coming from the relay, | ||
| 599 | they will be received as if they were for them. | ||
| 600 | .Pp | ||
| 601 | Example: | ||
| 602 | .Bd -literal -offset indent | ||
| 603 | snac adduser $SNAC_BASEDIR relay # only needed once | ||
| 604 | snac follow $SNAC_BASEDIR relay https://relay.example.com/actor | ||
| 605 | .Ed | ||
| 606 | .Pp | ||
| 607 | Users on your instance do NOT need to follow the local relay user to benefit from following | ||
| 608 | hashtags. | ||
| 609 | .Pp | ||
| 610 | Please take note that subscribing to relays can increase the traffic towards your instance | ||
| 611 | significantly. In any case, lowering the "Maximum days to keep posts" value for the relay | ||
| 612 | special user is recommended (e.g. setting to just 1 day). | ||
| 588 | .Sh ENVIRONMENT | 613 | .Sh ENVIRONMENT |
| 589 | .Bl -tag -width Ds | 614 | .Bl -tag -width Ds |
| 590 | .It Ev DEBUG | 615 | .It Ev DEBUG |
| @@ -685,6 +710,12 @@ location /share { | |||
| 685 | proxy_set_header Host $http_host; | 710 | proxy_set_header Host $http_host; |
| 686 | proxy_set_header X-Forwarded-For $remote_addr; | 711 | proxy_set_header X-Forwarded-For $remote_addr; |
| 687 | } | 712 | } |
| 713 | # optional (Mastodon-like "authorize interaction" entrypoint) | ||
| 714 | location /authorize_interaction { | ||
| 715 | proxy_pass http://localhost:8001; | ||
| 716 | proxy_set_header Host $http_host; | ||
| 717 | proxy_set_header X-Forwarded-For $remote_addr; | ||
| 718 | } | ||
| 688 | .Ed | 719 | .Ed |
| 689 | .Pp | 720 | .Pp |
| 690 | Restart the nginx daemon and connect to | 721 | Restart the nginx daemon and connect to |
| @@ -738,6 +769,11 @@ ProxyPreserveHost On | |||
| 738 | <Location /share> | 769 | <Location /share> |
| 739 | ProxyPass http://127.0.0.1:8001/share | 770 | ProxyPass http://127.0.0.1:8001/share |
| 740 | </Location> | 771 | </Location> |
| 772 | |||
| 773 | # optional (Mastodon-like "authorize interaction" entrypoint) | ||
| 774 | <Location /authorize_interaction> | ||
| 775 | ProxyPass http://127.0.0.1:8001/share | ||
| 776 | </Location> | ||
| 741 | .Ed | 777 | .Ed |
| 742 | .Pp | 778 | .Pp |
| 743 | Since version 2.43, | 779 | Since version 2.43, |
| @@ -797,6 +833,10 @@ location "/.well-known/host-meta" { | |||
| 797 | location "/share" { | 833 | location "/share" { |
| 798 | fastcgi socket tcp "127.0.0.1" 8001 | 834 | fastcgi socket tcp "127.0.0.1" 8001 |
| 799 | } | 835 | } |
| 836 | |||
| 837 | location "/authorize_interaction" { | ||
| 838 | fastcgi socket tcp "127.0.0.1" 8001 | ||
| 839 | } | ||
| 800 | .Ed | 840 | .Ed |
| 801 | .Sh SEE ALSO | 841 | .Sh SEE ALSO |
| 802 | .Xr snac 1 , | 842 | .Xr snac 1 , |