sanctum/README.md
MiTHRAL 2379562aec docs: rewrite README for Sanctum self-hosted setup
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-04-21 01:14:41 -04:00

1.6 KiB

Sanctum

A self-hosted Revolt desktop client for Windows and Linux, built on top of Stoat for Desktop. Connects exclusively to mithraic.space.

Installation

Download the latest release from git.mithraic.cloud/ad3laid3/sanctum/releases.

Linux (zip):

mkdir -p ~/.local/share/sanctum
unzip sanctum-linux-x64-*.zip -d ~/.local/share/sanctum/
# create a .desktop launcher
cat > ~/.local/share/applications/sanctum.desktop <<EOF
[Desktop Entry]
Name=Sanctum
Exec=$HOME/.local/share/sanctum/sanctum
Icon=$HOME/.local/share/sanctum/resources/assets/desktop/icon.png
Type=Application
Categories=Network;InstantMessaging;
StartupWMClass=sanctum
EOF

Windows (zip):
Extract the zip and run sanctum.exe.

The app checks for updates automatically on launch and will notify you when a new version is available.

Development

Before getting started, install:

  • Git
  • Node.js
  • pnpm (corepack enable)
# clone the repository
git clone https://git.mithraic.cloud/ad3laid3/sanctum
cd sanctum

# install dependencies
pnpm i --frozen-lockfile

# start the app (connects to mithraic.space)
pnpm start

Building releases

CI runs automatically when a version tag is pushed:

git tag v1.x.x
git push origin v1.x.x

To build locally:

# Linux (deb + zip)
PLATFORM=linux pnpm make

# Windows (zip, no Wine required)
pnpm make --platform win32 --arch x64

Artifacts are written to out/make/.