sidebar_position: 40

Common Recipes

This page provides ready-to-use solutions for common backup scenarios.

Daily Backup to Remote Storage with Cleanup

To create a daily automated backup of your main database to a remote location (e.g. S3, configured as backup) and keep only the 7 most recent backups, you can schedule the included Artisan command directly.

In routes/console.php:

use Illuminate\Support\Facades\Schedule;

Schedule::command('easy-backups:db:create --compress --max-remote-backups=7')
    ->daily()
    ->at('02:00');

Note: We omitted --to-disk, so it automatically uses the default remote disk defined in your config.

Alternatively, if you prefer a custom command class using the Facade:

Backup::database('mysql')
    ->saveTo('backup')
    ->compress()
    ->maxRemoteBackups(7)
    ->run();

Backup User Uploads

If you need to back up user-uploaded files (e.g. storage/app/public) alongside your database, dispatch a separate job for the files.

:::info Single Responsibility A backup job handles either a database or files, not both simultaneously. :::

use Aaix\LaravelEasyBackups\Facades\Backup;

// 1. Backup the Database
Backup::database(config('database.default'))
    ->saveTo('backup')
    ->compress()
    ->run();

// 2. Backup the Files
Backup::files()
    ->includeDirectories([
        storage_path('app/public')
    ])
    ->saveTo('backup')
    ->run();

Create Encrypted Backups

For sensitive data, creating an encrypted backup is recommended.

Creating the backup:

use Aaix\LaravelEasyBackups\Facades\Backup;

Backup::database('mysql')
    ->encryptWithPassword(config('app.backup_password'))
    ->saveTo('backup')
    ->run();

Restoring the backup:

To restore an encrypted backup, you must provide the password.

use Aaix\LaravelEasyBackups\Facades\Restorer;

Restorer::database()
    ->fromDisk('backup')
    ->toDatabase('mysql')
    ->latest()
    ->withPassword(config('app.backup_password'))
    ->run();

Email Notifications

To receive alerts when a backup process fails (or succeeds), configure the notification channels.

use Aaix\LaravelEasyBackups\Facades\Backup;

Backup::database('mysql')
    ->saveTo('backup')
    ->compress()
    // Requires your mail driver to be configured
    ->notifyOnFailure('mail', '[email protected]') 
    ->run();