mirror of
https://github.com/SableClient/Sable.git
synced 2026-11-20 09:01:17 -08:00
89 lines
3.4 KiB
Markdown
89 lines
3.4 KiB
Markdown
# Sable
|
|
|
|
A Matrix client built to enhance the user experience with quality-of-life features, cosmetics, utilities, and sheer usability. See the [changelog](https://github.com/SableClient/Sable/blob/dev/CHANGELOG.md).
|
|
|
|
Soon to be replaced desktop apps can be downloaded [here](https://github.com/7w1/sable/releases/tag/1.0.0). They auto-update by pulling the website.
|
|
|
|
Join our matrix space [here](https://matrix.to/#/#sable:sable.moe) to discuss features, issues, or meowing.
|
|
|
|
Forked from [Cinny](https://github.com/cinnyapp/cinny/).
|
|
|
|
## Getting started
|
|
The web app is available at [app.sable.moe](https://app.sable.moe/) and gets updated on frequently, as soon as a feature is deemed stable.
|
|
|
|
You can also download our desktop app for windows and linux from [releases](https://github.com/SableClient/Sable/releases/latest).
|
|
|
|
## Self-hosting
|
|
You have a few options for self hosting, you can:
|
|
1. Run the prebuilt docker container.
|
|
2. Deploy on a site like GitLab Pages. Jae has a [guide here](https://docs.j4.lc/Tutorials/Deploying-Sable-on-GitLab-Pages).
|
|
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:
|
|
|
|
```sh
|
|
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`](config.json), mount your own
|
|
file at `/app/config.json`:
|
|
|
|
```yaml
|
|
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:
|
|
|
|
```sh
|
|
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`](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`](build.config.ts).
|
|
* For example, if you want to deploy on `https://sable.moe/app`, then set `base: '/app'`.
|
|
|
|
## Local development
|
|
> [!TIP]
|
|
> We recommend using a version manager as versions change quickly. [fnm](https://github.com/Schniz/fnm) is a great cross-platform option (Windows, macOS, and Linux). [NVM on Windows](https://github.com/coreybutler/nvm-windows#installation--upgrades) and [nvm](https://github.com/nvm-sh/nvm) on Linux/macOS are also good choices. Use the version defined in [`.node-version`](.node-version).
|
|
|
|
Execute the following commands to start a development server:
|
|
```sh
|
|
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:
|
|
```sh
|
|
pnpm run build # Compiles the app into the dist/ directory
|
|
```
|
|
|
|
## Deployment and infrastructure
|
|
Deployment workflows and infrastructure details live in
|
|
[`infra/README.md`](infra/README.md).
|