59 lines
1.8 KiB
Markdown
59 lines
1.8 KiB
Markdown
<div align="center">
|
|
|
|
<img src="assets/desktop/icon.png" width="120" alt="Sanctum" />
|
|
|
|
# Sanctum
|
|
|
|
**The desktop client for [mithraic.space](https://mithraic.space)**
|
|
Private. Self-hosted. No tracking, no telemetry, no nonsense.
|
|
Windows & Linux.
|
|
|
|
</div>
|
|
|
|
---
|
|
|
|
## What is Sanctum?
|
|
|
|
Sanctum is the official desktop client for **mithraic.space** — a private, self-hosted chat community. It's hardwired to connect exclusively to mithraic.space and ships with custom branding and a fully self-contained auto-update pipeline hosted on a private Forgejo instance.
|
|
|
|
Built on top of [Stoat for Desktop](https://github.com/stoatchat/for-desktop), which is itself built on the open-source [Revolt](https://revolt.chat) platform.
|
|
|
|
No reliance on external services. Everything stays in-house.
|
|
|
|
---
|
|
|
|
## Installing
|
|
|
|
Grab the latest build from the [Releases page](https://git.mithraic.cloud/ad3laid3/sanctum/releases).
|
|
|
|
### Linux
|
|
|
|
```bash
|
|
mkdir -p ~/.local/share/sanctum
|
|
unzip Sanctum-linux-x64-*.zip -d /tmp/sanctum-extract
|
|
cp -rT /tmp/sanctum-extract/Sanctum-linux-x64 ~/.local/share/sanctum/
|
|
|
|
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
|
|
```
|
|
|
|
Search for **Sanctum** in your app launcher and you're in.
|
|
|
|
### Windows
|
|
|
|
Extract the zip, run `sanctum.exe`.
|
|
|
|
---
|
|
|
|
## Auto-updates
|
|
|
|
Sanctum checks for updates on every launch. When a new version is available, you'll get a desktop notification — it downloads and installs in the background. Click the notification to restart into the new version.
|
|
|
|
You can also trigger a manual check anytime from the tray icon → **Check for Updates**.
|