WP Offsite Backup

WP Offsite Backup is a Shell script for backup WordPress to offsite.

Features

Backup WordPress files and Databases
Compression algorithm with GNU Gzip or Zstandard
Store backup file to Storage Service (Amazon S3)
Scheduled automatic backup via Cron
Setting customized configuration
Rotate stored backup files by number of files
Logging history

Example

Manual backup

bash wp-offsite-backup

Scheduled automatic backup via Cron

crontab -e

MAILTO=hoge@example.com

20 0 * * * bash /path/to/wp-offsite-backup/bin/wp-offsite-backup

Supported Storage Service

Amazon S3

Future plans

Required commands

mysqldump
mktemp
tar (GNU Tar)
gzip (GNU Gzip, selective)
zstd (Zstandard, Version 1.3.8 later, selective)
aws (AWS Command Line Interface)

Getting Started

1. Clone to wp-offsite-backup directory

git clone https://github.com/thingsym/wp-offsite-backup wp-offsite-backup

2. Change directory

cd wp-offsite-backup

3. Set permission

chmod +x bin/wp-offsite-backup

4. Edit configuration as default settings.

vi config/default

5. Edit database configuration

vi config/.default.my.cnf

6. Testing backup

bash bin/wp-offsite-backup

have fun!

Configuration

WP Offsite Backup Configuration

JOB_NAME="WordPress backup"
BACKUP_NAME=wordpress-backup-`date +%Y-%m-%d_%H-%M-%S`
COMPRESS=gzip
MAX_SAVED_FILES=12
SKIP_VERIFY_FILE=false

WP_ROOT_PATH=/var/www/html
DB_NAME=wordpress
MYSQL_EXTRA_FILE=.default.my.cnf
MYSQL_FILE=wordpress.sql

USER_LOCAL_BIN_PATH=

AWS_PROFILE=
S3_URI=
S3_STORAGE_CLASS=STANDARD_IA

EXCLUDE_EXTRA=(
  ".git"
  ".DS_Store"
)

EXCLUDE_WP_CONTENT=()

EXCLUDE_WP_CORE=()

LOG_FILE=history.log
LOG_FORMAT=common
MAX_LOG_LINES=300

JOB_NAME name of backup job
BACKUP_NAME name of backup (default: wordpress-backup-`date +%Y-%m-%d_%H-%M-%S`)
- based on the backup file name e.g wordpress-backup-2018-01-08_08-48-27.tar.gz
COMPRESS type of compression algorithm (value: gzip | zstd)
MAX_SAVED_FILES maximum number of backup files to stored (default: 12)
- When the number of stored files exceeds the maximum stored number, backup files are deleted from the older update date and time.
- Set to 0 if saving unlimitedly
SKIP_VERIFY_FILE skip verifying compressed file integrity (default: false, value: false | true)
WP_ROOT_PATH document root of WordPress (default: /var/www/html)
DB_NAME name of database (default: wordpress)
MYSQL_EXTRA_FILE name of mysql database configuration file (default: .default.my.cnf)
MYSQL_FILE name of database backup data file (default: wordpress.sql)
USER_LOCAL_BIN_PATH path for pip install --user as ~/.local/bin (default: ``)

Note: Add / at the end of the path

USER_LOCAL_BIN_PATH=/home/user/.local/bin/

AWS_PROFILE aws configure named profile (default: default)
- see Named Profiles - Configuring the AWS CLI
S3_URI path of a S3 bucket or prefix e.g s3://[bucket]/[prefix]/
S3_STORAGE_CLASS type of s3 storage class (default: STANDARD_IA, value: STANDARD_IA | STANDARD)
EXCLUDE_EXTRA list exclude files or directories

Configuration example

EXCLUDE_EXTRA=(
  ".git"
  ".DS_Store"
)

empty the setting case

EXCLUDE_EXTRA=()

EXCLUDE_WP_CONTENT list exclude files or directories in wp-content
EXCLUDE_WP_CORE list exclude files or directories in WordPress Core files
LOG_FILE name of log file
LOG_FORMAT type of log format (default: common / value: common | ltsv)
MAX_LOG_LINES maximum number of log lines (default: 300)
- When the number of log lines exceeds the maximum number of lines, log lines are deleted from the older lines.
- Set to 0 if logging unlimitedly

Database Configuration

Database configuration file is invisible file as dot-file. e.g .default.my.cnf

[client]
user = put_database_user
password = put_database_password
host = localhost
port = 3306

user Database user name
password Database password
host Database host (default: localhost)
port Database port number (default: 3306)

And supports the other options. See mysql Options

Preset Configuration

The preset config is stored in config directory

config-sample
db-only-backup-config
full-backup-config
partial-backup-config
wp-content-only-backup-config

Script directory layout

|- bin
|    |- wp-offsite-backup (core shell script)
|- config (Stores Configuration files)
|    |- .default.my.cnf (default database configuration file)
|    |- .sample.my.cnf
|    |- backup-testing
|    |- config-sample
|    |- db-only-backup-config
|    |- default (default configuration file)
|    |- full-backup-config
|    |- partial-backup-config
|    |- wp-content-only-backup-config
|- LICENSE
|- log (Stores log files)
|- README.md
|- tmp.XXXXXXXXXX (Create a temporary directory automatically when starting script execution. Delete a temporary directory at the end of script execution.)

Archive directory layout

Archived file format is tar.gz or tar.zst.

|- database (Stores database backup file)
|    |- wordpress.sql
|- wp-config.php
|- wp-content
|- WordPress Core files and more...

How to customized configuration

Create customized configuration as configuration name customized-config

cp config/config-sample config/customized-config

Create MYSQL_EXTRA_FILE as configuration name .customized-config.my.cnf

cp config/.sample.my.cnf config/.customized-config.my.cnf

Edit customized configuration

vi config/customized-config

Note: set MYSQL_EXTRA_FILE to .customized-config.my.cnf

Run backup using customized configuration customized-config.

bash bin/wp-offsite-backup customized-config

Scheduled automatic backup via Cron

crontab -e

Note: Pass configuration name customized-config to environment variable WP_OFFSITE_BACKUP_CONFIG

MAILTO=hoge@example.com

20 0 * * * WP_OFFSITE_BACKUP_CONFIG=customized-config bash /path/to/wp-offsite-backup/bin/wp-offsite-backup

Command Reference

SYNOPSIS

Run backup using config/default configuration as default settings.

wp-offsite-backup

Command parameter

wp-offsite-backup <parameter>

Run backup using customized settings.

Note: Pass configuration name to parameter

wp-offsite-backup <config>

List configuration.

wp-offsite-backup --config

Display command info and usage.

wp-offsite-backup --help

Log Format

There are two log formats, common and ltsv.

The format of the common log is as follows.

[{%Y-%m-%d %H:%M:%S}] [status] [config] message

Example log format is as follows.

[2018-02-20 12:49:34] [Success] [default] WordPress Backup complete!

The format of the ltsv log format is as follows.

time:%Y-%m-%d %H:%M:%S\tstatus:status\tconfig:config"\tmessage:message

Example log format is as follows.

time:2018-02-20 11:55:24	status:Success	config:default	message:WordPress Backup complete!

Reference: Labeled Tab-separated Values

Tips

Adding a command path to $PATH

The way to add a path to $PATH (the environment variable) is with the export command.

echo "export PATH=\$PATH:/path/to/wp-offsite-backup/bin" >> ~/.bash_profile
source ~/.bash_profile

The other way to make a symbolic link to /usr/bin.

sudo ln -s /path/to/wp-offsite-backup/bin/wp-offsite-backup /usr/bin

Alert mail via Cron

Send log by email only on error as alert mail. Just log it when the backup is successful.

MAILTO=hoge@example.com

20 0 * * * bash /path/to/wp-offsite-backup/bin/wp-offsite-backup >/dev/null

Contribution

Patches and Bug Fixes

Small patches and bug reports can be submitted a issue tracker in GitHub. Forking on GitHub is another good way. You can send a pull request.

Fork WP Offsite Backup from GitHub repository
Create a feature branch: git checkout -b my-new-feature
Commit your changes: git commit -am 'Add some feature'
Push to the branch: git push origin my-new-feature
Create new Pull Request

Changelog

Version 0.9.1
- fix test case
- add date and time to message
- add timeout-minutes to workflows
Version 0.9.0
- add backup testing config
- fix exclude with config
- add double quotes
- add main function
- fix typo
- fix label
Version 0.8.0
- perf: add --no-tablespaces option on mysqldump for MySQL 5.7.31
- ci: add GitHub actions, remove .travis.yml
- perf: add size of the folder in S3 bucket
Version 0.7.0
- perf: fix error head:illegal line count -- for FreeBSD
Version 0.6.0
- perf: add checking zstd version
Version 0.5.0
- test: fix test case
- perf: add user local bin path for pip install --user
- fix: change function name
- perf: add skip option that verifying compressed file integrity
- fix: fix error mktemp: illegal option -- p
- perf: add start and end timestamps
- perf: add option --no-progress with zstd
Version 0.4.0
- test: fix test case
- perf: add s3 storage class option
- feat: add compression algorithm Zstandard
- perf: improve message information
- perf: add mysqldump options
- perf: change function name
Version 0.3.1
- test: fix .travis.yml
- fix: fix exit status 1 with tar
- perf: add .sample.my.cnf
- test: update install-wp-tests.sh
Version 0.3.0
- perf: test backup file for integrity
- perf: change to case statement where command option is passed
- perf: fix usage
Version 0.2.3
- refactor: fix initialized CONFIG
- test: add tests
- test: add .travis.yml
Version 0.2.2
- perf: add log format LTSV
- refactor: fix format
- refactor: change to local value
- refactor: change to create tmp directory using mktemp command
- refactor: change to delete tmp directory using trap command
- perf: add command path info
- perf: add set command option
Version 0.2.1
- perf: run command via symbolic link
Version 0.2.0
- refactor: add BASEPATH to the path
- perf: create database dir
- perf: store core shell script in bin directory
- perf: add database port
Version 0.1.0
- initial release

License

distributed under GPLv3.

Author

thingsym