Browse Source

Updated documentation.

default 2 years ago
parent
commit
7fecec134f
2 changed files with 28 additions and 6 deletions
  1. 12 1
      doc/snac.1
  2. 16 5
      doc/snac.8

+ 12 - 1
doc/snac.1

@@ -205,10 +205,21 @@ argument is -e,  the external editor defined by the EDITOR
 environment variable will be invoked to prepare a message; if
 it's - (a lonely hyphen), the post content will be read from stdin.
 .El
-.Ss Migrating from Mastodon
+.Ss Migrating an account from Mastodon
 See 
 .Xr snac 8
 for details.
+.Ss Using Mastodon-compatible apps
+Since version 2.27,
+.Nm
+includes support for the Mastodon API, so you can use Mastodon-compatible
+mobile and desktop applications to access your account. Given a correctly
+configured server, the usage of these programs should be straightforward.
+Please take note that they will show your timeline in a 'Mastodon fashion'
+(i.e., as a plain list of posts), so you will lose the fancy, nested thread
+post display with the most active threads at the top that the web interface of
+.Nm
+provides.
 .Sh ENVIRONMENT
 .Bl -tag -width Ds
 .It Ev DEBUG

+ 16 - 5
doc/snac.8

@@ -331,21 +331,32 @@ snac httpd /home/snacusr/fedidata
 Edit the nginx configuration and add the following snippet to the
 example.com server section:
 .Bd -literal -offset indent
+# main web access point
+location /fedi {
+    proxy_pass http://localhost:8001;
+    proxy_set_header Host $http_host;
+}
+# webfinger
 location /.well-known/webfinger {
     proxy_pass http://localhost:8001;
     proxy_set_header Host $http_host;
 }
-
-# optional
-location /.well-known/nodeinfo {
+# Mastodon API (entry point)
+location /api/v1/ {
     proxy_pass http://localhost:8001;
     proxy_set_header Host $http_host;
 }
-
-location /fedi {
+# Mastodon API (OAuth support)
+location /oauth {
     proxy_pass http://localhost:8001;
     proxy_set_header Host $http_host;
 }
+# optional
+location /.well-known/nodeinfo {
+    proxy_pass http://localhost:8001;
+    proxy_set_header Host $http_host;
+}
+
 .Ed
 .Pp
 Restart the nginx daemon and connect to https://example.com/fedi/walter.