Documentation

Everything you need to run your own instance — starting from no prior experience, ending at production.

Start here

If you have a spare computer and ten minutes, that's the whole prerequisite list. No domain name, no Cloudflare account, no credit card, nothing to sign up for.

git clone https://github.com/Formicaria/SOVRGNnet.cc.git sovrgnnet
cd sovrgnnet
./install.sh

The walkthrough, in detail →

In the repository

These live alongside the code, so they change when it does.

Document What it covers
QUICKSTART.md Setup assuming no prior experience, including what to do when it goes wrong
docs/LXC.md Native install with no Docker — Proxmox LXC or bare Debian/Ubuntu
docs/DEPLOYMENT.md Production hosting: DNS, TLS, Matrix well-known delegation, backups
docs/ARCHITECTURE.md How the pieces fit together, in engineering detail
docs/ROADMAP.md What's done, what's next, and what was deliberately deferred
CHANGELOG.md What shipped, when

Where things stand

v0.1.0 alpha. Working today: accounts, servers, channels, text chat over a real Matrix homeserver, file sharing on your own IPFS node, invite links, roles and moderation, message editing, reactions, typing indicators.

Not yet: end-to-end encryption, voice and video, password reset by email, mobile apps. See security for what that means in practice.

Getting help

Bugs and questions go to GitHub issues. A failing install is a bug in the installer, not a mistake you made — include what sovrgnnet status and sovrgnnet logs say and it's usually diagnosable from that alone.