Laravel Backup

https://github.com/spatie/laravel-backup
Admin
A modern backup solution for Laravel applications that creates zip archives of files and database...
Tokens:22,803
Snippets:192
Trust Score:10
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install spatie/laravel-backup with Composer

Source: https://github.com/spatie/laravel-backup/blob/main/docs/installation-and-setup.md

Installs the package via Composer. The service provider is automatically registered after installation.

```bash
composer require spatie/laravel-backup
```

--------------------------------

### Run backup:run artisan command

Source: https://github.com/spatie/laravel-backup/blob/main/docs/introduction.md

Run this artisan command to create a backup of your files and databases. It is the primary command for making a backup once the package is installed.

```bash
php artisan backup:run
```

--------------------------------

### Destination disk configuration with backup_options

Source: https://github.com/spatie/laravel-backup/blob/main/docs/taking-backups/overview.md

Example of adding extra options to a filesystem disk's Flysystem driver via a 'backup_options' array in config/filesystems.php. This is only needed in specific cases.

```php
// in config filesystems.php

return [

    // ..
    
    'disks' => [
        's3' => [
            'driver' => 's3',
            // ...
            'backup_options' => [
               // add extra options here
            ],
        ],
    ],
];
```

--------------------------------

### Install laravel/slack-notification-channel for Slack notifications

Source: https://github.com/spatie/laravel-backup/blob/main/docs/requirements.md

Install the laravel/slack-notification-channel package to enable Slack notifications for backups. This is required before configuring Slack notifications in the backup package.

```bash
composer require laravel/slack-notification-channel
```

--------------------------------

### Laravel Backup Configuration: Webhook, Monitoring, and Cleanup

Source: https://github.com/spatie/laravel-backup/blob/main/docs/installation-and-setup.md

Configuration excerpt from the Laravel backup package's config file. It shows the webhook channel settings, the monitor_backups array with health checks, and the cleanup strategy with retention periods. The commented-out second app example is included as shown in the source.

```php
/*
 * If this is an empty string, the name field on the webhook will be used.
 */
'username' => '',

/*
 * If this is an empty string, the avatar on the webhook will be used.
 */
'avatar_url' => '',
],

/*
 * A generic webhook channel that POSTs JSON to a URL.
 * Useful for Mattermost, Microsoft Teams, or custom integrations.
 */
'webhook' => [
    'url' => '',
],
],

/*
 * Here you can specify which backups should be monitored.
 * If a backup does not meet the specified requirements the
 * UnHealthyBackupWasFound event will be fired.
 */
'monitor_backups' => [
    [
        'name' => env('APP_NAME', 'laravel-backup'),
        'disks' => ['local'],
        'health_checks' => [
            \Spatie\Backup\Tasks\Monitor\HealthChecks\MaximumAgeInDays::class => 1,
            \Spatie\Backup\Tasks\Monitor\HealthChecks\MaximumStorageInMegabytes::class => 5000,
        ],
    ],

    /*
    [
        'name' => 'name of the second app',
        'disks' => ['local', 's3'],
        'health_checks' => [
            \Spatie\Backup\Tasks\Monitor\HealthChecks\MaximumAgeInDays::class => 1,
            \Spatie\Backup\Tasks\Monitor\HealthChecks\MaximumStorageInMegabytes::class => 5000,
        ],
    ],
    */
],

'cleanup' => [
    /*
     * The strategy that will be used to cleanup old backups. The default strategy
     * will keep all backups for a certain amount of days. After that period only
     * a daily backup will be kept. After that period only weekly backups will
     * be kept and so on.
     *
     * No matter how you configure it the default strategy will never
     * delete the newest backup.
     */
    'strategy' => \Spatie\Backup\Tasks\Cleanup\Strategies\DefaultStrategy::class,

    'default_strategy' => [
        /*
         * The number of days for which backups must be kept.
         */
        'keep_all_backups_for_days' => 7,

        /*
         * After the "keep_all_backups_for_days" period is over, the most recent backup
         * of that day will be kept. Older backups within the same day will be removed.
         * If you create backups only once a day, no backups will be removed yet.
         */
        'keep_daily_backups_for_days' => 16,

        /*
         * After the "keep_daily_backups_for_days" period is over, the most recent backup
         * of that week will be kept. Older backups within the same week will be removed.
         * If you create backups only once a week, no backups will be removed yet.
         */
        'keep_weekly_backups_for_weeks' => 8,

        /*
         * After the "keep_weekly_backups_for_weeks" period is over, the most recent backup
         * of that month will be kept. Older backups within the same month will be removed.
         */
        'keep_monthly_backups_for_months' => 4,

        /*
         * After the "keep_monthly_backups_for_months" period is over, the most recent backup
         * of that year will be kept. Older backups within the same year will be removed.
         */
        'keep_yearly_backups_for_years' => 2,

        /*
         * After cleaning up the backups remove the oldest backup until
         * this amount of megabytes has been reached.
         * Set null for unlimited size.
         */
        'delete_oldest_backups_when_using_more_megabytes_than' => 5000,
    ],

    /*
     * The number of attempts, in case the cleanup command encounters an exception
     */
    'tries' => 1,

    /*
     * The number of seconds to wait before attempting a new cleanup if the previous try failed
     * Set to `0` for none
     */
    'retry_delay' => 0,
],

];
```

--------------------------------

### Install Pusher notification channel driver

Source: https://github.com/spatie/laravel-backup/blob/main/docs/sending-notifications/adding-extra-notification-channels.md

Use Composer to require the Pusher push notifications package.

```php
laravel-notification-channels/pusher-push-notifications
```

--------------------------------

### Custom Health Check Class

Source: https://github.com/spatie/laravel-backup/blob/main/resources/boost/skills/laravel-backup/SKILL.md

Extend Spatie\Backup\Tasks\Monitor\HealthCheck and implement checkHealth to define a custom health check. The example fails if the backup count is below a minimum, with a default of 3.

```php
use Spatie\Backup\BackupDestination\BackupDestination;
use Spatie\Backup\Tasks\Monitor\HealthCheck;

class MinimumBackupCount extends HealthCheck
{
    protected int $minimumCount;

    public function __construct(int $minimumCount = 3)
    {
        $this->minimumCount = $minimumCount;
    }

    public function checkHealth(BackupDestination $backupDestination): void
    {
        $this->failIf(
            $backupDestination->backups()->count() < $this->minimumCount,
            "Expected at least {$this->minimumCount} backups."
        );
    }
}
```

--------------------------------

### Map Custom Notification in config/backup.php

Source: https://github.com/spatie/laravel-backup/blob/main/resources/boost/skills/laravel-backup/SKILL.md

Map the custom notification class in the 'notifications' array of config/backup.php. The example shows the notification is sent via the 'mail' channel.

```php
'notifications' => [
    'notifications' => [
        \App\Notifications\CustomBackupFailedNotification::class => ['mail'],
    ],
],
```

--------------------------------

### Set timestamp format for database dumps

Source: https://github.com/spatie/laravel-backup/blob/main/docs/installation-and-setup.md

Add a timestamp to database dump filenames by setting `database_dump_file_timestamp_format` in `config/backup.php`. The example uses the format `Y-m-d-H-i-s`. This affects the names of the dump files within the overall backup zip file.

```php
//config/backup.php
'backup' => [
    ...,
    'database_dump_file_timestamp_format' => 'Y-m-d-H-i-s',
  ],
```

--------------------------------

### Set file extension for database dumps

Source: https://github.com/spatie/laravel-backup/blob/main/docs/installation-and-setup.md

Override the default database dump file extension (`.sql`, or `.archive` for MongoDB) by setting `database_dump_file_extension` in `config/backup.php`. The example saves dumps as `.txt` files. This affects the names of the dump files within the overall backup zip file.

```php
//config/backup.php
'backup' => [
    ...,
    'database_dump_file_extension' => 'txt',
  ],
```

--------------------------------

### Run and manage backups with artisan commands

Source: https://github.com/spatie/laravel-backup/blob/main/resources/boost/skills/laravel-backup/SKILL.md

Lists the primary artisan commands for running, cleaning, listing, and monitoring backups, including options for database-only, specific connections, files-only, custom disks, filenames, and alternative config keys.

```bash
# Run a backup
php artisan backup:run

# Backup only the database
php artisan backup:run --only-db

# Backup specific database connections
php artisan backup:run --db-name=mysql --db-name=pgsql

# Backup only files (no database)
php artisan backup:run --only-files

# Backup to a specific disk
php artisan backup:run --only-to-disk=s3

# Custom filename
php artisan backup:run --filename=my-backup.zip

# Clean old backups
php artisan backup:clean

# List all backups
php artisan backup:list

# Monitor backup health
php artisan backup:monitor

# Use an alternative config key
php artisan backup:run --config=backup_secondary
```

--------------------------------

### Run a backup with a specific configuration file

Source: https://github.com/spatie/laravel-backup/blob/main/docs/taking-backups/overview.md

Runs a backup using the specified configuration file instead of the default configuration.

```bash
php artisan backup:run --config=backup_database
```

--------------------------------

### Run backups with custom configuration files

Source: https://github.com/spatie/laravel-backup/blob/main/docs/taking-backups/overview.md

Commands to run and clean backups using custom configuration files placed in the config directory. Each config file (e.g., backup_database) allows separate scheduling, retention, and destination settings.

```bash
php artisan backup:run --config=backup_database
php artisan backup:clean --config=backup_database

php artisan backup:run --config=backup_invoices
php artisan backup:clean --config=backup_invoices

php artisan backup:run --config=backup_uploads
php artisan backup:clean --config=backup_uploads
```

--------------------------------

### Check all backups with php artisan backup:list

Source: https://github.com/spatie/laravel-backup/blob/main/docs/monitoring-the-health-of-all-backups/overview.md

Use this command to see the status of all monitored destination filesystems.

```bash
php artisan backup:list
```

--------------------------------

### Enable Gzip dump compression

Source: https://github.com/spatie/laravel-backup/blob/main/resources/boost/skills/laravel-backup/SKILL.md

Enable dump compression using GzipCompressor in config/backup.php.

```php
// config/backup.php
'database_dump_compressor' => \Spatie\DbDumper\Compressors\GzipCompressor::class,
```

--------------------------------

### Configure backup encryption with password

Source: https://github.com/spatie/laravel-backup/blob/main/resources/boost/skills/laravel-backup/SKILL.md

Enable encryption for backup archives. Set password from environment variable and use 'default' encryption which uses ZipArchive::EM_AES_256.

```php
// config/backup.php
'password' => env('BACKUP_ARCHIVE_PASSWORD'),
'encryption' => 'default', // Uses ZipArchive::EM_AES_256
```

--------------------------------

### Run backup cleanup via artisan backup:clean

Source: https://github.com/spatie/laravel-backup/blob/main/docs/cleaning-up-old-backups/overview.md

Run the cleanup command to delete old backups. Without options, it uses the default config. The --config=backup flag specifies a particular configuration, likely given as the config's key.

```command
php artisan backup:clean
```

```command
php artisan backup:clean --config=backup
```

--------------------------------

### Publish backup config file

Source: https://github.com/spatie/laravel-backup/blob/main/docs/installation-and-setup.md

Publishes the configuration file to config/backup.php.

```bash
php artisan vendor:publish --provider="Spatie\Backup\BackupServiceProvider" --tag=backup-config
```

--------------------------------

### Run backup with --isolated option

Source: https://github.com/spatie/laravel-backup/blob/main/docs/advanced-usage/isolated-mode.md

Use this command to run the backup task on a single server. The first server to obtain the task secures an atomic lock to prevent other servers from running the same task simultaneously. Requires the default cache driver to be database, memcached, dynamodb, or redis, with all servers sharing the same central cache server.

```php
php artisan backup:run --isolated
```

--------------------------------

### Configure monitor_backups array in config/backup.php

Source: https://github.com/spatie/laravel-backup/blob/main/docs/monitoring-the-health-of-all-backups/overview.md

Specify which backups to monitor and the health checks (MaximumAgeInDays and MaximumStorageInMegabytes). The name must match the backup.name in the backed-up app's config.

```php
//config/backup.php

    /*
     *  In this array you can specify which backups should be monitored.
     *  If a backup does not meet the specified requirements the
     *  UnHealthyBackupWasFound-event will be fired.
     */
    'monitor_backups' => [
        [
            'name' => env('APP_NAME'),
            'disks' => ['s3'],
            'health_checks' => [
                \Spatie\Backup\Tasks\Monitor\HealthChecks\MaximumAgeInDays::class => 1,
                \Spatie\Backup\Tasks\Monitor\HealthChecks\MaximumStorageInMegabytes::class => 5000,
            ],
        ],

        /*
        [
            'name' => 'name of the second app',
            'disks' => ['s3'],
            'health_checks' => [
                \Spatie\Backup\Tasks\Monitor\HealthChecks\MaximumAgeInDays::class => 1,
                \Spatie\Backup\Tasks\Monitor\HealthChecks\MaximumStorageInMegabytes::class => 5000,
            ],
        ],
        */
    ],
```

--------------------------------

### Implement deleteOldBackups method in custom strategy

Source: https://github.com/spatie/laravel-backup/blob/main/docs/cleaning-up-old-backups/overview.md

Method signature to implement when building a custom cleanup strategy. Extend the abstract class Spatie\Backup\Tasks\Cleanup\CleanupStrategy and provide this method.

```php
use Spatie\Backup\BackupDestination\BackupCollection;

public function deleteOldBackups(BackupCollection $backupCollection)
```

--------------------------------

### Listen to BackupManifestWasCreated and add files

Source: https://github.com/spatie/laravel-backup/blob/main/docs/advanced-usage/adding-extra-files-to-a-backup.md

Use this listener to add extra files to the manifest. The event's manifest object provides an addFiles() method that accepts an array of file paths.

```php
use Spatie\Backup\Events\BackupManifestWasCreated;

Event::listen(BackupManifestWasCreated::class, function (BackupManifestWasCreated $event) {
   $event->manifest->addFiles([$path1, $path2, ...]);
});
```

--------------------------------

### Configure cleanup strategy in config/backup.php

Source: https://github.com/spatie/laravel-backup/blob/main/docs/cleaning-up-old-backups/overview.md

Configures the cleanup strategy. The default strategy keeps backups based on the specified days/weeks/months/years and never deletes the newest backup. Adjust the numeric values to suit your needs.

```php
//config/backup.php

    'cleanup' => [
        /*
         * The strategy that will be used to cleanup old backups. The default strategy
         * will keep all backups for a certain amount of days. After that period only
         * a daily backup will be kept. After that period only weekly backups will
         * be kept and so on.
         *
         * No matter how you configure it the default strategy will never
         * delete the newest backup.
         */
        'strategy' => \Spatie\Backup\Tasks\Cleanup\Strategies\DefaultStrategy::class,

        'default_strategy' => [

            /*
             * The number of days that all backups must be kept.
             */
            'keep_all_backups_for_days' => 7,

            /*
             * The number of days that all daily backups must be kept.
             */
            'keep_daily_backups_for_days' => 16,

            /*
             * The number of weeks of which one weekly backup must be kept.
             */
            'keep_weekly_backups_for_weeks' => 8,

            /*
             * The number of months of which one monthly backup must be kept.
             */
            'keep_monthly_backups_for_months' => 4,

            /*
             * The number of years of which one yearly backup must be kept.
             */
            'keep_yearly_backups_for_years' => 2,

            /*
             * After cleaning up the backups remove the oldest backup until
             * this amount of megabytes has been reached.
             * Set null for unlimited size.
             */
            'delete_oldest_backups_when_using_more_megabytes_than' => 5000,
        ],
    ],
```

--------------------------------

### Set multiple backup destination disks

Source: https://github.com/spatie/laravel-backup/blob/main/resources/boost/skills/laravel-backup/SKILL.md

Configure multiple backup destinations by specifying an array of disks in config/backup.php.

```php
// config/backup.php
'destination' => [
    'disks' => ['local', 's3'],
],
```

--------------------------------

### Set a custom backup filename

Source: https://github.com/spatie/laravel-backup/blob/main/docs/taking-backups/overview.md

Runs a backup and saves the zip file with the specified custom filename.

```bash
php artisan backup:run --filename=my-backup.zip
```

--------------------------------

### Run tests with composer test

Source: https://github.com/spatie/laravel-backup/blob/main/README.md

Run the package's test suite with Composer.

```bash
composer test
```

--------------------------------

### Default backup configuration (config/backup.php)

Source: https://github.com/spatie/laravel-backup/blob/main/docs/installation-and-setup.md

Default contents of config/backup.php. It defines the backup name, source files and databases, database dump compression, timestamp format, filename base, and file extension. The source files section includes include/exclude lists, follow_links, ignore_unreadable_directories, and relative_path options.

```php
return [

    'backup' => [
        /*
         * The name of this application. You can use this name to monitor
         * the backups.
         */
        'name' => env('APP_NAME', 'laravel-backup'),

        'source' => [
            'files' => [
                /*
                 * The list of directories and files that will be included in the backup.
                 */
                'include' => [
                    base_path(),
                    // storage_path(),  // Include if you use zero downtime deployments and don't follow symlinks
                ],

                /*
                 * These directories and files will be excluded from the backup.
                 *
                 * Directories used by the backup process will automatically be excluded.
                 */
                'exclude' => [
                    base_path('vendor'),
                    base_path('node_modules'),
                    storage_path('framework'),
                ],

                /*
                 * Determines if symlinks should be followed.
                 */
                'follow_links' => false,

                /*
                 * Determines if it should avoid unreadable folders.
                 */
                'ignore_unreadable_directories' => false,

                /*
                 * This path is used to make directories in resulting zip-file relative
                 * Set to `null` to include complete absolute path
                 * Example: base_path()
                 */
                'relative_path' => null,
            ],

            /*
             * The names of the connections to the databases that should be backed up
             * MySQL, PostgreSQL, SQLite and Mongo databases are supported.
             *
             * The content of the database dump may be customized for each connection
             * by adding a 'dump' key to the connection settings in config/database.php.
             * E.g.
             * 'mysql' => [
             *       ...
             *      'dump' => [
             *           'exclude_tables' => [
             *                'table_to_exclude_from_backup',
             *                'another_table_to_exclude'
             *            ]
             *       ],
             * ],
             *
             * If you are using only InnoDB tables on a MySQL server, you can
             * also supply the useSingleTransaction option to avoid table locking.
             *
             * E.g.
             * 'mysql' => [
             *       ...
             *      'dump' => [
             *           'useSingleTransaction' => true,
             *       ],
             * ],
             *
             * For a complete list of available customization options, see https://github.com/spatie/db-dumper
             */
            'databases' => [
                env('DB_CONNECTION', 'mysql'),
            ],
        ],

        /*
         * The database dump can be compressed to decrease disk space usage.
         *
         * Out of the box Laravel-backup supplies
         * Spatie\DbDumper\Compressors\GzipCompressor::class.
         *
         * You can also create custom compressor. More info on that here:
         * https://github.com/spatie/db-dumper#using-compression
         *
         * If you do not want any compressor at all, set it to null.
         */
        'database_dump_compressor' => null,

        /*
         * If specified, the database dumped file name will contain a timestamp (e.g.: 'Y-m-d-H-i-s').
         */
        'database_dump_file_timestamp_format' => null,

        /*
         * The base of the dump filename, either 'database' or 'connection'
         *
         * If 'database' (default), the dumped filename will contain the database name.
         * If 'connection', the dumped filename will contain the connection name.
         */
        'database_dump_filename_base' => 'database',

        /*
         * The file extension used for the database dump files.
         *
         * If not specified, the file extension will be .archive for MongoDB and .sql for all other databases
         * The file extension should be specified without a leading .
         */
        'database_dump_file_extension' => '',

```

--------------------------------

### Set a PHP timeout for the backup process

Source: https://github.com/spatie/laravel-backup/blob/main/docs/taking-backups/overview.md

Runs a backup with a custom PHP timeout value in seconds, overriding the default timeout.

```bash
php artisan backup:run --timeout=600
```

--------------------------------

### Configure backup notifications in config/backup.php

Source: https://github.com/spatie/laravel-backup/blob/main/docs/sending-notifications/overview.md

Configuration block from config/backup.php that maps notification classes to channels (mail, slack, discord, webhook). Requires laravel/slack-notification-channel for Slack. Set mail 'to' address, Slack webhook URL, Discord webhook URL, and generic webhook URL as needed.

```php
//config/backup.php

    /*
     * You can get notified when specific events occur. Out of the box you can use 'mail' and 'slack'.
     * For Slack you need to install laravel/slack-notification-channel.
     *
     * You can also use your own notification classes, just make sure the class is named after one of
     * the `Spatie\Backup\Notifications\Notifications` classes.
     */
    'notifications' => [
        'notifications' => [
            \Spatie\Backup\Notifications\Notifications\BackupHasFailedNotification::class => ['mail'],
            \Spatie\Backup\Notifications\Notifications\UnhealthyBackupWasFoundNotification::class => ['mail'],
            \Spatie\Backup\Notifications\Notifications\CleanupHasFailedNotification::class => ['mail'],
            \Spatie\Backup\Notifications\Notifications\BackupWasSuccessfulNotification::class => ['mail'],
            \Spatie\Backup\Notifications\Notifications\HealthyBackupWasFoundNotification::class => ['mail'],
            \Spatie\Backup\Notifications\Notifications\CleanupWasSuccessfulNotification::class => ['mail'],
        ],

        /*
         * Here you can specify the notifiable to which the notifications should be sent. The default
         * notifiable will use the variables specified in this config file.
         */
        'notifiable' => \Spatie\Backup\Notifications\Notifiable::class,

        'mail' => [
            'to' => 'your@example.com',

            'from' => [
                'address' => env('MAIL_FROM_ADDRESS', 'hello@example.com'),
                'name' => env('MAIL_FROM_NAME', 'Example'),
            ],
        ],

        'slack' => [
            'webhook_url' => '',

            /*
             * If this is set to null the default channel of the webhook will be used.
             */
            'channel' => null,

            'username' => null,

            'icon' => null,
        ],

        'discord' => [
            'webhook_url' => '',

            /*
             * If this is an empty string, the name field on the webhook will be used.
             */
            'username' => '',

            /*
             * If this is an empty string, the avatar on the webhook will be used.
             */
            'avatar_url' => '',
        ],

        /*
         * A generic webhook channel that POSTs JSON to a URL.
         * Useful for Mattermost, Microsoft Teams, or custom integrations.
         */
        'webhook' => [
            'url' => '',
        ],
    ],
```

--------------------------------

### Backup only the database

Source: https://github.com/spatie/laravel-backup/blob/main/docs/taking-backups/overview.md

Runs a backup that only includes the database, skipping files. Warning: partial backups may not be recoverable.

```bash
php artisan backup:run --only-db
```

--------------------------------

### Backup source and destination configuration

Source: https://github.com/spatie/laravel-backup/blob/main/docs/taking-backups/overview.md

Defines the files, directories, and databases to include in the backup, as well as the destination disks where the backup zip will be stored. The zip file is named `<name>/<Y-m-d-H-i-s>.zip` and is deleted after being copied to all destinations.

```php
'backup' => [
    /*
     * The name of this application. You can use this name to monitor
     * the backups.
     */
    'name' => env('APP_NAME', 'laravel-backup'),

    'source' => [
        'files' => [
            /*
             * The list of directories and files that will be included in the backup.
             */
            'include' => [
                base_path(),
            ],

            /*
             * These directories and files will be excluded from the backup.
             *
             * Directories used by the backup process will automatically be excluded.
             */
            'exclude' => [
                base_path('vendor'),
                base_path('node_modules'),
                storage_path('framework'),
            ],

            /*
             * Determines if symlinks should be followed.
             */
            'follow_links' => false,

            /*
             * Determines if it should avoid unreadable folders.
             */
            'ignore_unreadable_directories' => false,

            /*
             * This path is used to make directories in resulting zip-file relative
             * Set to `null` to include complete absolute path
             * Example: base_path()
             */
            'relative_path' => null,
        ],

        /*
         * The names of the connections to the databases that should be backed up
         * MySQL, PostgreSQL, SQLite and Mongo databases are supported.
         */
        'databases' => [
            env('DB_CONNECTION', 'mysql'),
        ],
    ],

    'destination' => [
        /*
         * The disk names on which the backups will be stored.
         */
        'disks' => [
            'local',
        ],
    ],
]
```

--------------------------------

### Register custom cleanup strategy

Source: https://github.com/spatie/laravel-backup/blob/main/resources/boost/skills/laravel-backup/SKILL.md

Register the custom cleanup strategy in config/backup.php.

```php
'cleanup' => [
    'strategy' => \App\Backup\MyCleanupStrategy::class,
],
```

--------------------------------

### Implement custom cleanup strategy

Source: https://github.com/spatie/laravel-backup/blob/main/resources/boost/skills/laravel-backup/SKILL.md

Custom cleanup strategy that deletes backups older than one month. Extend CleanupStrategy and implement deleteOldBackups.

```php
use Spatie\Backup\BackupDestination\BackupCollection;
use Spatie\Backup\Tasks\Cleanup\CleanupStrategy;

class MyCleanupStrategy extends CleanupStrategy
{
    public function deleteOldBackups(BackupCollection $backups): void
    {
        $backups
            ->reject(fn ($backup) => $backup->date()->gt(now()->subMonth()))
            ->each(fn ($backup) => $backup->delete());
    }
}
```

--------------------------------

### Update custom cleanup strategy config access

Source: https://github.com/spatie/laravel-backup/blob/main/UPGRADING.md

In v10, the CleanupStrategy constructor now accepts Spatie\Backup\Config\Config. Access config values via typed properties instead of array access.

```php
// before
$this->config->get('backup.cleanup.default_strategy.keep_all_backups_for_days');

// after
$this->config->cleanup->defaultStrategy->keepAllBackupsForDays;
```

--------------------------------

### Publish backup translation files

Source: https://github.com/spatie/laravel-backup/blob/main/docs/installation-and-setup.md

Publishes translation files for the package.

```bash
php artisan vendor:publish --provider="Spatie\Backup\BackupServiceProvider" --tag=backup-translations
```

--------------------------------

### Register the notifiable in config/backup.php

Source: https://github.com/spatie/laravel-backup/blob/main/docs/sending-notifications/customizing-the-notifiable.md

Shows how to register the custom notifiable class in the backup config file under the 'notifiable' key.

```php
// config/backup.php
    'notifications' => [
    ...

        'notifiable' => App\Notifications\BackupNotifiable::class,    

```

--------------------------------

### Backup only files

Source: https://github.com/spatie/laravel-backup/blob/main/docs/taking-backups/overview.md

Runs a backup that only includes files, skipping the database dump. Warning: partial backups may not be recoverable.

```bash
php artisan backup:run --only-files
```

--------------------------------

### Schedule backup:monitor command in routes/console.php

Source: https://github.com/spatie/laravel-backup/blob/main/docs/monitoring-the-health-of-all-backups/overview.md

Schedule the monitor command to run daily at 03:00. This replaces the backup:run and backup:clean commands for monitoring purposes.

```php
// routes/console.php

use Illuminate\Support\Facades\Schedule;

Schedule::command('backup:monitor')->daily()->at('03:00');
```

--------------------------------

### Configure the number of retry attempts

Source: https://github.com/spatie/laravel-backup/blob/main/docs/taking-backups/overview.md

Runs a backup and sets the number of retry attempts for the backup process.

```bash
php artisan backup:run --tries=3
```

--------------------------------

### Configure backup destination and encryption

Source: https://github.com/spatie/laravel-backup/blob/main/docs/installation-and-setup.md

Configuration for the backup destination, including compression method and level, storage disks, temporary directory, archive encryption, verification, and retry settings. The compression method uses ZipArchive constants; encryption supports 'none', 'default', 'aes128', 'aes192', and 'aes256'. Set 'password' to null or empty to disable encryption.

```php
'destination' => [
            /*
             * The compression algorithm to be used for creating the zip archive.
             *
             * If backing up only database, you may choose gzip compression for db dump and no compression at zip.
             *
             * Some common algorithms are listed below:
             * ZipArchive::CM_STORE (no compression at all; set 0 as compression level)
             * ZipArchive::CM_DEFAULT
             * ZipArchive::CM_DEFLATE
             * ZipArchive::CM_BZIP2
             * ZipArchive::CM_XZ
             *
             * For more check https://www.php.net/manual/zip.constants.php and confirm it's supported by your system.
             */
            'compression_method' => ZipArchive::CM_DEFAULT,

            /*
             * The compression level corresponding to the used algorithm; an integer between 0 and 9.
             *
             * Check supported levels for the chosen algorithm, usually 1 means the fastest and weakest compression,
             * while 9 the slowest and strongest one.
             *
             * Setting of 0 for some algorithms may switch to the strongest compression.
             */
            'compression_level' => 9,

            /*
             * The filename prefix used for the backup zip file.
             */
            'filename_prefix' => '',

            /*
             * The disk names on which the backups will be stored.
             */
            'disks' => [
                'local',
            ],

            /*
             * Determines whether to allow backups to continue when some targets fail instead of failing completely.
             */
            'continue_on_failure' => false,
        ],

        /*
         * The directory where the temporary files will be stored.
         */
        'temporary_directory' => storage_path('app/backup-temp'),

        /*
         * The password to be used for archive encryption.
         * Set to `null` or leave it empty to disable encryption.
         */
        'password' => env('BACKUP_ARCHIVE_PASSWORD'),

        /*
         * The encryption algorithm to be used for archive encryption.
         * Set to 'none' to disable encryption.
         *
         * Supported: 'none', 'default', 'aes128', 'aes192', 'aes256'
         *
         * When set to 'default', we'll use AES-256 if available on your system.
         */
        'encryption' => 'default',

        /*
         * After creating the zip, verify it can be opened and contains files.
         * Recommended for critical backups but adds a small overhead.
         */
        'verify_backup' => false,

        /*
         * The number of attempts, in case the backup command encounters an exception
         */
        'tries' => 1,

        /*
         * The number of seconds to wait before attempting a new backup if the previous try failed
         * Set to `0` for none
         */
        'retry_delay' => 0,
    ],
```

--------------------------------

### Backup to a specific disk

Source: https://github.com/spatie/laravel-backup/blob/main/docs/taking-backups/overview.md

Runs a backup and stores it only on the specified disk, overriding the default behavior of backing up to all disks.

```bash
php artisan backup:run --only-to-disk=name-of-your-disk
```

--------------------------------

### Register custom database dumper with DbDumperFactory::extend

Source: https://github.com/spatie/laravel-backup/blob/main/docs/installation-and-setup.md

Register a custom database dumper for a driver using `DbDumperFactory::extend()`. The first argument is the driver name (e.g., `'mysql'`) and the second is a callback that returns an instance of `Spatie\DbDumper\DbDumper`. The second block shows the custom dumper class extending `DbDumper`.

```php
DbDumperFactory::extend('mysql', function() {
    return new YourCustomMysqlDumper();
});
```

```php
use Spatie\DbDumper\DbDumper;

class YourCustomMysqlDumper extends DbDumper
{

}
```

--------------------------------

### Update event listener for disk name access

Source: https://github.com/spatie/laravel-backup/blob/main/UPGRADING.md

In v10, events carry primitive properties instead of BackupDestination objects. Replace `$event->backupDestination->diskName()` with `$event->diskName`.

```php
// before
$event->backupDestination->diskName();

// after
$event->diskName;
```

--------------------------------

### Schedule backup:clean and backup:run commands

Source: https://github.com/spatie/laravel-backup/blob/main/docs/installation-and-setup.md

Schedule the backup:clean and backup:run commands in Laravel's console routes file. Adjust the times to your preferences; avoid the 02:00-03:00 time slot in daylight saving time zones to prevent double or missing backups.

```php
// routes/console.php

use Illuminate\Support\Facades\Schedule;

Schedule::command('backup:clean')->daily()->at('01:00');
Schedule::command('backup:run')->daily()->at('01:30');
```

--------------------------------

### Exclude directories at runtime

Source: https://github.com/spatie/laravel-backup/blob/main/docs/taking-backups/overview.md

Runs a backup while excluding the specified directories or files. The option can be repeated to exclude multiple paths.

```bash
php artisan backup:run --exclude=storage/logs --exclude=storage/debugbar
```

--------------------------------

### Override the backup destination path

Source: https://github.com/spatie/laravel-backup/blob/main/docs/taking-backups/overview.md

Runs a backup and stores the backup zip in the specified custom path instead of the default location.

```bash
php artisan backup:run --destination-path=custom/path
```

--------------------------------

### Schedule backup commands in Laravel

Source: https://github.com/spatie/laravel-backup/blob/main/resources/boost/skills/laravel-backup/SKILL.md

Schedules the backup:clean, backup:run, and backup:monitor commands to run daily at specified times. Add this to routes/console.php or app/Console/Kernel.php.

```php
use Illuminate\Support\Facades\Schedule;

Schedule::command('backup:clean')->daily()->at('01:00');
Schedule::command('backup:run')->daily()->at('01:30');
Schedule::command('backup:monitor')->daily()->at('10:00');
```

--------------------------------

### Configure MySQL dump in config/database.php

Source: https://github.com/spatie/laravel-backup/blob/main/resources/boost/skills/laravel-backup/SKILL.md

Customize database dumps per connection in config/database.php. Exclude tables and enable single transaction for MySQL.

```php
'mysql' => [
    // ...
    'dump' => [
        'exclude_tables' => ['telescope_entries', 'telescope_monitoring'],
        'useSingleTransaction' => true,
    ],
],
```

--------------------------------

### Change database dump file extension in backup.php

Source: https://github.com/spatie/laravel-backup/blob/main/docs/advanced-usage/binary-database-dumps-with-postgresql.md

Sets 'database_dump_file_extension' => 'backup' to produce a FILENAME.backup dump file, indicating it is not a text SQL file. Place this in the 'backup' array of config/backup.php.

```php
//config/backup.php
'backup' => [
    ...,
    'database_dump_file_extension' => 'backup', // produces a FILENAME.backup database dump
  ],
```

--------------------------------

### Configure MySQL dump options in config/database.php

Source: https://github.com/spatie/laravel-backup/blob/main/docs/installation-and-setup.md

Configure the MySQL database connection in Laravel's config/database.php to customize the mysqldump binary path, timeout, and other dump options. The dump_binary_path must contain only the path to the binary, not the binary name itself. The timeout is specified in seconds and overrides the default 60-second limit.

```php
//config/database.php
'connections' => [
	'mysql' => [
		'driver'    => 'mysql'
		...,
		'dump' => [
		   'dump_binary_path' => '/path/to/the/binary', // only the path, so without `mysqldump` or `pg_dump`
		   'use_single_transaction',
		   'timeout' => 60 * 5, // 5 minute timeout
		   'exclude_tables' => ['table1', 'table2'],
		   'add_extra_option' => '--optionname=optionvalue', // for example '--column-statistics=0'
		]
	],
```

--------------------------------

### Create custom BackupHasFailedNotification class

Source: https://github.com/spatie/laravel-backup/blob/main/docs/sending-notifications/adding-extra-notification-channels.md

Define a custom notification class that extends the base BackupHasFailedNotification and implements the toPushNotification method.

```php
namespace App\Notifications;

use Spatie\Backup\Notifications\Notifications\BackupHasFailedNotification as BaseNotification;
use NotificationChannels\PusherPushNotifications\Message;

class BackupHasFailedNotification extends BaseNotification
{
    public function toPushNotification($notifiable)
    {
        return Message::create()
            ->iOS()
            ->badge(1)
            ->sound('fail')
            ->body("The backup of {$this->applicationName()} to disk {$this->diskName()} has failed");
    }
}
```

--------------------------------

### BackupManifestWasCreated event class

Source: https://github.com/spatie/laravel-backup/blob/main/docs/advanced-usage/adding-extra-files-to-a-backup.md

The event class is fired after the manifest is created and before the zip file is created. It contains a public $manifest property of type Manifest, which is passed to the constructor.

```php
namespace Spatie\Backup\Events;

use Spatie\Backup\Tasks\Backup\Manifest;

class BackupManifestWasCreated
{
    /** @var \Spatie\Backup\Tasks\Backup\Manifest */
    public $manifest;

    public function __construct(Manifest $manifest)
    {
        $this->manifest = $manifest;
    }
}

```

--------------------------------

### Register custom notification in config/backup.php

Source: https://github.com/spatie/laravel-backup/blob/main/docs/sending-notifications/adding-extra-notification-channels.md

Update the notifications array in the configuration file to include the custom notification class and the Pusher channel.

```php
// config/backup.php
use \NotificationChannels\PusherPushNotifications\Channel as PusherChannel

...

    'notifications' => [

        'notifications' => [
            \App\Notifications\BackupHasFailedNotification::class => ['mail', 'slack', PusherChannel::class],
            ...
```

--------------------------------

### Implement checkHealth method

Source: https://github.com/spatie/laravel-backup/blob/main/docs/monitoring-the-health-of-all-backups/creating-your-custom-health-check.md

Abstract method that must be implemented by custom health checks. It receives a BackupDestination instance and should throw an InvalidHealthCheck exception if the backup is not healthy.

```php
public function checkHealth(BackupDestination $backupDestination);
```

--------------------------------

### Add onFailure and onSuccess hooks to backup:run schedule

Source: https://github.com/spatie/laravel-backup/blob/main/docs/installation-and-setup.md

Use Laravel's task hooks to run custom code when the scheduled backup:run command fails or succeeds. The backup:run command returns exit code 1 on failure, which signals a general error.

```php
   $schedule
      ->command('backup:run')->daily()->at('01:00')
      ->onFailure(function () {
         ...
      })
      ->onSuccess(function () {
         ...
      });
```

--------------------------------

### Skip SSL in MySQL/MariaDB database connection

Source: https://github.com/spatie/laravel-backup/blob/main/docs/installation-and-setup.md

Set `dump.skip_ssl` to `true` in `config/database.php` to bypass the `TLS/SSL error: self-signed certificate` error when establishing a MySQL/MariaDB database connection. The default value is `false`.

```php
//config/database.php
'connections' => [
	'mysql' => [
		'driver'    => 'mysql'
		...,
		'dump' => [
                    'dump_binary_path' => '/path/to/the/binary', // only the path, so without `mysqldump` or `pg_dump`
                    'skip_ssl' => true, // default value is `false`
		   ...,
		]
	],
```

--------------------------------

### Set base name for database dumps

Source: https://github.com/spatie/laravel-backup/blob/main/docs/installation-and-setup.md

Name database dump files using the connection name instead of the database name by setting `database_dump_filename_base` to `'connection'` in `config/backup.php`. This affects the names of the dump files within the overall backup zip file.

```php
//config/backup.php
'backup' => [
    ...,
    'database_dump_filename_base' => 'connection',
  ],
```

--------------------------------

### Append a suffix to the default filename

Source: https://github.com/spatie/laravel-backup/blob/main/docs/taking-backups/overview.md

Runs a backup and appends the given suffix to the default backup filename.

```bash
php artisan backup:run --filename-suffix=-extra
```

--------------------------------

### Delete oldest backup using BackupCollection

Source: https://github.com/spatie/laravel-backup/blob/main/docs/cleaning-up-old-backups/overview.md

Deletes the oldest backup using the BackupCollection. The collection is sorted by age, with the latest backup first.

```php
// Retrieve an instance of `Spatie\Backup\BackupDestination\Backup`
$backup = $backups->oldestBackup();

// Bye bye backup
$backup->delete();
```

--------------------------------

### Set pg_dump extra option in database.php

Source: https://github.com/spatie/laravel-backup/blob/main/docs/advanced-usage/binary-database-dumps-with-postgresql.md

Adds 'add_extra_option' => '--format=c' to the pgsql connection's dump configuration to produce binary dumps. Place this in the 'connections' array of app/config/database.php.

```php
//config/database.php
'connections' => [
	'pgsql' => [
		'driver'    => 'pgsql'
		...,
		'dump' => [
		    ...,
		    'add_extra_option' => '--format=c', // and any other pg_dump flags
		]
	],
```

--------------------------------

### Register Custom Health Check in config/backup.php

Source: https://github.com/spatie/laravel-backup/blob/main/resources/boost/skills/laravel-backup/SKILL.md

Register the custom health check class in the 'health_checks' array of config/backup.php. The value (5) is passed to the constructor as the minimum count.

```php
'health_checks' => [
    \App\Backup\MinimumBackupCount::class => 5,
],
```

--------------------------------

### Extend the default notifiable class

Source: https://github.com/spatie/laravel-backup/blob/main/docs/sending-notifications/customizing-the-notifiable.md

Extends the default notifiable class to add a custom route method for another notification channel. The method reads a property from the config file.

```php
namespace App\Notifications;

use Spatie\Backup\Notifications\Notifiable;

class BackupNotifiable extends Notifiable
{
    public function routeNotificationForAnotherNotificationChannel()
    {
        return $this->config()->notifications->another_notification_channel->property;
    }
}

```

--------------------------------

### Custom Notification Class

Source: https://github.com/spatie/laravel-backup/blob/main/resources/boost/skills/laravel-backup/SKILL.md

Extend Spatie\Backup\Notifications\BaseNotification to create a custom notification. The toMail method returns a MailMessage with an error level, subject, and the exception message from the event.

```php
use Illuminate\Notifications\Messages\MailMessage;
use Spatie\Backup\Notifications\BaseNotification;

class CustomBackupFailedNotification extends BaseNotification
{
    public function toMail(): MailMessage
    {
        return (new MailMessage)
            ->error()
            ->subject("Backup failed for {$this->applicationName()}")
            ->line($this->event->exception->getMessage());
    }
}
```

--------------------------------

### Disable notifications for a backup run

Source: https://github.com/spatie/laravel-backup/blob/main/docs/taking-backups/overview.md

Runs a backup without sending any notifications for that specific run.

```bash
php artisan backup:run --disable-notifications
```
Tokens:
Raw