1
0
mirror of https://github.com/spacebarchat/docs.git synced 2024-11-22 18:22:31 +01:00

Add notes for using the official host

This commit is contained in:
Madeline 2023-03-19 22:03:49 +11:00
parent ef009b6aca
commit 24378b8adc
No known key found for this signature in database
GPG Key ID: 1958E017C36F2E47
3 changed files with 27 additions and 12 deletions

View File

@ -5,11 +5,6 @@
As described in [Clients](/setup/clients), the official client is not ready yet. You are free to use As described in [Clients](/setup/clients), the official client is not ready yet. You are free to use
a Fosscord compatible client to connect, but no support will be provided. a Fosscord compatible client to connect, but no support will be provided.
??? info "I am getting the error 'Cannot GET /', how fix?"
If you see that error message, it means that your server is configured correctly. Hooray!
Unfortunately, our official client isn't done yet (see question above).
??? info "Voice/Video when?" ??? info "Voice/Video when?"
Currently there is no voice or video support in any Fosscord instance. Currently there is no voice or video support in any Fosscord instance.

View File

@ -2,18 +2,38 @@
!!! note "The Fosscord client is, at the time of writing this (March 17th, 2023), under heavy development and not ready to be used in production just yet." !!! note "The Fosscord client is, at the time of writing this (March 17th, 2023), under heavy development and not ready to be used in production just yet."
!!! note "Windows support is currently broken." !!! warning "Windows support is currently broken."
The official Fosscord client is currently being developed at [this repository](https://github.com/fosscord/fosscord-client/tree/dev/bare-rewrite). The official Fosscord client is currently being developed at [this repository](https://github.com/fosscord/fosscord-client/tree/dev/bare-rewrite).
## Dependencies ## Official host
We currently host the client at [https://app.fosscord.com](https://app.fosscord.com).
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:
```json
{
"api":"https://staging.fosscord.com/api/v9",
"cdn":"https://cdn.staging.fosscord.com",
"gateway":"wss://gateway.staging.fosscord.com",
"invite":"https://staging.fosscord.com/invite",
"template":"https://staging.fosscord.com/template",
"gift":"https://staging.fosscord.com/gift",
"scheduledEvent":"https://staging.fosscord.com/events"
}
```
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.
## Setup/Building
### Dependencies
- [Git](https://git-scm.com/) - [Git](https://git-scm.com/)
- [NodeJS](https://nodejs.org). Version 16+ - [NodeJS](https://nodejs.org). Version 16+
- [yarn](https://yarnpkg.com/) (preferred) or npm - [yarn](https://yarnpkg.com/) (preferred) or npm
## Setup/Building
In your terminal: In your terminal:
```bash ```bash
@ -53,7 +73,7 @@ yarn start
yarn windows yarn windows
``` ```
To build static files for the web, run To build static files for the web (i.e. when hosting it yourself), run
```bash ```bash
yarn build:web yarn build:web
@ -74,4 +94,4 @@ To contribute:
- "Core" features like settings, editing messages, dms, markdown rendering, etc. What do you think are basic features that you would want? Some of the GitHub Issues apply to this. - "Core" features like settings, editing messages, dms, markdown rendering, etc. What do you think are basic features that you would want? Some of the GitHub Issues apply to this.
- Implementing other things like voice/video is fine too, though - Implementing other things like voice/video is fine too, though
- [This](https://github.com/fosscord/fosscord-client/issues/21) is a good starting point and lists all things that are still missing from the client. - [This](https://github.com/fosscord/fosscord-client/issues/21) is a good starting point and lists the core features that are still missing from the client.

View File

@ -3,7 +3,7 @@
'Staging' refers to [this branch](https://github.com/fosscord/fosscord-server/tree/staging) of fosscord-server, 'Staging' refers to [this branch](https://github.com/fosscord/fosscord-server/tree/staging) of fosscord-server,
which is deprecated in favour of [the refactor branch](https://github.com/fosscord/fosscord-server/tree/maddy/refactor) (if this is a 404, its just become the main branch now). which is deprecated in favour of [the refactor branch](https://github.com/fosscord/fosscord-server/tree/maddy/refactor) (if this is a 404, its just become the main branch now).
!!! warn "If you were using SQLite, you will be unable to migrate to the new version. SQLite is primarily for testing and development purposes, and it should not be used for production." !!! warning "If you were using SQLite, you will be unable to migrate to the new version. SQLite is primarily for testing and development purposes, and it should not be used for production."
To migrate from Staging: To migrate from Staging: