15

Product support

Visit this product's website for support.

Categories

Backup Manager Plugin

USE BLACKFRIDAY21 CODE COUPON TO RECEIVE 30% DISCOUNT!

Backup your whole October application with ease.

This plugin is fully compatible with the latest version of OctoberCMS 2.x from version 4.2.0.

The latest version that supports OctoberCMS 1.x is version 4.1.0.

The backup is a zip file that contains all files in the directories you specify along with a dump of your database. The backup can be stored on any of the filesystems you have configured in October. You can backup your application to multiple filesystems at once. In addition to making the backup, the plugin can also clean up old backups and monitor health of all backups.

OctoberCMS Backup Manager

Features

  • A backup database and application files with mouse click
  • FTP, Amazon S3, Rackspace, Dropbox Cloud storage support
  • MySQL, PostgreSQL, SQLite and Mongo databases support
  • A configurable scheduler for automatic backups
  • Automatic cleanup old backups
  • Extensive settings options
  • Encryption and password protection
  • Monitoring the health of all backups
  • Mail notifications

Requirements

This plugin requires PHP 7.3, with the ZIP module and Laravel 6.x. It's not compatible with Windows servers.

The package needs free disk space where it can create backups. Ensure that you have at least as much free space as the total size of the files you want to backup.

Make sure mysqldump is installed on your system if you want to backup MySQL databases.

Make sure pg_dump is installed on your system if you want to backup PostgreSQL databases.

Make sure mongodump is installed on your system if you want to backup Mongo databases.

Why is this a paid plugin?

Something that is free has little or no perceived value. Users do not commit to free products and only use them until something else looks nice and is free comes along. When I invest my time in the development of a new plugin I commit to supporting and maintaining it. I ask my customers to do the same. I do not make money from this plugin by advertisements, upgrades or additional services like hosting or setup.

Did you know that 30% of your purchase or donation goes to help fund the October Project?

My plugins take many hours to develop (40-120+) and even more hours to document and maintain. My paid plugins have to pay for both this time, and the time I am spending on free plugins and less successful paid plugins. This means that it will take even a successful plugin years to become profitable. Please consider buying an extended license if you want me to continue to maintain these plugins for the very small fee I ask in return or hire me for adding functionality that you feel is missing but valuable.

Like this plugin?

If you like this plugin, give this plugin a Like or Make donation with PayPal.

My other plugins

Please check my other plugins.

Support

Please use GitHub Issues Page to report any issues with plugin.

Reviews should not be used for getting support or reporting bugs, if you need support please use the Plugin support link.

Documentation

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

Property Description
Databases The names of the connections to the databases that should be backed up. MySQL, PostgreSQL, SQLite and Mongo databases are supported.
Exclude tables Those tables will not be included in backup.
Gzip database dump The database dump can be gzipped to decrease disk space usage.
Follow links Determines if symlinks should be followed.
Ignore unreadable directories Determines if it should avoid unreadable folders.
Include The list of directories and files that will be included in the backup. Leave empty to backup whole October project.
Exclude These directories and files will be excluded from the backup. Directories used by the backup process will automatically be excluded.

Destination

Property Description
Filename prefix The filename prefix used for the backup zip file.
Name The name of this application.
Disks The disk names on which the backups will be stored.

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

Property Description
Keep all backups for days The number of days for which backups must be kept.
Keep daily backups for days The number of days for which daily backups must be kept.
Keep weekly backups for weeks The number of weeks for which one weekly backup must be kept.
Keep monthly backups for months The number of months for which one monthly backup must be kept.
Keep yearly backups for years The number of years for which one yearly backup must be kept.
Delete oldest backups when using more megabytes than After cleaning up the backups remove the oldest backup until this amount of megabytes has been reached.

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.

Property Description
Newest backups should not be older than days Send mail notification when newest backup will be older than given days. Default to 1 day.
Storage used may not be higher than megabytes Send mail notification when storage used for backups will be higher than given megabytes. Default to 5000 megabytes. Setting to 0 means the monitor will consider that the backup can use unlimited storage.

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.

Filesystems

Plugin supports following storage drivers:

  • Local Storage
  • FTP Storage
  • Amazon S3 Cloud Storage
  • Rackspace Cloud 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!

Amazon S3 and Rackspace configuration

Install October Drivers plugin.

Go to plugin Settings and check s3/rackspace disk in Destination tab.

Dropbox configuration

Install Dropbox Adapter plugin.

Read this external plugin documentation and configure Dropbox filesystem.

Go to plugin Settings and check dropbox disk in Destination tab.

FTP configuration

Add new filesystem disk in disks array in config/filesystems.php:

'ftp' => [
    'driver'   => 'ftp',
    'host'     => '',
    'username' => '',
    'password' => '',
    'root'     => '',
    'ssl'      => true,
],

Go to plugin Settings and check ftp 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.

  • Found the plugin useful on 16 May, 2021

    Really nice Plugin, after I got rid of some problems. Maybe this could help the developer or other users to make it work if this problems occur.

    1) execution timeout / memory limit Edit "plugins\renatio\backupmanager\vendor\spatie\laravel-backup\src\Commands\BackupCommand.php" and add the following lines and adjust the values to your needs:

            ini_set("memory_limit",4000);
            set_time_limit(300);
            ini_set('default_socket_timeout', 6000);

    2) 504 Gateway Timeout I figured out, that this error occure if you enable the password encryption. Password encryption will be executed by "laravel-backup-shild". Replace the folder "src" in "plugins\renatio\backupmanager\vendor\olssonm\laravel-backup-shield\" with the newest version on "https://github.com/olssonm/laravel-backup-shield".

  • Found the plugin useful on 7 Aug, 2019

    Great plugin thanks ! Do you plan an restore backup options ?

  • Found the plugin not useful on 15 May, 2019

    Doesn't Work anymore

  • author

    Replied on 17 May, 2019

    Thank you for very useful review!

    Just checked and works fine with latest build.

    Reviews should not be used to get support or report issues. For the future please use support link on plugin page.

  • Found the plugin useful on 16 Jan, 2019

    Hello good afternoon I bought the 2FA plugin I have the following problem: How can I force other users to activate 2FA every time they enter the backend?

    Awaiting your reply

  • Found the plugin useful on 14 Sep, 2018

    Very great plugin! It would be better if there is a notification (email) when something wrong in backup process :) Thanks!

  • author

    Replied on 19 Jun, 2020

    This is now available in the newest version!

  • Found the plugin not useful on 25 May, 2018

    BUG

    "Type error: Argument 1 passed to Spatie\Backup\Tasks\Backup\BackupJobFactory::createDbDumpers() must be of the type array, null given, called in /var/www/html/plugins/renatio/backupmanager/vendor/spatie/laravel-backup/src/Tasks/Backup/BackupJobFactory.php on line 14" on line 25 of /var/www/html/plugins/renatio/backupmanager/vendor/spatie/laravel-backup/src/Tasks/Backup/BackupJobFactory.php

  • author

    Replied on 27 May, 2018

    Reviews should not be used to get support or report issues. For the future please use support link on plugin page.

    https://github.com/mplodowski/backupmanager-plugin-public/issues/6

  • Found the plugin useful on 30 Dec, 2017

    This is a great plugin which does exactly what you require from a backup plugin. Everything worked first time without a problem. Well worth the price.

    Thank you to Renatio / Michel who has been super responsive to a special request I had.

  • Found the plugin useful on 1 Nov, 2017

    Hi , I just installed the plugin but its not working . It makes backup with db but not files. My include files repeater doesn't have anything. I am not sure what's going on. Thanks

  • author

    Replied on 1 Nov, 2017

    Hi,

    reviews should not be used to get support or report issues. For the future please use support link on plugin page.

    Please contact me at michal.plodowski@gmail.com or report an issue on gitHub.

    Regards,

    Michal

  • Found the plugin useful on 17 May, 2017

    Brilliantly easy, super reliable and generally couldn't do without it.

  • Found the plugin useful on 30 Dec, 2016

    This is a very good must have plugin. I agree with the other reviews though about wanting a way to upload a backup that is not in the database.

  • Found the plugin useful on 26 Jul, 2016

    Its a good plugin but in my opinion has a fatal flaw (unless i am missing something).

    The backup archives are listed in the database which means you cannot upload a backup that you have previously downloaded and stored elsewhere. So it works fine if you want to roll back to a previous state but if you wanted to reinstate the application from scratch you have to insert db rows to get the backups to display. It would not be hard to implement a backup import/upload feature.

  • Found the plugin useful on 16 Dec, 2015

    Mindblowing plugin and excellent support from Renatio. This is simply a must for any serious OctoberCMS developer.

  • Found the plugin useful on 20 Aug, 2015

    Can't remember how many times backup feature saved my life and that plugin allow me manage all backups in backend. Also Michal (developer) giving fast good feedbacks! Thank you

  • Found the plugin useful on 2 Jul, 2015

    Is a mistake for developers around the world, not to consider the backups of your application and database. Nowadays, the chances to lose information is huge. This plugin is amazing. Remember to install mysql package in your webserver, if you have 2 different servers: (one for webserver and one for database server)...

  • Found the plugin useful on 8 Jun, 2015

    This is EXACTLY what I was looking for. I am currently using DigitalOcean with Laravel Forge and this works perfectly. Must have app on every October site. Just purchased it for a couple projects. Have been hoping that DigitalOcean offered easy database and application backups but they have been really slow to implement that functionality so this app is PERFECT.

    Can't thank you enough. Very happy with this and keep up the killer work. I'll be supporting this plugin with every project and highly recommending it to others.

    Cheers!

4.2.2

Update docs.

Sep 26, 2021

4.2.1

Set configuration defaults.

Sep 14, 2021

4.2.0

Support OctoberCMS 2.0.

Sep 11, 2021

4.1.0

Rewrite plugin core.

Sep 11, 2021

4.0.1

Add option to ignore unreadable directories.

Sep 11, 2021

4.0.0

!!! Add support for Laravel 6. Only update for Laravel 6 and October >= 1.1!

Sep 11, 2021

3.3.4

Elevate plugin permission.

Sep 16, 2020

3.3.3

Fix memory limit check.

Jul 03, 2020

3.3.2

Fix listing database tables in settings.

Jun 26, 2020

3.3.1

Improve mail notifications.

Jun 19, 2020

3.3.0

Mail notifications for backup events.

Jun 19, 2020

3.2.6

Fix Symfony dependency error.

Jun 18, 2020

3.2.5

Add FTP configuration example to README.

Jun 18, 2020

3.2.4

Add settings to exclude database tables from backup.

Jun 18, 2020

3.2.3

Add action buttons to list.

Jun 18, 2020

3.2.2

Add 'proc_open' check as system requirement.

Jun 18, 2020

3.2.1

Simplify backups cleanup.

Jun 18, 2020

3.2.0

Fix Gzip database compression.

Jun 18, 2020

3.1.0

Update dependencies.

Jun 18, 2020

3.0.2

Minor fix.

Jul 21, 2018

3.0.1

Add password protection for backups.

Jul 15, 2018

3.0.0

!!! Update all dependencies. Require PHP >= 7.1.

Jul 15, 2018

2.1.4

Remove database port check.

Jul 15, 2018

2.1.3

Fix wrong script name.

Jul 15, 2018

2.1.2

Default to database from config.

Jul 15, 2018

2.1.1

Fix minor issue with cleanup of old backups.

Dec 20, 2017

2.1.0

!!! Move Dropbox filesystem adapter to external plugin.

Oct 12, 2017

2.0.0

!!! Rewrite plugin core and add support for Laravel 5.5.

Oct 12, 2017

1.0.10

Allow to add extra parameters to MySQL dump command. Better database error handling.

Mar 12, 2017

1.0.9

Check for driver name, not connection name.

Mar 12, 2017

1.0.8

Fix issue with not deleted temp files after backup finished.

Jun 18, 2016

1.0.7

Fix bug with empty port in database config.

Mar 09, 2016

1.0.6

Add system requirements check and fix bug with download backup response.

Aug 23, 2015

1.0.5

Dropbox Adapter Support

Jul 20, 2015

1.0.4

Fix bug for PHP 5 < 5.6

Jul 05, 2015

1.0.3

Minor changes.

Jun 15, 2015

1.0.2

Added PostgreSQL support.

Jun 05, 2015

1.0.1

First version of Backup Manager plugin.

May 26, 2015

Upgrade guide

Upgrading To 2.0.0

Plugin requires OctoberCMS 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 OctoberCMS.

Upgrading To 3.0.0

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

Upgrading To 4.0.0

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

Upgrading To 4.1.0

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

Upgrading To 4.2.0

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

Drop support for OctoberCMS version 1.x.