Spacebar/docs
1
0
Fork 0
mirror of https://github.com/spacebarchat/docs.git synced 2024-11-22 02:02:32 +01:00
Code Issues Releases Activity

well-known stuff

Browse Source
This commit is contained in:
Madeline 2023-05-12 22:57:34 +10:00
parent 0391b9f7a7
commit ef2c504a37
No known key found for this signature in database
GPG Key ID: 1958E017C36F2E47
2 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/contributing/instances.md
View File

@ -21,3 +21,5 @@ We recommend (not required) that you:
- Run your instance under [SystemD](/setup/server/systemd) or a similar system in your distro, for automatic restarting
- Provide some mechanism for users to report content. This may be as simple as more openly advertising your correspondence email (i.e. outside `GET /api/policies/instance` or `/api/ping`)
- Provide some mechanism for instance status, such as [Grafana](https://grafana.com/).
- Host a [`/.well-known/spacebar`](/setup/server/wellknown) file on the domain you wish users associate with your instance, e.g. `spacebar.chat`.
If doing so, use this domain as the `url` field in your community instances PR.

13
docs/setup/server/wellknown.md Normal file
View File

@ -0,0 +1,13 @@
# well-known
Instance owners may host a `/.well-known/spacebar` file on a domain containing the instance's API endpoint for Spacebar instance discovery.
Users can enter a domain, e.g. `spacebar.chat` as shorthand, and their client will query `https://spacebar.chat/.well-known/spacebar` for the instance API URL,
and from there the Gateway and CDN endpoints.
Example `/.well-known/spacebar` file:
```json
{
"api": "https://api.spacebar.chat/api/v9"
}
```