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

Prettier!

Browse Source
This commit is contained in:
Madeline 2023-04-08 15:00:42 +10:00
parent 433fb7af96
commit a8a86e8bbf
No known key found for this signature in database
GPG Key ID: 80D25DA3BCB24281
18 changed files with 262 additions and 266 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
.vscode/settings.json vendored
View File

@ -1,8 +1,3 @@
{
"cSpell.words": [
"landingpage",
"Middlewares",
"Roadmap",
"screenshare"
]
"cSpell.words": ["landingpage", "Middlewares", "Roadmap", "screenshare"]
}

2
docs/contributing/instances.md
View File

@ -8,7 +8,7 @@ Your instance:
1. Rules must be in line with our [Code of Conduct](conduct.md).
2. Must not contain any Discord Inc. branding, such as including "cord" in the name or the Discord logo in promotional material.
3. Must not host the Discord Inc. client in any capacity.
4. Must be moderated for *at least* publically accessible guilds. This includes guilds accessible from Discovery or a 'guild directory' channel in an auto join guild.
4. Must be moderated for _at least_ publically accessible guilds. This includes guilds accessible from Discovery or a 'guild directory' channel in an auto join guild.
5. Must have at least regular uptime, meaning it is available at a consistent time of day.
6. Must have a valid and monitored [`general_correspondenceEmail` config](/setup/server/configuration) set.
7. must not have default [rights](/setup/server/security/rights) that include operator or other administrative rights.

1
docs/contributing/server/migrations.md
View File

@ -20,6 +20,7 @@ To generate a database migration in {{ project.name.lower() }}-server:
where `:dbms:` is the db you use, and `:migrationName:` is whatever you wish to call it.
The migration must be named a valid Javascript class name.
3. The generated file is what TypeORM will do if you were to run `npm run sync:db`.
Obviously, this is not always what you want. Edit it to preserve as much of the original data as possible.

14
docs/setup/clients/index.md
View File

@ -14,13 +14,13 @@ or you can use it to connect to your own by editing your local storage to includ
```json
{
"api":"https://staging.{{ project.domain }}/api/v9",
"cdn":"https://cdn.staging.{{ project.domain }}",
"gateway":"wss://gateway.staging.{{ project.domain }}",
"invite":"https://staging.{{ project.domain }}/invite",
"template":"https://staging.{{ project.domain }}/template",
"gift":"https://staging.{{ project.domain }}/gift",
"scheduledEvent":"https://staging.{{ project.domain }}/events"
"api": "https://staging.{{ project.domain }}/api/v9",
"cdn": "https://cdn.staging.{{ project.domain }}",
"gateway": "wss://gateway.staging.{{ project.domain }}",
"invite": "https://staging.{{ project.domain }}/invite",
"template": "https://staging.{{ project.domain }}/template",
"gift": "https://staging.{{ project.domain }}/gift",
"scheduledEvent": "https://staging.{{ project.domain }}/events"
}
```

2
docs/setup/server/configuration/env.md
View File

@ -5,7 +5,7 @@ You can set environment variables easily by creating an `.env` file
in the `{{ project.name.lower() }}-server` folder, with the format `NAME=VALUE` with each on new lines.
| Name | Value | Description |
| -------------------------- | -------------- | -------------------------------------------------------------------------------------------------------------------- |
| ---------------- | -------------- | -------------------------------------------------------------------------------------------------------------------------- |
| THREADS | number | Number of threads to run {{ project.name }} on when using bundle. Make sure you've enabled RabbitMQ if using more than one |
| PORT | number | Port to listen on. Used by all components, including bundle. If using bundle, all components run under the same port |
| DATABASE | string | Database connection string. Defaults to SQlite3 at project root |

2
docs/setup/server/configuration/index.md
View File

@ -20,7 +20,7 @@ Arrays are represented by \_[number] in a config key. For example, multiple `gui
## Available Configuration Options
| key | default | type | description |
| -------------------------------------------------- | -------------------------------------------------------- | ---------------------------------------- | --------------------------------------------------------------------- |
| -------------------------------------------------- | ------------------------------------------------------------------ | ---------------------------------------- | --------------------------------------------------------------------- |
| gateway_endpointPrivate | null | string | Used for internal communication with gateway |
| gateway_endpointPublic | null | string | Publicly announced gateway endpoint |
| cdn_endpointPrivate | <http://localhost:3001> | string | See gateway_endpointPrivate |