Skip to main content

System Backup

Module for System Backup Management.

Overview​

The System Backup module provides backup management capabilities for your Open Core Business Suite installation. It enables administrators to create, schedule, download, and restore backups of the database, application files, and modules.

Features​

  • Database Backups: Backup the application database
  • File Backups: Backup application files and uploads
  • Module Backups: Backup installed modules
  • Scheduled Backups: Automated backups on configurable schedules (daily, weekly, monthly, or custom cron)
  • Backup Download: Download backup files directly from the admin panel
  • Backup Restoration: Restore from previous backups with selectable restore items
  • Storage Providers: Support for multiple storage providers (local and others)
  • Backup Progress Tracking: Monitor backup progress in real-time
  • Retention Policies: Configure retention days per schedule for automatic cleanup
  • Backup Statistics: View backup counts, sizes, and success/failure rates

Requirements​

  • Open Core Business Suite (Base System)
  • No additional module dependencies
  • Sufficient storage space for backups

Installation​

Enable via Admin Panel​

  1. Log in as administrator
  2. Navigate to Settings > Addons
  3. Find System Backup and click Enable
  4. Run migrations if prompted

Enable via Command Line​

php artisan module:enable SystemBackup
php artisan migrate

Access backup management through the sidebar menu:

  • Backup & Restore > Backups - View and manage all backups
  • Backup & Restore > Schedules - Manage backup schedules

Usage​

Creating a Manual Backup​

  1. Navigate to Backup & Restore > Backups
  2. Click Create Backup
  3. Optionally enter a backup name (auto-generated if left blank)
  4. Select a storage provider
  5. Choose what to include: Database, Files, Modules (any combination)
  6. Click Create and monitor the progress

Viewing Backups​

The Backups page displays all backups in a datatable with:

  • Backup name and included items (Database, Files, Modules badges)
  • Backup type (manual or scheduled)
  • Status (completed, failed, in progress)
  • File size
  • Storage provider
  • Created by user
  • Creation date
  • Actions: View Details, Restore, Download, Delete

Restoring from Backup​

  1. Navigate to Backup & Restore > Backups
  2. Find the backup to restore (must have "completed" status)
  3. Click Restore
  4. Optionally select which items to restore (defaults to all items in the backup)
  5. Confirm the restoration

Downloading Backups​

  1. Find the completed backup in the list
  2. Click the Download action
  3. The backup ZIP file will download to your browser

Managing Backup Schedules​

Navigate to Backup & Restore > Schedules to manage automated backups:

Creating a Schedule​

Configure a schedule with the following options:

SettingDescription
NameA descriptive name for the schedule
FrequencyDaily, Weekly, Monthly, or Custom (cron expression)
TimeTime of day to run the backup
Days of WeekWhich days to run (for weekly frequency)
Day of MonthWhich day to run (for monthly frequency)
Cron ExpressionCustom cron expression (for custom frequency)
Storage ProviderWhere to store the backup
Included ItemsDatabase, Files, and/or Modules
Retention DaysHow many days to keep backups from this schedule

Managing Schedules​

  • Enable/Disable: Toggle individual schedules on or off
  • Edit: Update schedule configuration
  • Run Now: Manually trigger a scheduled backup
  • Delete: Remove a schedule

Backup Statistics​

View backup statistics including:

  • Total backups count
  • Successful and failed backup counts
  • Total backup storage size
  • Number of active schedules
  • Recent backup history

Best Practices​

  1. Regular Testing: Periodically test backup restoration
  2. Monitor Disk Space: Ensure adequate storage for backups
  3. Set Retention Policies: Configure appropriate retention days on schedules to prevent storage exhaustion
  4. Schedule Off-Peak: Set backup schedules during low-usage hours

Troubleshooting​

Backup Fails​

  • Check available disk space on the storage provider
  • Review application logs for detailed error messages
  • Ensure the application has write permissions to the backup storage directory

Cannot Restore Backup​

  • Verify the backup has "completed" status
  • Check that the backup file still exists in storage
  • Review application logs for restoration errors

Backup Too Large​

  • Create more targeted backups (database only, or files only)
  • Adjust retention policies to clean up older backups
  • Consider using an external storage provider

Changelog: View version history

Last updated on