Home

CBM Documentation

Detailed docs for CBM — Coolify Backup Manager. New here? Start with the project README, then come back for the details.

• Installation — run the controller, install agents, deploy on Coolify
• Configuration — every environment variable (controller & agent)
• Accounts & roles — users, roles (admin/operator/viewer), invitation links
• Email (SMTP) — password reset, account verification, the Mailpit dev mailer
• Destinations — local · SSH/SFTP · jump host · S3 · tar vs restic engine
• Backups — how each resource type is captured, hooks, live mode, scheduling
• Restore — in place vs → new (clone)
• Disaster recovery — self-backup, recovery file, restore onto a fresh Coolify
• MCP server — drive CBM from any AI agent over a token-authenticated API
• Multi-server — one agent per server, routing, per-server schedules
• Alerts — failed / missing / overdue webhooks
• Reconciliation & retention — detect lost backups, GFS retention
• Security — encryption at rest, tokens, the trust model
• Troubleshooting / FAQ

These pages live in the repository's docs/ folder, versioned with the code, and are published to the wiki on every change — please update them alongside any change (see CONTRIBUTING).