README

A simple way to perform database backups in Craft CMS 4/5.

This version of Dump was ported from the original Craft 2 version with permission by Ben Croker.

Requirements

This plugin requires Craft CMS 4.0.0-alpha or later, or Craft CMS 5.x or later.

Installation

To install the plugin, follow these instructions:

Automated Installation

Visit the Plugin Store within your Craft project Control Panel. Search for "DB Dump" and select the plugin. Click install.

Manual Installation

1. Open your terminal and go to your Craft project:

    cd /path/to/project
   

2. Then tell Composer to load the plugin:

    composer require swishdigital/db-dump
   

3. In the Control Panel, go to Settings → Plugins and click the “Install” button for DB Dump.

Configuring DB Dump

Before You Begin

Open your config/general.php file and add

'extraAllowedFileExtensions' => 'sql'

to either your global settings array, or the array for the environment where you want to perform backups.

Settings

In the Craft Control Panel, navigate to Settings > Plugins > DB Dump > Settings. Set a key, choose an asset volume with which to store your backups, and set a number of old backups to keep.

Using DB Dump

To run a backup, create a GET or a POST request to the DB Dump action URL.

Link to the Backup Function in a Twig Template:

<a href="{{ actionUrl('/db-dump', { key: '" ~ key ~ "' }) }}">Backup Now</a>

Trigger a Backup by Visiting a URL in your Browser:

https://domain.com/index.php?p=actions/db-dump&key=12345

Setup a CRON Job to Trigger Backups on a Regular Interval:

Your server CRON syntax may vary. Try either of the examples below. Ensure you've set (above) the maximum number of backups to keep, unless you potentially want many, many backups.

wget https://domain.com/index.php?p=actions/db-dump&key=12345 >/dev/null 2>&1

or

curl -s -o /dev/null "http://aamgi.loc/actions/db-dump?key=12345678"

DB Dump Roadmap

Some things to do, and ideas for potential features:

• Nothing at this time

Brought to you by Swish Digital