summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authordefault <nobody@localhost>2023-04-12 11:54:42 +0200
committerdefault <nobody@localhost>2023-04-12 11:54:42 +0200
commit7fecec134f878964e02cc156e04855ba5cfe9708 (patch)
tree46fbb0f4c8cc998e48889a7f6ec7e8cdbf9da63d /doc
parent168e1ceab9795ddfe5857a7c4ba110857771c1c6 (diff)
Updated documentation.
Diffstat (limited to 'doc')
-rw-r--r--doc/snac.113
-rw-r--r--doc/snac.821
2 files changed, 28 insertions, 6 deletions
diff --git a/doc/snac.1 b/doc/snac.1
index 92fbeff..ec8df64 100644
--- a/doc/snac.1
+++ b/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
diff --git a/doc/snac.8 b/doc/snac.8
index a9c1487..3174097 100644
--- a/doc/snac.8
+++ b/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.