Skip to main content
The config.json file is the main configuration file for Sable. It controls homeserver settings, featured communities, routing behavior, and various UI features.

Location

The config.json file should be placed in the root directory of your Sable installation, alongside the index.html file.

Configuration Fields

Homeserver Settings

defaultHomeserver
number
default:"0"
Index of the default homeserver from the homeserverList array. Uses zero-based indexing.
"defaultHomeserver": 0
homeserverList
array
default:"[]"
Array of homeserver domains that users can select from during login/registration.
"homeserverList": ["matrix.org", "mozilla.org", "unredacted.org", "sable.moe", "kendama.moe"]
allowCustomHomeservers
boolean
default:"true"
Whether to allow users to enter custom homeserver URLs that are not in the predefined list.
"allowCustomHomeservers": true

Integration Settings

elementCallUrl
string | null
default:"null"
URL for Element Call integration. Set to null to disable Element Call integration.
"elementCallUrl": null
matrixToBaseUrl
string
default:"https://matrix.to"
Base URL for matrix.to links. Used for generating shareable links to Matrix rooms and users.
"matrixToBaseUrl": "https://matrix.to"

UI Settings

disableAccountSwitcher
boolean
default:"false"
Disable the account switcher feature in the UI. When set to true, users cannot switch between multiple accounts.
"disableAccountSwitcher": false
Configuration for featured spaces, rooms, and servers that appear in the explore/discover section.

Router Settings

hashRouter
object
Configuration for hash-based routing (using # in URLs).
"hashRouter": {
  "enabled": false,
  "basename": "/"
}

Complete Example

{
  "defaultHomeserver": 0,
  "homeserverList": ["matrix.org", "mozilla.org", "unredacted.org", "sable.moe", "kendama.moe"],
  "allowCustomHomeservers": true,
  "elementCallUrl": null,

  "disableAccountSwitcher": false,
  "matrixToBaseUrl": "https://matrix.to",

  "featuredCommunities": {
    "openAsDefault": false,
    "spaces": [
      "#sable:sable.moe",
      "#community:matrix.org",
      "#space:unredacted.org",
      "#science-space:matrix.org",
      "#libregaming-games:tchncs.de",
      "#mathematics-on:matrix.org"
    ],
    "rooms": [
      "#announcements:sable.moe",
      "#freesoftware:matrix.org",
      "#pcapdroid:matrix.org",
      "#gentoo:matrix.org",
      "#PrivSec.dev:arcticfoxes.net",
      "#disroot:aria-net.org"
    ],
    "servers": ["matrix.org", "mozilla.org", "unredacted.org"]
  },

  "hashRouter": {
    "enabled": false,
    "basename": "/"
  }
}

Build docs developers (and LLMs) love