Quickstart
A Trioditis server runs as a self-contained Docker Compose bundle on any Linux machine, VM, Proxmox host, or VPS (x86_64 or arm64). One script installs the stack, and built-in automatic updates (or rerunning the installer) keep it current.
Prerequisites
Section titled “Prerequisites”- Docker Engine 28 or later with the Compose plugin (
docker compose) — required for the isolatedsigninDocker network used by the sign-in browser - git
- At least 8 GiB of free disk space where Docker stores its data (8 GB RAM recommended during builds and initial history imports)
- Encrypted storage for Docker’s data directory (see Encryption at rest)
Install the server
Section titled “Install the server”-
Clone the repository on the
devbranch (the bundle lives ondevuntil the first stable release):Terminal window git clone --branch dev https://github.com/NotAKerbal/trioditis.gitcd trioditis -
Run the installer using the access mode that matches your setup:
Terminal window # Option A: Public domain with automatic HTTPS (ports 80 & 443 open)deploy/install/install.sh --domain chat.example.com# Option B: Tailscale Serve with automatic tailnet HTTPStailscale serve --bg --https=8443 http://127.0.0.1:8080deploy/install/install.sh --public-url https://<machine>.<tailnet>.ts.net:8443# Option C: Local-only (loopback on this machine)deploy/install/install.sh --host 127.0.0.1 --bind 127.0.0.1 -
Create the admin account by opening the admin setup link printed at the end of installation.
The setup token is carried in the URL fragment (
#...), which browsers never send to the server, and is consumed the moment the first admin account is created. -
Configure your update channel and networks in the app:
- Open Admin settings → Updates and switch the channel to Nightly while running from
dev(the default Stable channel tracksmain). - Open Admin settings → Networks to install the messaging networks you want members to connect.
- Open Admin settings → Updates and switch the channel to Nightly while running from
Run the helper script as root on your Proxmox VE host to provision an Ubuntu 24.04 VM (recommended) and install Trioditis automatically:
git clone --branch dev https://github.com/NotAKerbal/trioditis.gitcd trioditisbash deploy/install/proxmox.shThis creates VM 9100 (2 cores, 8 GiB RAM, 64 GiB disk) verified against Ubuntu’s published cloud-image checksum. See the Proxmox VE guide for storage, network bridge, and LXC options.
What the installer does
Section titled “What the installer does”On a fresh run, deploy/install/install.sh:
- Verifies Docker Engine 28+, CPU architecture, free disk space, and whether Docker’s data lives on an encrypted volume.
- Generates server secrets,
BACKUP_KEY, and X25519 key pairs intodeploy/.env(mode0600). - Builds the container images from your checkout (web/Caddy, gateway/functions, bridge host, and
login-browser). - Starts PostgreSQL 17 and the self-hosted Convex backend, initializing databases and the Convex admin key.
- Pushes Convex functions, runs migrations, and starts the gateway, bridge host containers,
login-browser, and Caddy. - Sets up the systemd auto-updater service (when systemd is available), waits for every service to pass health checks, verifies the backend can reach the public origin, and prints the one-time admin setup link.
Export your server keys
Section titled “Export your server keys”Right after your first install succeeds, export the server’s private keys and BACKUP_KEY, then store that file safely apart from your backups (in a password manager or offline media):
deploy/trioditis keys export ~/trioditis-server-keys.envMove the file off the server and delete the temporary copy. Regular encrypted backups intentionally omit these keys—without BACKUP_KEY a backup cannot be decrypted. See Backups, Restore & Keys for details.
Next steps
Section titled “Next steps”- Configure reverse proxies, ports, and HTTPS modes in Installation & Modes.
- Limit memory usage with
--networks, add Telegram API credentials, or check per-network limits in Networks. - Learn about auto-updates,
deploy/trioditis, and day-to-day commands in Operations & Auto-Updates.