data.coop/pinafore
8
0
Fork 0
Code Issues 1 Pull requests Packages Projects Releases Wiki Activity

docs: improve docs in Admin guide (#1794)

Browse source 
[skip ci]
This commit is contained in:
Nolan Lawson 2020-05-30 12:55:20 -07:00 committed by GitHub
parent ec8e872f8d
commit 949fb5f8a4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/Admin-Guide.md
View file

@ -5,10 +5,11 @@ This guide is for instance admins who may be having trouble with Pinafore compat
By default, [Mastodon allows cross-origin access to the `/api` endpoint](https://github.com/tootsuite/mastodon/blob/50529cbceb84e611bca497624a7a4c38113e5135/config/initializers/cors.rb#L15-L20). Thus Pinafore should "just work" for most Mastodon servers. By default, [Mastodon allows cross-origin access to the `/api` endpoint](https://github.com/tootsuite/mastodon/blob/50529cbceb84e611bca497624a7a4c38113e5135/config/initializers/cors.rb#L15-L20). Thus Pinafore should "just work" for most Mastodon servers.
If the nginx/Apache settings have been changed, though, then Pinafore might not be able to connect to an instance. To check if the instance is supported, run this command: If the nginx/Apache settings have been changed, though, then Pinafore might not be able to connect to an instance. To check if the instance is supported, run this command (replacing `myinstance.com` with your instance URL):
```bash ```bash
curl -sLv example.com/api/v1/instance -o /dev/null curl -sLv -H 'Origin: https://pinafore.social' -o /dev/null \
myinstance.com/api/v1/instance
``` ```
If you see this in the output: If you see this in the output:
@ -19,7 +20,7 @@ Access-Control-Allow-Origin: *
Then Pinafore should work as expected! Then Pinafore should work as expected!
Otherwise, if the instance admin would like to whitelist only certain websites (including Pinafore) to work with CORS, then they will need to make sure that the server echoes: Otherwise, if the instance admin would like to whitelist only certain websites (including Pinafore) to work with CORS, then they will need to make sure that the server echoes:
``` ```
Access-Control-Allow-Origin: https://pinafore.social Access-Control-Allow-Origin: https://pinafore.social