mirror of
https://github.com/spacebarchat/docs.git
synced 2024-11-10 04:12:32 +01:00
🎨 restructure
This commit is contained in:
parent
71fe9f42a4
commit
785468ae7e
5
docs/api/index.md
Normal file
5
docs/api/index.md
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
# API
|
||||||
|
|
||||||
|
## [Encryption](encryption/)
|
||||||
|
|
||||||
|
## [Routes](routes/)
|
5
docs/client/index.md
Normal file
5
docs/client/index.md
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
# Client
|
||||||
|
|
||||||
|
## [Plugins](plugins/)
|
||||||
|
|
||||||
|
## [Themes](themes/)
|
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
Follow the server [setup guide](/setup) to setup the development environment
|
Accept the [code of conduct](/contributing/) and follow the server [setup guide](/setup) to setup the development environment.
|
||||||
|
|
||||||
## Gateway
|
## Gateway
|
||||||
|
|
||||||
|
@ -4,11 +4,6 @@
|
|||||||
|
|
||||||
Fosscord is a free open source selfhostable discord compatible chat, voice and video platform
|
Fosscord is a free open source selfhostable discord compatible chat, voice and video platform
|
||||||
|
|
||||||
### Why the name Fosscord?
|
|
||||||
|
|
||||||
Fosscord is a combination of the abbreviation FOSS (**F**ree **O**pen **S**ource
|
|
||||||
**S**oftware) and the name Dis**cord**.
|
|
||||||
|
|
||||||
## Philosophy
|
## Philosophy
|
||||||
|
|
||||||
Fosscord aims to be a full one-on-one clone of Discord, adding more features
|
Fosscord aims to be a full one-on-one clone of Discord, adding more features
|
||||||
|
@ -6,15 +6,15 @@
|
|||||||
- [GitHub](https://github.com/fosscord/) (GitHub organization)
|
- [GitHub](https://github.com/fosscord/) (GitHub organization)
|
||||||
- [OpenCollective](https://opencollective.com/fosscord) (Financially support the project to cover server costs and other expenses)
|
- [OpenCollective](https://opencollective.com/fosscord) (Financially support the project to cover server costs and other expenses)
|
||||||
- [Discord server](https://discord.gg/ZrnGQP6p3d) (for support & organization (If we are finished we'll host our own support server))
|
- [Discord server](https://discord.gg/ZrnGQP6p3d) (for support & organization (If we are finished we'll host our own support server))
|
||||||
- [Tor Hidden Service](http://7jexqzsbqndcsh6y7hybtaf5us5vt7mya7hi4fbi2tid6zazno3h44qd.onion/) (Better privacy for TOR users)
|
- [Tor Hidden Service](http://7jexqzsbqndcsh6y7hybtaf5us5vt7mya7hi4fbi2tid6zazno3h44qd.onion/) (Official Fosscord instance on TOR)
|
||||||
|
|
||||||
## Project structure
|
## Project structure
|
||||||
|
|
||||||
Fosscord consists of many repositories, which together make up the client and the server:
|
Fosscord consists of many repositories, which together make up the client and server:
|
||||||
|
|
||||||
### Server
|
### Server
|
||||||
|
|
||||||
- **[fosscord-server](https://github.com/fosscord/fosscord-api) is the complete Fosscord Server**
|
- **[fosscord-server](https://github.com/fosscord/fosscord-api) is the complete Fosscord Server** and it
|
||||||
|
|
||||||
Contains:
|
Contains:
|
||||||
|
|
||||||
|
@ -1,6 +1,26 @@
|
|||||||
# Bots
|
# Bots
|
||||||
|
|
||||||
Fosscord is backwards compatible to discord, which means you can reuse your existing discord bot library and only need to change the api endpoints.
|
Fosscord is backwards compatible to discord, which means you can reuse your existing discord bot library and only need to change the api endpoints.
|
||||||
|
|
||||||
Currently the bot dashboard is still in development and not yet finished. Until then you can use regular user accounts.
|
Currently the bot dashboard is still in development and not yet finished. Until then you can use regular user accounts.
|
||||||
To get the user token, open the instance in your browser and enable DevTools (hit ``F12`` or ``Right click on the page -> Inspect``).
|
|
||||||
Logout, register a new account and navigate to the network tab inside of the DevTools. (image coming soon)
|
## Retrieve the user token:
|
||||||
Enable the xhr/fetch request filter and click on any api request and copy the ``Authorization`` header.
|
|
||||||
|
1. Open the instance in your browser
|
||||||
|
2. Logout of your current account
|
||||||
|
3. Enable DevTools (hit `F12` or `Right click on the page -> Inspect`).
|
||||||
|
4. Register a new account
|
||||||
|
5. Open the network tab inside of DevTools
|
||||||
|
6. Enable the xhr/fetch request filter
|
||||||
|
7. Click on any (api) request and then
|
||||||
|
8. Inside of "Request Headers" copy the value of the `authorization` header.
|
||||||
|
|
||||||
|
**Done**: You now can use this token to login with your bot libary or authorize any api request by putting it inside the authorization header.
|
||||||
|
|
||||||
|
**Notice**: Currently you can but don't need to prefix the token with "`Bot `"
|
||||||
|
|
||||||
|
## Libraries
|
||||||
|
|
||||||
|
### Discord.js
|
||||||
|
|
||||||
|
### Discord.py
|
||||||
|
5
docs/setup/index.md
Normal file
5
docs/setup/index.md
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
# Setup
|
||||||
|
|
||||||
|
## [Bots](bots/)
|
||||||
|
|
||||||
|
## [Server](server/)
|
@ -1,4 +1,4 @@
|
|||||||
# Setup Server
|
# Server
|
||||||
|
|
||||||
## [Download](https://github.com/fosscord/fosscord-server/releases)
|
## [Download](https://github.com/fosscord/fosscord-server/releases)
|
||||||
|
|
||||||
@ -31,6 +31,7 @@ npm run start:bundle
|
|||||||
You can now access it on [http://localhost:3001](http://localhost:3001)
|
You can now access it on [http://localhost:3001](http://localhost:3001)
|
||||||
|
|
||||||
To update it run (notice will discard all changed files):
|
To update it run (notice will discard all changed files):
|
||||||
|
|
||||||
```
|
```
|
||||||
git reset --hard HEAD
|
git reset --hard HEAD
|
||||||
git pull
|
git pull
|
||||||
|
@ -3,6 +3,7 @@ repo_url: https://github.com/fosscord/fosscord
|
|||||||
edit_uri: https://github.com/fosscord/fosscord-docs/edit/master/docs/
|
edit_uri: https://github.com/fosscord/fosscord-docs/edit/master/docs/
|
||||||
site_description: Documentation of Fosscord a free open source selfhostable chat, voice and video discord-compatible platform
|
site_description: Documentation of Fosscord a free open source selfhostable chat, voice and video discord-compatible platform
|
||||||
plugins:
|
plugins:
|
||||||
|
- section-index
|
||||||
- search
|
- search
|
||||||
- render_swagger
|
- render_swagger
|
||||||
theme:
|
theme:
|
||||||
|
Loading…
Reference in New Issue
Block a user