Backup the Database

The purpose of this script is to backup and optionally --sanitize the database of your Backdrop CMS website.

Requirements

• Linux server
• Backdrop CMS website
• PHP CLI

Installation and Configuration

Clone this directory down to your filesystem. Perhaps to your home directory.

• git clone [email protected]:serundeputy/sql-dump-sanitize.git
• cd sql-dump-sanitize

Copy the config.ini.example file to config.ini

• cp config.ini.example config.ini
• Set the config variables in config.ini to values appropriate for your server and Backdrop database.

; This user must have access to create and drop databases to use `--sanitize`
DB_USER = root
; Password of the above user
DB_PASSWORD = pass
; Database to perform backups of and optionally `--sanitize`
DB_NAME = backdrop
; Temporary database to use when sanitizing. It will be created automatically.
DB_TEMP = temp
; Host of the database; usually localhost, but could be an external name or IP
DB_HOST = localhost
; Root directory of the Backdrop installation
BACKDROP_ROOT = /var/www/html
; Directory where you would like the backups to be stored
BACKUP_DESTINATION = /home/user/me/backups

Usage

One time use database backups

• php path/to/sql-dump-sanitize.php
  • This will create a backup of the database written to the BACKUP_DESTINATION specified in config.ini.
• Options:
  • --quiet (-q alias) suppress standard output (good for running as cron job).
  • --sanitize (-s alias) sanitize user email addresses for the backup. Sanitized backups are placed in BACKUP_DESTINATION/sanitized subdirectory.
  • --rollover (-r alias) remove stale backups where stale is defined by the NUM_KEEP config variable.
  • --latest (-l alias) provide a symlink to the latest backup named DB_NAME-latest[-sanitized].sql.gz.

One time use files directory backups

• php path/to/files-backup.php
  • This will create a backup of the files directory written to the BACKUP_DESTINATION/files_backups specified in config.ini.
• Options:
  • --rollover_files (-rf alias) remove stale files directory backups where stale is defined by the NUM_KEEP config variable.
  • --latest (-l alias) provide a symlink to the latest backup named files-latest.tar.gz.

To run periodically on cron

• Set a server cron task to run the script on a schedule (daily, weekly, monthly or any combination). For example, weekly at 8.05am Saturday morning; the cron job would look like this:

# 1. Entry: Minute when the process will be started [0-60]
# 2. Entry: Hour when the process will be started [0-23]
# 3. Entry: Day of the month when the process will be started [1-28/29/30/31]
# 4. Entry: Month of the year when the process will be started [1-12]
# 5. Entry: Weekday when the process will be started [0-6] [0 is Sunday]

# Database backup #
###################
5 8 * * 6 {/absolute/path/to/php} {/path/to/script/}sql-dump-sanitize.php --quiet

# Files directory backup #
##########################
5 8 * * 6 {/absolute/path/to/php} {/path/to/script/}files-backup.php --rollover_files

Happy backups ;)