72 lines
1.6 KiB
Markdown
72 lines
1.6 KiB
Markdown
<div align="center">
|
|
<h1>Sanctum</h1>
|
|
A self-hosted Revolt desktop client for Windows and Linux, built on top of <a href="https://github.com/stoatchat/for-desktop">Stoat for Desktop</a>.
|
|
Connects exclusively to <a href="https://mithraic.space">mithraic.space</a>.
|
|
</div>
|
|
<br/>
|
|
|
|
## Installation
|
|
|
|
Download the latest release from [git.mithraic.cloud/ad3laid3/sanctum/releases](https://git.mithraic.cloud/ad3laid3/sanctum/releases).
|
|
|
|
**Linux (zip):**
|
|
```bash
|
|
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`)
|
|
|
|
```bash
|
|
# 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:
|
|
|
|
```bash
|
|
git tag v1.x.x
|
|
git push origin v1.x.x
|
|
```
|
|
|
|
To build locally:
|
|
|
|
```bash
|
|
# Linux (deb + zip)
|
|
PLATFORM=linux pnpm make
|
|
|
|
# Windows (zip, no Wine required)
|
|
pnpm make --platform win32 --arch x64
|
|
```
|
|
|
|
Artifacts are written to `out/make/`.
|