Documentation

Backup and restore

Automated MongoDB backups with on-demand restore capability.

Updated Aug 5, 20253 min read

Backup and restore

The platform runs automated daily MongoDB backups with manual restore capability.

Backup configuration

Platform Settings → Backup Configuration

Setting Description Default
Enable Backup Turn automated backups on/off Off
Backup Folder Local path for backup storage C:\ICP\Backups
Backup Interval Hours between backups 24
Retention Days Days to keep completed backups 30
mongodump Path Path to mongodump executable Auto-detect
mongorestore Path Path to mongorestore executable Auto-detect

Backup process

Automated (daily)

  1. Schedule - Runs at configured interval
  2. Validate - Check folder, executables, config
  3. Create folder - YYYY-MM-DD_HHmmss timestamped
  4. Run mongodump - --url {conn}/{db} --out {path}
  5. Compute size - Record backup size in bytes
  6. Apply retention - Delete old completed backups
  7. Audit - Log “Backup Completed” or “Backup Failed”

Manual backup

From Backup Manager page:

  1. Click “Run Backup”
  2. Monitor progress in real-time
  3. View result when complete

Backup statuses

Status Description
Pending Queued, waiting to start
Running mongodump in progress
Completed Success, ready for restore
Failed Error recorded, check logs

Restore process

Prerequisites

  • SuperAdmin role required
  • Backup status = “Completed”
  • mongorestore executable available
  • Backup folder exists

Steps

  1. Select backup from history
  2. Click “Restore”
  3. Confirm in dialog (destructive!)
  4. Runs mongorestore --url {conn}/{db} --drop {dumpPath}
  5. Audit “Restore Completed”

⚠️ Warning: Restore drops the database and replaces all data. Cannot be undone.

Retention policy

  • Completed backups older than BackupRetentionDays are deleted
  • Failed backups are NOT auto-deleted (for debugging)
  • Manual delete available for any backup

Monitoring

Backup Manager page

  • Backup folder path
  • Database name
  • Backup size
  • Status (with color badge)
  • Started / Completed timestamps
  • Duration
  • Actions: Run, Restore (SuperAdmin), Delete

Alerts

  • Failed backups logged to audit
  • Worker dashboard shows last backup status
  • Operations dashboard includes backup health

Requirements

  • mongodump/mongorestore installed (MongoDB Database Tools)
  • Writable backup folder with sufficient space
  • MongoDB connection configured in platform settings
  • Disk space for multiple backups

Disaster recovery

  1. Install fresh platform
  2. Configure same database connection
  3. Copy backup folder to new server
  4. Run restore from Backup Manager
  5. Verify all data restored
  6. Restart services