Sable
A Matrix client built to enhance the user experience with quality-of-life features, cosmetics, utilities, and sheer usability. See the changelog.
Soon to be replaced desktop apps can be downloaded here. They auto-update by pulling the website.
Join our matrix space here to discuss features, issues, or meowing.
Forked from Cinny.
Getting started
The stable web app is available at app.sable.moe and tracks the latest GitHub release. Nightly builds are available at dev.sable.moe and from the nightly GitHub release.
You can also download our desktop app for Windows and Linux from releases. Release artifacts include build attestations, and desktop installations update automatically.
iOS (AltStore / SideStore)
Sable iOS builds are distributed as unsigned IPAs through AltStore and SideStore. Each release publishes both the IPA and an altstore-source.json manifest — stable builds to the latest GitHub release, nightly builds to the nightly GitHub release.
Stable Source
Nightly Source
Setup & install
- Set up AltStore Classic or SideStore on your device.
- Add the Sable source (tap a button above), or add it manually:
- AltStore (stable):
altstore://source?url=https://github.com/SableClient/Sable/releases/latest/download/altstore-source.json - SideStore (stable):
sidestore://source?url=https://github.com/SableClient/Sable/releases/latest/download/altstore-source.json - AltStore (nightly):
altstore://source?url=https://github.com/SableClient/Sable/releases/download/nightly/altstore-source.json - SideStore (nightly):
sidestore://source?url=https://github.com/SableClient/Sable/releases/download/nightly/altstore-source.json
- AltStore (stable):
- Install Sable from the source. The IPA is unsigned; AltStore/SideStore re-sign it with your personal development certificate at install time, so apps refresh every 7 days (the standard free-account limitation).
iOS builds are produced by the ios job in tauri-build.yml and track the same dev/v* triggers as desktop builds.
Android (Obtainium)
Nightly Source
Stable Source
Setup and install
- Set up Obtainium on your device.
- Add the Sable source by either:
- Tapping one of the buttons above.
- Importing one of the JSON files:
- Adding it manually - use https://github.com/SableClient/Sable as the GitHub link and follow the section below with regards to setting app variables
- Install Sable from the source.
Relevant variables and switching between Nightly and Stable
Relevant variable differences between Nightly and Stable:
- Include prereleases -
truefor Nightly,falsefor Stable - Fallback to older releases -
falsefor Nightly,truefor Stable - Use latest asset upload as release date -
truefor Nightly,falsefor Stable (this is due to Nightly builds being uploaded to one release instead of creating new ones) - Use release date as version string (pseudo-version) -
truefor Nightly,falsefor Stable (this is due to Nightly builds being uploaded to one release instead of creating new ones)
Self-hosting
You have a few options for self hosting, you can:
- Run the prebuilt docker container.
- Deploy on a site like GitLab Pages. Jae has a guide here.
- Build it yourself.
Docker
Prebuilt images are published to ghcr.io/sableclient/sable.
latesttracks the currentdevbranch image.X.Y.Ztags are versioned releases.X.Ytags float within a release line.- Pushes to
devalso publish a short commit SHA tag.
Run the latest image with:
docker run --rm -p 8080:8080 ghcr.io/sableclient/sable:latest
Then open http://localhost:8080.
If you want to override the bundled config.json, mount your own
file at /app/config.json:
services:
sable:
image: ghcr.io/sableclient/sable:latest
ports:
- '8080:8080'
volumes:
- ./config.json:/app/config.json:ro
Build it yourself
To build and serve Sable yourself with nginx, clone this repo and build it:
pnpm i # Installs all dependencies
pnpm run build # Compiles the app into the dist/ directory
After that, you can copy the dist/ directory to your server and serve it.
- In the
config.json, you can modify the default homeservers, feature rooms/spaces, toggle the account switcher, and toggle experimental simplified slilding sync support.
Optional default client settings
While the default settings are recommended for most users, you can optionally add a top-level "settingsDefaults" object whose keys match client settings (only fields you want to override) to override them. The default settings for any new logins will match these. Existing keys in local storage or users who chose to sync settings with their account data will still have their settings set.
For example:
{
"settingsDefaults": {
"hour24Clock": true,
"pageZoom": 110,
"messageLayout": 2,
"rightSwipeAction": "members",
"captionPosition": "below",
"renderUserCards": "both",
"jumboEmojiSize": "large"
}
}
Invalid or unknown keys are ignored.
- To deploy on subdirectory, you need to rebuild the app youself after updating the
basepath inbuild.config.ts.- For example, if you want to deploy on
https://sable.moe/app, then setbase: '/app'.
- For example, if you want to deploy on
Local development
Tip
We recommend using a version manager as versions change quickly. fnm is a great cross-platform option (Windows, macOS, and Linux). NVM on Windows and nvm on Linux/macOS are also good choices. Use the version defined in
.node-version.
Execute the following commands to start a development server:
fnm use --corepack-enabled # Activates the Node version and enables corepack
# If you not using fnm, install corepack manually: npm install --global corepack@latest
corepack install # Installs the pnpm version specified in package.json
pnpm i # Installs all dependencies
pnpm run dev # Serve a development version
To build the app:
pnpm run build # Compiles the app into the dist/ directory
Deployment and infrastructure
Deployment workflows and infrastructure details live in
infra/README.md.
