Engine Manual
Operations
Running RushDB in production: installing and configuring the server, securing it, backing it up, replicating it, watching it, and keeping its storage healthy. These pages are for operators and are task oriented; exact settings and values are in the Reference.
Pages
- Deployment — install the binary, data directory layout, ports, systemd unit, probes, and the 8 GB VPS profile.
- Configuration — how flags, environment variables, and
config.ymlcombine, and common setups. - Security — tokens, capability tokens, tenant isolation, TLS, network exposure rules, and a hardening checklist.
- Backup and restore — base backups, WAL archiving, point-in-time restore, graph snapshots, and verification.
- Replication — streaming followers, seeding from a base backup, promotion, and the Raft Preview.
- Monitoring —
/health,/ready, Prometheus metrics, logs, and alerts. - Capacity planning — measured envelope and sizing for disk, memory, and throughput.
- Storage and compaction — growth model, compaction, WAL retention, and the disk guard.
- Upgrading from 2.x — moving from RushDB 2.x, and upgrades between 3.x releases.
- Troubleshooting — common errors and their fixes.
Quick start for operators
# 1. Install
sudo install -m 0755 rushdb /usr/local/bin/
# 2. Create the data directory and its config (choose the tenancy mode now)
sudo -u rushdb rushdb serve --data-dir /var/lib/rushdb --init /var/lib/rushdb
# 3. Run with a real token
RUSHDB_TOKEN=$(openssl rand -hex 32) rushdb serve --data-dir /var/lib/rushdb
# 4. Check
curl -s http://127.0.0.1:3000/ready