#5

Product support

Visit this product's website for support.

Categories

  • Developer Tools
  • Miscellaneous
  • Security
  • Utility

Backup Manager Plugin

Backup your whole October application with ease.

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.

Installation

Use October Marketplace and Add to project button.

Features

  • Backup database and application files with mouse click
  • Amazon S3, Rackspace, Dropbox Cloud storage support
  • MySQL, PostgreSQL, SQLite and Mongo databases support
  • Configurable scheduler for automatic backups
  • Extensive settings options

Requirements

This plugin requires PHP 7 or higher with the ZIP module and Laravel 5.5 or higher. It's not compatible with Windows servers.

The plugin 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.

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.

Like this plugin?

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

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.

Delete selected button will delete selected backups. This action is irreversible, so be careful.

Clean old backups button will cleanup old backups based on plugin Settings.

View latest backup log button will show latest backup log in popup window.

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

To download backup just click position on the list.

Searching backups list

Backups names are created dynamically from current datetime. This allows to easily search for backups created at specific date and time.

Maximum execution time error

When you experience Maximum execution time of .. seconds exceeded error than most likely application backup is to 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 a 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.
Gzip database dump The database dump can be gzipped to decrease disk space usage.
Follow links Determines if symlinks should be followed.
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.configured on your chosen filesystem(s)
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 and clean old backups actions.

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

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.

Dumping the database

mysqldump and 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',
        ]  
    ],

Filesystems

Plugin supports following storage drivers:

  • Local 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.

Console commands

Plugin will create three new artisan commands for working with 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.

  • 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 [email protected] 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!

2.1.0

!!! Move Dropbox filesystem adapter to external plugin. Pending

Oct 12, 2017

2.0.0

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

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

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 integration was moved to external Dropbox Adapter plugin. Read this plugin documentation how to configure Dropbox filesystem.