mirror of
https://github.com/spacebarchat/spacebarchat.git
synced 2024-11-25 03:43:31 +01:00
.. | ||
instances.json | ||
README.md |
Add your instance
By adding your Spacebar instance to our list, it will show up on our website.
How to
- Make sure your instance is in line with our rules and guidelines.
- Click here to edit the instances.json file and add your instance to it. Make sure to follow the example below.
{
"name": "Very nice chat",
"url": "https://myinstance.tld",
"description": "My cool Spacebar instance",
"image": "https://myinstance.tld/logo.png",
"display": true,
"verified": false,
"country": "uk",
"language": "en"
}
- Create a PR with your changes.
Data Structure
Required
- name: the name of your instance;
- url: the url of your instance's homepage. it doesn't need to be the webclient URL and it can be a simple landing page, but that's up to you;
- description: some words describing your instance.;
Optional
- image: the url for your instance's logo. (default undefined);
- display: should your instance be showing up on our website or you want it to be hidden? (default true);
- verified: if your instance should be shown as an official verified spacebar instance. (SHOULD ALWAYS BE false - it will only change if spacebar team decides you are worth of this honor);
- country: what is the country of your instance? fill in according to the ISO 8166-2 alpha-2
- language: what is the primary language of your instance? fill in according to the ISO 639-1
How to be an officially verified server
This has not been discussed yet - at this moment, only Spacebar's main instance will be officially verified. Discussions on this topic are open.