Documentation
- Administrator
Database backup
Platform
Institute data lives in MongoDB and on disk (uploads, logos, course files). The Backup database action in the administrator Platform menu triggers an on-demand backup using your server’s configured backup path. It complements, but does not replace, scheduled backups your hosting team runs at the infrastructure level.
Treat backups as a joint responsibility: administrators start exports when policy allows; operators retain copies off-site and test restores.
On-demand backup (administrator)
Use this when your runbook calls for a snapshot before a major change (plugin rollout, bulk import, or term rollover).
- Confirm with your technical contact that on-demand exports are enabled on this environment.
- Open Platform → Backup database (label may vary slightly by theme).
- Start the backup and wait for success confirmation in the UI or server logs.
- Ask your hosting team where the archive was written and that it was copied to off-site storage per institute policy.
- Record the date and reason in your internal change log.
The button does not download a file to your laptop by default; file location and format depend on server configuration.
Scheduled and operational backups
Even when on-demand backup works, production sites should have automated backups:
- Frequency: daily at minimum for active admission periods; more often during high-change windows if your policy requires it.
- Retention: align with legal, finance, and academic record requirements.
- Scope: database plus file storage used for LMS and CMS uploads.
- Restore drills: at least one test restore per year on staging, documented with timings and contacts.
Calibyte managed deployments typically configure this on the VM or cloud account; self-hosted institutes coordinate with their own DevOps.
Who does what
- Administrator: Run on-demand backup when the runbook says so; never share backup files in email or chat
- Technical / hosting: Schedule jobs, encrypt archives, monitor disk space, perform restores
- Institute leadership: Approve retention period and who may request a restore
Before a risky change
- Run Backup database or confirm last night’s scheduled job succeeded.
- Export a separate copy of critical CSVs (enrollment lists) if your process requires it.
- Note current Plugins settings if you are about to enable or disable modules.
What you gain
- A recovery path when data is corrupted or deleted by mistake
- Confidence to run platform changes with a recent snapshot
- Clear handoff between admin actions and operator-run disaster recovery
Troubleshooting
| Backup button missing or disabled | Role permissions; Platform menu on your deployment; env may disable on-demand backup |
|---|---|
| Action fails immediately | Disk space on server; backup directory permissions (technical team) |
| Success shown but no file found | Server path in configuration; wrong environment (staging vs production) |
| Restore needed | Do not experiment on production; contact hosting with backup id and target restore time |
| Old backup only | Scheduled job stopped; cron or systemd unit on server |