1
0
mirror of https://github.com/spacebarchat/docs.git synced 2024-11-25 03:33:05 +01:00

Merge branch 'master' of github.com:spacebarchat/docs

This commit is contained in:
Madeline 2023-06-14 23:53:29 +10:00
commit cae4c91d11
No known key found for this signature in database
GPG Key ID: 1958E017C36F2E47
6 changed files with 23 additions and 10 deletions

View File

@ -19,8 +19,13 @@ document
const json = await res.json();
const missingRoutes = json.routes;
document.getElementById("counter").innerHTML = `We implement ${json.discord - json.missing}/${json.discord} endpoints from Discord.com ` +
`as well as ${(json.spacebar + json.missing) - json.discord} additional endpoints.`;
document.getElementById("counter").innerHTML =
`We implement ${json.discord - json.missing}/${
json.discord
} endpoints from Discord.com ` +
`as well as ${
json.spacebar + json.missing - json.discord
} additional endpoints.`;
for (let route of missingRoutes) {
const elem = document.createElement("li");

View File

@ -22,4 +22,4 @@ We recommend (not required) that you:
- 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.
If doing so, use this domain as the `url` field in your community instances PR.

View File

@ -8,9 +8,12 @@ The official {{ project.name }} client is currently being developed at [this rep
## Official host
We currently host the client at [https://app.{{ project.domain }}](https://app.{{ project.domain }}).
You can use it to connect to our official instance by default,
or you can use it to connect to your own by editing your local storage to include the `routeSettings` key with the below example content:
The new, React-only client is being hosted at [https://dev.app.{{ project.domain }}](https://dev.app.{{ project.domain }}).
An older, React Native version of the client can be found at
[https://app.{{ project.domain }}](https://app.{{ project.domain }}).
You can use it to connect to our official instance by default, or you can use it to connect to your
own instance by editing your local storage to include the `routeSettings` key with the below example
content:
```json
{
@ -25,10 +28,14 @@ or you can use it to connect to your own by editing your local storage to includ
```
Replace the above endpoints with your own. If your domain name is `https://whatever.notasite`, then you'll most likely want to enter
`https://whatever.noasite/api/v9` for the API endpoint, etc.
`https://whatever.notasite/api/v9` for the API endpoint, etc.
If you're using the React Native client, you can also edit these settings by visiting [https://app.{{ project.domain }}/settings](https://app.{{ project.domain }}/settings).
## Setup/Building
These Instructions refer to the old, React Native client, and therefore do not apply to the new, React-only client.
### Dependencies
- [Git](https://git-scm.com/)

View File

@ -88,7 +88,7 @@ Arrays are represented by \_[number] in a config key. For example, multiple `gui
| security_twoFactor_generateBackupCodes | true | boolean | Whether to generate backup codes for MFA users |
| security_requestSignature | Secret secret | string | The signature required for CDN or [Imagor](imagor.md) usage |
| security_jwtSecret | Secure secret | string | The secret used for user token generation |
| [security_forwadedFor](../reverseProxy.md) | null | string | HTTP header for user's real IP. |
| [security_forwardedFor](../reverseProxy.md) | null | string | HTTP header for user's real IP. |
| security_ipdataApiKey | {{ project.name }} IPdata key | string | API key used for IP geolocation and proxy detection |
| security_mfaBackupCodeCount | 10 | number | Number of MFA backup codes to generate |
| security_statsWorldReadable | true | boolean | Whether instance stats are publically accessible or require right |

View File

@ -14,7 +14,7 @@ We do not recommend using Windows to run {{ project.name }}.
## Dependencies
- [Git](https://git-scm.com/)
- [NodeJS](https://nodejs.org). Version 16+ (for `npm`, `node` commands)
- [NodeJS](https://nodejs.org). Version 16+ (for `npm`, `node` commands)
- [Python](https://www.python.org/). Version 3+. Make sure this is executable via `python` in your terminal.
(See: `python-is-python3` package)
- On Linux: `gcc`/`g++`. Packaged with `build-essential` on Debian/Ubuntu and `base-devel` on Arch.

View File

@ -6,8 +6,9 @@ Users can enter a domain, e.g. `spacebar.chat` as shorthand, and their client wi
and from there the Gateway and CDN endpoints.
Example `/.well-known/spacebar` file:
```json
{
"api": "https://api.spacebar.chat/api/v9"
}
```
```