Skip to main content
Sable allows you to configure which Matrix homeservers users can connect to, set a default homeserver, and control whether users can add custom homeservers.

​
Default Homeserver

The defaultHomeserver field specifies which homeserver from your list is pre-selected for users during login and registration.
​
defaultHomeserver
number
default:"0"
Zero-based index pointing to a homeserver in the homeserverList array.

​
Example

{
  "defaultHomeserver": 0,
  "homeserverList": ["matrix.org", "mozilla.org", "unredacted.org", "sable.moe", "kendama.moe"]
}
In this example, "matrix.org" (index 0) is the default homeserver. To make "sable.moe" the default instead: 
{
  "defaultHomeserver": 3,
  "homeserverList": ["matrix.org", "mozilla.org", "unredacted.org", "sable.moe", "kendama.moe"]
}

​
Homeserver List

The homeserverList defines which homeservers appear in the dropdown menu during login and registration.
​
homeserverList
array
default:"[]"
Array of homeserver domain names. Users can select from this list when logging in or registering.

​
Adding Homeservers

Simply add domain names to the array: 
{
  "homeserverList": [
    "matrix.org",
    "mozilla.org",
    "unredacted.org",
    "sable.moe",
    "kendama.moe",
    "your-homeserver.com"
  ]
}
Only include the domain name, not the full URL. For example, use "matrix.org" not "https://matrix.org".

​
Removing Homeservers

Remove any homeserver you don’t want to offer: 
{
  "homeserverList": ["your-homeserver.com"]
}

​
Custom Homeservers

The allowCustomHomeservers field controls whether users can manually enter homeserver URLs that aren’t in your predefined list.
​
allowCustomHomeservers
boolean
default:"true"
When true, users can type in any homeserver URL. When false, users are restricted to the homeserverList.

​
Allowing Custom Homeservers

This is the default and recommended setting for public instances: 
{
  "allowCustomHomeservers": true
}
With this setting, users can:
  • Select from the homeserverList
  • Enter any custom homeserver URL

​
Restricting to Predefined Homeservers

For controlled environments or private deployments: 
{
  "allowCustomHomeservers": false
}
With this setting, users can only select from the homeserverList.

​
Complete Configuration Example

​
Public Instance

For a public Sable instance that allows maximum flexibility: 
{
  "defaultHomeserver": 0,
  "homeserverList": ["matrix.org", "mozilla.org", "unredacted.org"],
  "allowCustomHomeservers": true
}

​
Private/Corporate Instance

For a corporate or private deployment restricted to specific homeservers: 
{
  "defaultHomeserver": 0,
  "homeserverList": ["company.com", "partner.com"],
  "allowCustomHomeservers": false
}

​
Single Homeserver Instance

For an instance dedicated to a single homeserver: 
{
  "defaultHomeserver": 0,
  "homeserverList": ["your-homeserver.com"],
  "allowCustomHomeservers": false
}

Build docs developers (and LLMs) love

Get started for freeTalk to us