1
0
mirror of https://github.com/spacebarchat/spacebarchat.git synced 2024-11-08 11:42:39 +01:00
spacebarchat/instances
2023-08-14 22:03:20 +10:00
..
instances.json Move community-instances here 2023-08-14 22:00:48 +10:00
README.md Update README.md 2023-08-14 22:03:20 +10:00

Add your instance

By adding your Spacebar instance to our list, it will show up on our website.

How to

  1. Make sure your instance is in line with our rules and guidelines.
  2. 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"
}
  1. 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.