The original, Cinny-based version of Mable
  • TypeScript 99%
  • JavaScript 0.4%
  • CSS 0.2%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-07-07 16:48:07 +01:00
.changeset Fix session end having the wrong identifier (#1030) 2026-07-06 16:22:52 -05:00
.github Update enrich-changelog.mjs 2026-06-21 16:15:38 -05:00
.vscode enable file nesting in explorer with custom patterns 2026-05-20 17:09:32 +02:00
contrib feat(sentry): initialize SDK, performance instrumentation, developer settings, and error capture 2026-03-15 23:40:58 -04:00
docs feat(sentry): switch crash reporting from opt-out to opt-in 2026-03-17 09:03:12 -04:00
infra chore: migrate package manager from npm to pnpm 2026-03-11 15:19:09 +01:00
public Merge branch 'dev' into customization 2026-07-07 15:20:13 +01:00
scripts address lint rules & update package.json 2026-06-16 18:05:31 -05:00
src Update SplashScreen.tsx 2026-07-07 16:34:45 +01:00
.dockerignore ci(docker): build site once and package per-arch 2026-03-07 00:54:17 +00:00
.gitattributes Create .gitattributes 2026-03-05 22:34:11 -06:00
.gitignore feat: add nix flake 2026-05-08 18:04:24 +02:00
.node-version Merge upstream 2026-03-04 19:21:00 -06:00
.nvmrc fix: badge positioning and alignment across sidebar components 2026-03-12 14:25:32 -04:00
build.config.ts Update build.config.ts 2026-05-25 18:37:48 +01:00
Caddyfile fix(caddy): add cache-control headers for assets, sw.js, and index.html 2026-04-06 12:33:58 -04:00
CHANGELOG.md chore: prepare release 1.18.3 2026-06-17 22:11:08 +00:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2026-03-13 21:38:40 -05:00
config.json Merge branch 'dev' into customization 2026-07-07 15:20:13 +01:00
CONTRIBUTING.md Add donation link to contributing guidelines 2026-04-09 22:10:33 -05:00
Dockerfile fix: docker images 2026-03-12 00:31:27 +01:00
flake.lock feat: add nix flake 2026-05-08 18:04:24 +02:00
flake.nix chore(nix): auto-fix nix hashes 2026-07-04 05:16:50 +00:00
index.html Sable > Mable 2026-05-25 16:43:36 +01:00
knip.json dependency bumps 2026-07-04 00:07:31 -05:00
knope.toml migrate to oxlint and oxfmt 2026-04-16 22:15:13 -05:00
LICENSE Change license to AGPLv3 (#1115) 2023-02-24 17:28:04 +05:30
oxfmt.config.ts feat: add nix flake 2026-05-08 18:04:24 +02:00
oxlint.config.ts dependency bumps 2026-07-04 00:07:31 -05:00
package.json dependency bumps 2026-07-04 00:07:31 -05:00
pnpm-lock.yaml dependency bumps 2026-07-04 00:07:31 -05:00
pnpm-workspace.yaml feat: switch to published twemoji font 2026-06-16 21:50:24 +02:00
README.md Mable specific readme 2026-05-25 16:51:59 +01:00
TRADEMARKS.md formatting 2026-05-13 12:42:00 -05:00
tsconfig.json refactor(unstable prefixes): inital refactor to clean up the codebase 2026-05-05 16:47:02 +02:00
vite.config.ts fix failing build 2026-06-17 16:53:45 -05:00
vitest.config.ts refactor: standardize usage of unstable prefixes across components 2026-05-05 18:21:36 +02:00

Mable

A Matrix client built to enhance the user experience with quality-of-life features, cosmetics, utilities, and sheer usability. See the changelog.

This fork is a customised version of the Sable project to stay on more stable builds for longer, and apply personalized tweaks, mostly style related. Sable is originally forked from Cinny, so feel free to check either out as they might better suit your needs.

Getting started

The web app is available here and gets updated whenever future releases have new features I'm interested in and are deemed stable.

Electron-based desktop apps can be downloaded here. They auto-update by pulling the website.

Self-hosting

There are a few options for self hosting, but I do not maintain them, so you are best off using Cinny/Sable for that - The instructions below generally work for them as well so are kept here for reference:

  1. Run the prebuilt docker container.
  2. Deploy on a site like GitLab Pages. Jae has a guide here.
  3. Build it yourself.

Docker

Prebuilt images are published to ghcr.io/sableclient/sable.

  • latest tracks the current dev branch image.
  • X.Y.Z tags are versioned releases.
  • X.Y tags float within a release line.
  • Pushes to dev also 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.

  • To deploy on subdirectory, you need to rebuild the app youself after updating the base path in build.config.ts.

    • For example, if you want to deploy on https://sable.moe/app, then set base: '/app'.

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.

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.