docker-backup

Make a backup of your docker-compose stack. It's simple, init BorgBackup repository, dump database, "build" a command to create a files backup and do it.

---

• Install
  • Requirements
• Backup
  • Init
  • Run
  • Restore
• Example

Install

Just clone this repository

clone git@github.com:eXtalionLab/docker-backup.git .

and create a link to the script docker-backup

sudo ln -sr docker-backup/docker-backup /usr/local/bin/docker-backup

Requirements

BorgBackup has to be installed on local machine!

Backup

Init

Goto directory with the app that you want to backup and run:

docker-backup install

It will create a new file .docker-backup.dist:

###> config ###
backupDir='backups'
dockerDbServiceName='db'
# Use local image to skip download
dockerImgToBackupVolumes='alpine'
dockerVolumesDir='docker_volumes'
# Allow types: custom, mariadb, mongo, mysql, postgresql
dbType='mysql'
envFile='.env'
###< config ###

###> files/volumes to backup ###
filesToBackup=( \
  "${envFile}" \
)
filesToExclude=()
# Remember to prefix volumes with docker-compose project name
volumesToBackup=()
###< files/volumes to backup ###

###> borg ###
export BORG_REPO='backups/app'
export BORG_PASSPHRASE='Change_me!'
###< borg ###

Config name	Type	Default value	Description
backupDir	string	backups	It's a directory where backup logs will be stored.
dockerDbServiceName	string	db	It's a name of your docker-compose database service.
dockerImgToBackupVolumes	string	alpine	You can put here your image name just to skip download new one.
dockerVolumesDir	string	docker_volumes	Where to temporary store a files from docker volumes.
dbType	string	mysql	What kind of database are you using? Allow types are: custom, mariadb, mongo, mysql, postgresql.
envFile	string	.env	File from where we will read data to connect to database. For mariadb/mysql we require MYSQL_DATABASE, MYSQL_PASSWORD, MYSQL_USER. For mongo we require MONGO_DATABASE, MONGO_USER, MONGO_PASSWORD. For postgresql we require POSTGRES_DB, POSTGRES_USER.
filesToBackup	array	[ ${envFile} ]	Files/directories to backup.
filesToExclue	array	[]	Files/directories to exclude from backup. Eg. var, cache, *.log.
volumesToBackup	array	[]	Volumes to backup. Remember to prefix them with project name
BORG_REPO	string	backups/app	Where to store a backup. It can be a local directory or remote path via ssh.
BORG_PASSPHRASE	string	Change_me!	Password to protect a backup.

File .docker-backup.dist is good as a template. See example here for Prestashop. After that in specific project you should create a .docker-backup (cp .docker-backup.dist .docker-backup) file, "fix" an admin directory name and BORG_* config.

Read more about BORG_* config here.

Run

When you're done with .docker-backup[.dist] file(s) just run:

docker-backup run

and wait for a result.

Restore

How to restore borg's backup you can read here.

You should shutdown docker-compose stack before restore a backup:

docker compose down [-v]

The basic option is to run:

source .docker-backup[.dist]
borg list
# Choose which backup to restore
borg extract ::${backup_to_restore} -p

Then start up your stack and wait when database will be ready:

docker compose up [-d]

If you have any volumes, it's time to restore them:

docker-backup restore_volumes

Example

Goto an example/ directory to see how to use docker-backup.