spacebarchat / docs Goto Github PK

View Code? Open in Web Editor NEW

42.0 42.0 51.0 11 MB

Docs for Spacebar

Home Page: https://docs.spacebar.chat

License: Other

instant-messaging mkdocs mkdocs-material real-time-communication spacebarchat

docs's Introduction

Spacebar

About

Spacebar is a free, opensource selfhostable discord-compatible chat, voice and video platform.

Discord-compatible (Use all your custom clients/bots with minimal changes)
Selfhostable (Server)
Open Source (GitHub Organization)
Configurable (Configure every aspect and limits to your needs)
Decentralized (no abuse of power and doesn't have a single point of failure)
Extendable (secure and cross-platform plugin system)
Themeable (cross-platform theme system with design editor)
Secure (publicly audited and hosted FOSS software for transparent foundation in terms of security)

Logo by @ItsRealmy. Original logo by @nwlandas.

Usage and Support

You can find setup guides and lots of other information in our Documentation
For any kind of support regarding Spacebar, feel free to ask questions in our Discord guild.

Repositories

Repo name	Brief description
Server	Spacebar API + Gateway + CDN Server + WebRTC + Admin Dashboard
Client	Spacebar Client compatible with Spacebar-server and discord.com
Docs	Documentation of Spacebar
Landing page	Our Homepage

Contribute

This project is only possible by volunteers like you your contribution is very much appreciated.
You can find information about how to contribute here.
We also mark issues as "Good first issues" if you're looking for things to get you started.

License

Copyright (C) 2021-2024 Spacebar and Spacebar Contributors This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation version 3 of the License

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/agpl-3.0.de.html

docs's People

Contributors

Stargazers

Watchers

docs's Issues

Falsely named pip package in readme

material-mkdocs --> mkdocs-material

api docs: mark which routes are spacebar-only

May use something like this https://rapidocweb.com/examples/badges.html#overview
I.e. purple routes are spacebar only, blue is discord only.

spacebarchat/missing-routes/issues/1

Formalise the threat model analysis

Missing CDN/Gateway information

https://docs.fosscord.com/contributing/
Does Not contain:
How to setup the CDN
How to setup the Gateway

.env is "outdated" if you use MongoDB compass to enter the endpoints in the Database (Which port and ws/http information missing)

rights docs should mention that they are separate from guild member permissions

Consistent branding

The fosscord icon and theme color was changed a while ago. I believe the docs page should reflect the changes too.

"allows vanity urls" in guild features docs incorrect. Simply a marker for whether the guild has a vanity url

Add an FAQ answer about whether Spacebar is federated

Is your feature request related to a problem? Please describe.
I cannot tell if I can chat with users registered on other Spacebar instances without testing it myself.

Describe the solution you'd like
Adding an FAQ section called "is Spacebar federated?" or something similar.

Describe alternatives you've considered
N/A

Additional context
Interoperability is an important feature when self-hosting is involved to avoid creating user "bubbles" and overwhelming free instance hosters.

Contribution guide

How to create a new route
How our schema/openapi stuff works
How to send gateway events and what not to send (i.e. whole user obj vs PublicUser)
How to set up a dev server and connect to it (hmmm cough cough?)
How the server infra works? API and gateway communication for example. Maybe even future plans for gateway (guild nodes)
How to write embed handlers? (for more sites)
How to edit database models? Perhaps some gotchas with typeorm?
How to add/use Config?

Server repo is cloned as "server", docs assume something else

H3cJP#1817 on Discord pointed out, that the server repo is being cloned into "server/". The docs tell you to cd into "spacebar-server/" though, which doesn't exist.