diff options
| author | 2023-04-12 11:54:42 +0200 | |
|---|---|---|
| committer | 2023-04-12 11:54:42 +0200 | |
| commit | 7fecec134f878964e02cc156e04855ba5cfe9708 (patch) | |
| tree | 46fbb0f4c8cc998e48889a7f6ec7e8cdbf9da63d | |
| parent | Updated README. (diff) | |
| download | snac2-7fecec134f878964e02cc156e04855ba5cfe9708.tar.gz snac2-7fecec134f878964e02cc156e04855ba5cfe9708.tar.xz snac2-7fecec134f878964e02cc156e04855ba5cfe9708.zip | |
Updated documentation.
| -rw-r--r-- | doc/snac.1 | 13 | ||||
| -rw-r--r-- | doc/snac.8 | 21 |
2 files changed, 28 insertions, 6 deletions
| @@ -205,10 +205,21 @@ argument is -e, the external editor defined by the EDITOR | |||
| 205 | environment variable will be invoked to prepare a message; if | 205 | environment variable will be invoked to prepare a message; if |
| 206 | it's - (a lonely hyphen), the post content will be read from stdin. | 206 | it'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 |
| 209 | See | 209 | See |
| 210 | .Xr snac 8 | 210 | .Xr snac 8 |
| 211 | for details. | 211 | for details. |
| 212 | .Ss Using Mastodon-compatible apps | ||
| 213 | Since version 2.27, | ||
| 214 | .Nm | ||
| 215 | includes support for the Mastodon API, so you can use Mastodon-compatible | ||
| 216 | mobile and desktop applications to access your account. Given a correctly | ||
| 217 | configured server, the usage of these programs should be straightforward. | ||
| 218 | Please 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 | ||
| 220 | post display with the most active threads at the top that the web interface of | ||
| 221 | .Nm | ||
| 222 | provides. | ||
| 212 | .Sh ENVIRONMENT | 223 | .Sh ENVIRONMENT |
| 213 | .Bl -tag -width Ds | 224 | .Bl -tag -width Ds |
| 214 | .It Ev DEBUG | 225 | .It Ev DEBUG |
| @@ -331,21 +331,32 @@ snac httpd /home/snacusr/fedidata | |||
| 331 | Edit the nginx configuration and add the following snippet to the | 331 | Edit the nginx configuration and add the following snippet to the |
| 332 | example.com server section: | 332 | example.com server section: |
| 333 | .Bd -literal -offset indent | 333 | .Bd -literal -offset indent |
| 334 | # main web access point | ||
| 335 | location /fedi { | ||
| 336 | proxy_pass http://localhost:8001; | ||
| 337 | proxy_set_header Host $http_host; | ||
| 338 | } | ||
| 339 | # webfinger | ||
| 334 | location /.well-known/webfinger { | 340 | location /.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 | 345 | location /api/v1/ { |
| 340 | location /.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) | |
| 345 | location /fedi { | 350 | location /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 | ||
| 355 | location /.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 |
| 351 | Restart the nginx daemon and connect to https://example.com/fedi/walter. | 362 | Restart the nginx daemon and connect to https://example.com/fedi/walter. |