summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar default2023-04-12 11:54:42 +0200
committerGravatar default2023-04-12 11:54:42 +0200
commit7fecec134f878964e02cc156e04855ba5cfe9708 (patch)
tree46fbb0f4c8cc998e48889a7f6ec7e8cdbf9da63d
parentUpdated README. (diff)
downloadsnac2-7fecec134f878964e02cc156e04855ba5cfe9708.tar.gz
snac2-7fecec134f878964e02cc156e04855ba5cfe9708.tar.xz
snac2-7fecec134f878964e02cc156e04855ba5cfe9708.zip
Updated documentation.
-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
205environment variable will be invoked to prepare a message; if 205environment variable will be invoked to prepare a message; if
206it's - (a lonely hyphen), the post content will be read from stdin. 206it's - (a lonely hyphen), the post content will be read from stdin.
207.El 207.El
208.Ss Migrating from Mastodon 208.Ss Migrating an account from Mastodon
209See 209See
210.Xr snac 8 210.Xr snac 8
211for details. 211for details.
212.Ss Using Mastodon-compatible apps
213Since version 2.27,
214.Nm
215includes support for the Mastodon API, so you can use Mastodon-compatible
216mobile and desktop applications to access your account. Given a correctly
217configured server, the usage of these programs should be straightforward.
218Please take note that they will show your timeline in a 'Mastodon fashion'
219(i.e., as a plain list of posts), so you will lose the fancy, nested thread
220post display with the most active threads at the top that the web interface of
221.Nm
222provides.
212.Sh ENVIRONMENT 223.Sh ENVIRONMENT
213.Bl -tag -width Ds 224.Bl -tag -width Ds
214.It Ev DEBUG 225.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
331Edit the nginx configuration and add the following snippet to the 331Edit the nginx configuration and add the following snippet to the
332example.com server section: 332example.com server section:
333.Bd -literal -offset indent 333.Bd -literal -offset indent
334# main web access point
335location /fedi {
336 proxy_pass http://localhost:8001;
337 proxy_set_header Host $http_host;
338}
339# webfinger
334location /.well-known/webfinger { 340location /.well-known/webfinger {
335 proxy_pass http://localhost:8001; 341 proxy_pass http://localhost:8001;
336 proxy_set_header Host $http_host; 342 proxy_set_header Host $http_host;
337} 343}
338 344# Mastodon API (entry point)
339# optional 345location /api/v1/ {
340location /.well-known/nodeinfo {
341 proxy_pass http://localhost:8001; 346 proxy_pass http://localhost:8001;
342 proxy_set_header Host $http_host; 347 proxy_set_header Host $http_host;
343} 348}
344 349# Mastodon API (OAuth support)
345location /fedi { 350location /oauth {
346 proxy_pass http://localhost:8001; 351 proxy_pass http://localhost:8001;
347 proxy_set_header Host $http_host; 352 proxy_set_header Host $http_host;
348} 353}
354# optional
355location /.well-known/nodeinfo {
356 proxy_pass http://localhost:8001;
357 proxy_set_header Host $http_host;
358}
359
349.Ed 360.Ed
350.Pp 361.Pp
351Restart the nginx daemon and connect to https://example.com/fedi/walter. 362Restart the nginx daemon and connect to https://example.com/fedi/walter.