docs: rewrite README for Sanctum — remove build docs, keep install only
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
5e94d75a3e
commit
d1bba69bcf
1 changed files with 14 additions and 54 deletions
68
README.md
68
README.md
|
|
@ -2,19 +2,21 @@
|
||||||
|
|
||||||
# Sanctum
|
# Sanctum
|
||||||
|
|
||||||
**A private, self-hosted desktop client for [mithraic.space](https://mithraic.space)**
|
**The desktop client for [mithraic.space](https://mithraic.space)**
|
||||||
Built on [Revolt](https://revolt.chat) — open source, no tracking, no telemetry, no nonsense.
|
Private. Self-hosted. No tracking, no telemetry, no nonsense.
|
||||||
Windows & Linux. Auto-updates from your own server.
|
Windows & Linux.
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## What is this?
|
## What is Sanctum?
|
||||||
|
|
||||||
Sanctum is a custom fork of [Stoat for Desktop](https://github.com/stoatchat/for-desktop), hardwired to connect exclusively to **mithraic.space** — a self-hosted Revolt instance. It replaces the default branding, icons, and update pipeline with a fully self-contained setup hosted on a private Forgejo instance.
|
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.
|
||||||
|
|
||||||
No reliance on external services. Updates come from `git.mithraic.cloud`. Builds run on a self-hosted CI runner. Everything stays in-house.
|
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.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -25,11 +27,10 @@ Grab the latest build from the [Releases page](https://git.mithraic.cloud/ad3lai
|
||||||
### Linux
|
### Linux
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# extract to your local apps folder
|
|
||||||
mkdir -p ~/.local/share/sanctum
|
mkdir -p ~/.local/share/sanctum
|
||||||
unzip Sanctum-linux-x64-*.zip -d ~/.local/share/sanctum/
|
unzip Sanctum-linux-x64-*.zip -d /tmp/sanctum-extract
|
||||||
|
cp -rT /tmp/sanctum-extract/Sanctum-linux-x64 ~/.local/share/sanctum/
|
||||||
|
|
||||||
# register it as a desktop app
|
|
||||||
cat > ~/.local/share/applications/sanctum.desktop << EOF
|
cat > ~/.local/share/applications/sanctum.desktop << EOF
|
||||||
[Desktop Entry]
|
[Desktop Entry]
|
||||||
Name=Sanctum
|
Name=Sanctum
|
||||||
|
|
@ -41,57 +42,16 @@ StartupWMClass=sanctum
|
||||||
EOF
|
EOF
|
||||||
```
|
```
|
||||||
|
|
||||||
Then search for **Sanctum** in your app launcher and you're in.
|
Search for **Sanctum** in your app launcher and you're in.
|
||||||
|
|
||||||
### Windows
|
### Windows
|
||||||
|
|
||||||
Extract the zip, run `sanctum.exe`. That's it.
|
Extract the zip, run `sanctum.exe`.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Auto-updates
|
## Auto-updates
|
||||||
|
|
||||||
Sanctum checks for new releases on every launch. When a newer version is available on `git.mithraic.cloud`, you'll get a desktop notification — click it to download. No background processes, no silent installs.
|
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**.
|
||||||
|
|
||||||
## Building from source
|
|
||||||
|
|
||||||
You'll need Git, Node.js, and pnpm (`corepack enable`).
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://git.mithraic.cloud/ad3laid3/sanctum
|
|
||||||
cd sanctum
|
|
||||||
pnpm i --frozen-lockfile
|
|
||||||
pnpm start
|
|
||||||
```
|
|
||||||
|
|
||||||
### Releasing a new build
|
|
||||||
|
|
||||||
Push a version tag and CI does the rest — compiles Linux and Windows builds, creates a release, and uploads artifacts automatically.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git tag v1.x.x
|
|
||||||
git push origin v1.x.x
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building locally
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Linux (deb + zip)
|
|
||||||
PLATFORM=linux pnpm make
|
|
||||||
|
|
||||||
# Windows (zip, no Wine required)
|
|
||||||
pnpm make --platform win32 --arch x64
|
|
||||||
```
|
|
||||||
|
|
||||||
Output lands in `out/make/`.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Tech
|
|
||||||
|
|
||||||
- [Electron](https://www.electronjs.org/) + [electron-forge](https://www.electronforge.io/)
|
|
||||||
- [Revolt](https://revolt.chat) open-source chat backend
|
|
||||||
- [Forgejo](https://forgejo.org/) for self-hosted git + CI
|
|
||||||
- Discord Rich Presence via [discord-rpc](https://github.com/discordjs/RPC)
|
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue