Usage

After installation plugin will register backend Backups menu position.

Application backup button will create backup with all project files and database dump file. To change which files will be included see plugin Settings. Default settings will take project base path and exclude vendor and node_modules directories from it.

Database backup button will create only database backup.

Clean old backups button will clean up old backups based on the plugin Settings.

Backup log button will show the latest backup log in popup window.

Important note: Log is not created when you manually run console command.

Settings button will redirect you to the plugin settings.

Maximum execution time error

When you experience Maximum execution time of ... seconds exceeded error than most likely application backup is too large and PHP cannot do this process in a single request.

What can I do?

1. Change max_execution_time property value in your PHP configuration.
2. Use Scheduler to perform automatic backups (recommended).
3. Use Console commands to perform backups.

Settings

This plugin ships with settings page. Go to Settings, and you will see a menu item Backup Manager listed under Backup section.

Source

Destination

Scheduler

Configure how often plugin will run automatic tasks for database backup, application backup, clean old backups and monitor the health of all backups actions.

Important note: For scheduled tasks to operate correctly you must set up the scheduler: https://octobercms.com/docs/setup/installation#crontab-setup

Security

Here you can specify password protection for backups. You will be asked to enter this password in order to unzip the backup file.

Password

Remember to use long strings and to keep your password safe – without it, you will never be able to open your backup .

Leave it blank if you want to keep your backup without a password.

Encryption

It's common to encrypt backups before storing them somewhere to prevent unauthorized access.

It's important to try this workflow and also to decrypt a backup archive, so you know that it works and you have a working backup restore solution.

Warning: the default MacOS app to (un)archive ZIPs seems unable to open/extract encrypted ZIP files. You should use an app like The Unarchiver or BetterZip.

Cleanup

Monitoring

A backup is considered unhealthy if the date of the latest backup is too far in the past to be useful or if the amount of storage space required for all backups is not available.

Dumping the database

The mysqldump/pg_dump are used to dump the database. If they are not installed in a default location, you can add a key named dump.dump_binary_path in October database.php config file. Only fill in the path to the binary. Do not include the name of the binary itself.

If your database dump takes a long time, you might exceed the default timeout of 60 seconds. You can set a higher (or lower) limit by providing a dump.timeout config key which specifies, in seconds, how long the command may run.

Here's an example for MySQL:

// 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',
        ]
    ],

There is also a setting in backend area to exclude database tables from backup. By default, it will exclude logs tables.

Configuring the backup disk

By default, the backup will be saved into the storage/app/October CMS/ directory of your October application. This folder most probably is configured to be public. We recommend that you create a disk named backups (you can use any name you prefer) in filesystems.php and select this disk in plugin Settings.

Filesystems

Plugin supports following storage drivers:

• Local Storage
• S3 Cloud Storage
• FTP Storage
• SFTP Storage
• Dropbox Cloud Storage

More drivers can be added on feature requests. Just create an issue with [Feature Request] in title, and I will see what can be done.

The filesystem configuration file is located at config/filesystems.php. Within this file you may configure all of your "disks". Example configurations for each supported driver is included in the configuration file. So, simply modify the configuration to reflect your storage preferences and credentials!

S3 Driver Configuration

Before using the S3 driver, you will need to install the Flysystem S3 package via the Composer package manager:

composer require league/flysystem-aws-s3-v3 "^3.0"

The S3 driver configuration information is located in your config/filesystems.php configuration file.

After filesystem configuration go to plugin Settings and check s3 disk in Destination tab.

FTP Driver Configuration

Before using the FTP driver, you will need to install the Flysystem FTP package via the Composer package manager:

composer require league/flysystem-ftp "^3.0"

Laravel's Flysystem integrations work great with FTP; however, a sample configuration is not included with the framework's default filesystems.php configuration file. If you need to configure an FTP filesystem, you may use the configuration example below:

'ftp' => [
    'driver' => 'ftp',
    'host' => env('FTP_HOST'),
    'username' => env('FTP_USERNAME'),
    'password' => env('FTP_PASSWORD'),

    // Optional FTP Settings...
    // 'port' => env('FTP_PORT', 21),
    // 'root' => env('FTP_ROOT'),
    // 'passive' => true,
    // 'ssl' => true,
    // 'timeout' => 30,
],

After filesystem configuration go to plugin Settings and check ftp disk in Destination tab.

SFTP Driver Configuration

Before using the SFTP driver, you will need to install the Flysystem SFTP package via the Composer package manager:

composer require league/flysystem-sftp-v3 "^3.0"

Laravel's Flysystem integrations work great with SFTP; however, a sample configuration is not included with the framework's default filesystems.php configuration file. If you need to configure an SFTP filesystem, you may use the configuration example below:

'sftp' => [
    'driver' => 'sftp',
    'host' => env('SFTP_HOST'),

    // Settings for basic authentication...
    'username' => env('SFTP_USERNAME'),
    'password' => env('SFTP_PASSWORD'),

    // Settings for SSH key based authentication with encryption password...
    'privateKey' => env('SFTP_PRIVATE_KEY'),
    'password' => env('SFTP_PASSWORD'),

    // Optional SFTP Settings...
    // 'hostFingerprint' => env('SFTP_HOST_FINGERPRINT'),
    // 'maxTries' => 4,
    // 'passphrase' => env('SFTP_PASSPHRASE'),
    // 'port' => env('SFTP_PORT', 22),
    // 'root' => env('SFTP_ROOT', ''),
    // 'timeout' => 30,
    // 'useAgent' => true,
],

After filesystem configuration go to plugin Settings and check sftp disk in Destination tab.

Dropbox configuration

Install Dropbox Adapter plugin.

Read this external plugin documentation and configure Dropbox filesystem.

After filesystem configuration go to plugin Settings and check dropbox disk in Destination tab.

Console commands

Plugin will create three new artisan commands for working with a console.

backup:run command will run new backup process. Add --only-db option for backup only database.

backup:clean command will run clean old backups process.

backup:list command will display status of all monitored destination filesystems.

backup:monitor command will check status of all monitored destination filesystems.

Mail notifications

Plugin can send notifications when:

• backup was successful,
• backup has failed,
• cleanup was successful,
• cleanup has failed,
• healthy backup was found,
• unhealthy backup was found.

To configure this feature go to plugin Settings and Notifications tab.

Upgrading To 2.0.0

Plugin requires October CMS build 420+ with Laravel 5.5 and PHP >=7.0.

Plugin settings was reset to defaults, so please review and update them for your project needs.

Upgrading To 2.1.0

Dropbox's integration was moved to external Dropbox Adapter plugin. Read this plugin documentation how to configure Dropbox filesystem.

Upgrading To 2.1.4

Plugin requires setting database port in a config. This only affects older installations of October CMS.

Upgrading To 3.0.0

Main dependency spatie/laravel-backup was updated to 5.6.4 version.

Upgrading To 4.0.0

Plugin requires October CMS build 467+ with Laravel 6.x and PHP >=7.2.

Upgrading To 4.1.0

Plugin requires October CMS 1.x with Laravel 6.x and PHP >=7.3.

Upgrading To 4.2.0

Plugin requires October CMS version 2.x with Laravel 6.x and PHP >=7.3.

Drop support for October CMS version 1.x.

Upgrading To 5.0.0

Plugin requires October CMS version 3.0 or higher, Laravel 9.0 or higher and PHP >=8.0.

Drop support for October CMS version 2.x.

Upgrading To 5.1.0

Mail notification settings has changed. Please go to Settings -> Backup Manager -> Notifications tab and configure them again if you use them.