Backup & Restore

Creating Backups

Learn how to create manual backups immediately and configure automatic backup schedules for ongoing protection.

Creating a Manual Backup

Create a snapshot of your current configuration instantly:

One-Click Backup

Location: Dashboard → Backup → "Create Backup" button (green)

  • • Click the green "Create Backup" button
  • • Modal appears asking for optional backup name/description
  • • Click "Create" to proceed
  • • Backup completes in 1-5 seconds
  • • Success message confirms backup created

Backup Dialog

Optional information to add:

  • Backup Name: Custom label (e.g., "Before Automation Update")
  • Description: Notes about what was backed up
  • Tags: Optional tags for categorization

What's Included

Manual backup process automatically captures:

  • • All enabled modules and their settings
  • • All automations and workflows
  • • All events and recurring patterns
  • • Moderation rules and auto-mod config
  • • Dashboard customization

Setting Up Automatic Backups

Configure automatic backup schedules for ongoing protection:

Enable Auto-Backups

Location: Dashboard → Backup → Auto-Backup section

  • • Toggle "Enable Automatic Backups" switch (off by default)
  • • When enabled, schedule options appear

Schedule Configuration

Choose backup frequency using SearchableSelect dropdown:

  • Daily: Every 24 hours at specified time
  • Weekly: Once per week on selected day
  • Monthly: Once per month on selected date
  • Custom: Enter custom cron expression

Backup Time Selection

Time picker for when backups run:

  • • Click time field to open time picker
  • • Select hour and minute (24-hour format)
  • • Timezone-aware (uses server timezone)
  • • Recommendation: 2-4 AM for off-peak hours

Cron Expression

For custom schedules, enter cron expression:

  • • Format: minute hour day month day-of-week
  • • Example: 0 2 * * * (daily at 2 AM)
  • • Help text provides common cron patterns

Retention Settings

Configure how many backups to keep:

  • • Keep last N backups (default: 7)
  • • Keep backups for X days (default: 30)
  • • Oldest auto-backups deleted when limit reached
  • • Manual backups not affected by retention

Backup Naming & Organization

Use clear naming to keep track of your backups:

Good Backup Names

  • • "Before Automation Refactor"
  • • "Stable Configuration - Weekly"
  • • "Before Event System Changes"
  • • "Pre-Server Migration"

Backup Tags

Optional tags help organize backups by category

Examples: "stable", "testing", "migration", "experimental"

Selective Backup (Advanced)

Choose which modules to include in a backup:

Module Selection

In Create Backup dialog, expand "Advanced Options":

  • • Checkboxes for each module (all selected by default)
  • • Uncheck to exclude specific modules
  • • Useful for testing single module changes

Use Cases

Selective backups useful for:

  • • Backing up only automations before changes
  • • Testing event configuration in isolation
  • • Minimal backup files for faster restore

Backup Size & Storage

Understanding backup files and storage limits:

Typical Backup Size

  • • Small server (basic config): 100 KB - 500 KB
  • • Medium server (moderate automations): 1 - 5 MB
  • • Large server (extensive config): 5 - 20 MB

Storage Limits

  • • Maximum 50 total backups (mix of manual and auto)
  • • Single backup max size: 100 MB
  • • Total backup storage: 500 MB
  • • Oldest backups automatically deleted when limit reached

Downloading Backups

Export backups as files for external storage:

Download Process

  • • Open Backup list in dashboard
  • • Click the download icon on any backup row
  • • File downloads as JSON format
  • • Filename includes timestamp

File Format

Backups are downloaded as .json files containing:

  • • All configuration in structured JSON format
  • • Version information for compatibility
  • • Server ID (for validation on restore)
  • • Timestamp and metadata

Storing Downloaded Backups

  • • Save to secure location (encrypted drive or cloud)
  • • Include multiple important backups
  • • Label clearly with date and purpose
  • • Back up quarterly for long-term archives

Backup Creation Best Practices

  • • Enable automatic daily backups for protection
  • • Create manual backup before any major changes
  • • Use descriptive names that explain the backup purpose
  • • Download monthly backups for offline storage
  • • Test restore process quarterly to ensure backups work
  • • Keep important backups even after 30-day retention
  • • Document which backups correspond to which versions
  • • Clean up old test backups to stay under storage limit