Docs

Self-hosting

Install the whole Lumen stack on your own Ubuntu 24.04 server.

Requirements

  • A fresh Ubuntu Server 24.04 LTS (x86_64 or arm64) with a public IP.
  • At least 2 vCPU, 4 GB RAM and 40 GB disk for a small community; see the admin guide for sizing.
  • A domain with DNS records for example.com, app.example.com, matrix.example.com and ops.example.com pointing at the server.
  • Ports 80 and 443 reachable from the internet.

Install

git clone <your Lumen repository> lumen
cd lumen
sudo bash install.sh

The installer asks for your domains and operator email (or reads lumen.conf for unattended installs), checks the host and DNS, installs Docker from Docker's official repository, generates unique secrets, obtains certificates, configures the firewall, starts every service and verifies the public endpoints. At the end it shows a summary and how to obtain your one-time operator setup link.

Operate

CommandPurpose
sudo ./update.shBack up, update images and code, migrate, health-check, roll back on failure
sudo ./backup.shEncrypted backup of databases, media, keys and configuration
sudo ./restore.shVerify and restore a backup
sudo ./healthcheck.shQuick pass/fail of every component
sudo ./diagnose.shExplain DNS, TLS, federation, database, SMTP and webhook problems
sudo ./uninstall.shRemove the stack (asks before deleting any data)

The full administration and disaster-recovery guides ship with the source code in docs/.