-
Notifications
You must be signed in to change notification settings - Fork 0
Home
ConvexAutoBackup is a self-hosted backup, restore, and disaster recovery control plane for Convex projects.
It is built for people who want a normal install path instead of a pile of source-code steps: download a release, run Docker, or install the Rust CLI from crates.io. The service includes a guided browser console, a JSON API, scheduler worker, guarded restore flow, audit log, DR reports, and an MCP server for agent workflows.
- Choose an install path in Installation.
- Follow the guided setup flow in the web console, or configure secrets, storage, and access rules from Configuration.
- Deploy Docker, native binaries, or Cargo installs with Deployment.
- Run health checks, backup verification, restore drills, and upgrades with Operations.
- Use Troubleshooting when setup, Convex export, Docker, Cargo, or restore fails.
- Runs full Convex exports on demand or on a schedule.
- Stores backups on local durable storage or S3-compatible object storage.
- Writes manifests with deployment, size, checksum, timing, storage URI, and run identifiers.
- Verifies stored backup artifacts before restore.
- Requires explicit deployment confirmation before restore.
- Records audit events for important setup, backup, verification, and restore actions.
- Exposes a web UI, HTTP API, CLI, scheduler worker, and MCP server.
- Guides first-run setup through project, deploy key, target, destination, job, schedule, and first backup steps.
| Component | Purpose |
|---|---|
convex-autobackup |
Main CLI plus web/API server. |
convex-autobackup-worker |
Scheduler and backup worker process. |
convex-autobackup-mcp |
MCP stdio server for controlled agent workflows. |
| Embedded web UI | React console served by the Rust server. |
| Managed Convex runner | Pinned Convex CLI runner installed by normal installers. |
The beta line is published as v0.1.0-beta.*.
Current beta: v0.1.0-beta.5.
| Channel | Status | Primary use |
|---|---|---|
| GitHub Releases | Beta | Native macOS, Linux, and Windows downloads. |
| Docker Hub | Beta | Simple self-hosted container installs. |
| GHCR | Beta | GitHub-native container pulls. |
| crates.io | Beta | Rust users and scripted CLI installs. |
| npm | Not public | The web UI is embedded, not published as a separate npm package. |
The service defaults to 0.0.0.0:8976 so LAN/server installs work. Do not expose it directly to the public internet. Put production installs behind HTTPS with a reverse proxy and keep deploy keys out of logs, issues, screenshots, and shell transcripts.
ConvexAutoBackup docs: Repository · Releases · Docker Hub · crates.io