https://github.com/techknowlogick/restic-mysqldump-docker

Docker image that backs up MariaDB/MySQL to S3 via restic.
https://github.com/techknowlogick/restic-mysqldump-docker

backup docker mariadb mysql restic restic-backups

Last synced: 7 days ago
JSON representation

Docker image that backs up MariaDB/MySQL to S3 via restic.

• Host: GitHub
• URL: https://github.com/techknowlogick/restic-mysqldump-docker
• Owner: techknowlogick
• License: mit
• Created: 2020-05-23T04:04:49.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-05-23T06:19:56.000Z (over 4 years ago)
• Last Synced: 2024-11-23T16:43:09.981Z (2 months ago)
• Topics: backup, docker, mariadb, mysql, restic, restic-backups
• Language: Shell
• Homepage:
• Size: 43.9 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# restic-mysqldump

Docker image that runs `mysqldump` individually for every database on a given server and saves incremental encrypted backups via [restic].

By default:

- Uses S3 as restic repository backend.

- Runs every hour via cron job.

- Keeps 24 latest, 7 daily, 4 weekly, and 12 monthly snapshots.

- Prunes old snapshots every week.

**NOTE:** Pruning requires an exclusive lock, and should be done infrequently from a single host.

# Usage

Run:

    $ docker run \

    -d \

    -e AWS_ACCESS_KEY_ID='...' \

    -e AWS_SECRET_ACCESS_KEY='...' \

    -e DBHOST='...' \

    -e DBPASSWORD='...' \

    -e DBUSER='...' \

    -e RESTIC_PASSWORD='...' \

    -e RESTIC_REPOSITORY='s3:s3.amazonaws.com/...' \

    --name restic-mysqldump \

    --restart unless-stopped \

    interaction/restic-mysqldump

You can also pass the following environment variables to override the defaults:

    -e RESTIC_BACKUP_SCHEDULE='0 * * * *'  # Hourly

    -e RESTIC_PRUNE_SCHEDULE='0 14 * * 0'  # Sunday midnight, AEST. Use '' to disable.

    -e DBPORT='5432'

    -e RESTIC_KEEP_HOURLY='24'

    -e RESTIC_KEEP_DAILY='7'

    -e RESTIC_KEEP_WEEKLY='4'

    -e RESTIC_KEEP_MONTHLY='12'

You can backup 5 different database clusters with `DB*_[1..5]`, and assign an arbitrary hostname with `HOSTNAME_[1..5]` (if `DBHOST` is not a fully qualified domain name) environment variables.

    -e HOSTNAME_2='...'

    -e DBHOST_2='...'

    -e DBPASSWORD_2='...'

    -e DBPORT_2='5432'

    -e DBUSER_2='...'

A `docker-compose.yml` file is provided for convenience.

# Restore (macOS)

Create a `.envrc` file from `.envrc.example` and update with your AWS, PostgreSQL and Restic credentials.

    $ wget https://raw.githubusercontent.com/techknowlogick/restic-mysqldump/master/.envrc.example -O .envrc

Restrict access to `.envrc`, because it contains AWS and restic credentials:

    $ chmod 600 .envrc

Install [direnv] via [Homebrew] and configure to ensure your `.envrc` file is always sourced when you change to this directory:

    $ brew install direnv

    $ eval "$(direnv hook bash)"  # Change bash to zsh/fish/tcsh, if necessary, and add to your shell's RC file

    $ direnv allow

Install [restic] via [Homebrew]:

    $ brew install restic

List snapshots:

    $ restic snapshots

Restore the latest snapshot for a given server:

    $ restic restore --host {HOSTNAME} --target "restore/{HOSTNAME}" latest

Restore files matching a pattern from latest snapshot for a given server:

    $ restic restore --host "{HOSTNAME}" --target "restore/{HOSTNAME}" --include '*-production.sql' latest

Mount the restic repository via fuse (read-only):

    $ restic mount mnt

Then, access the latest snapshot from another terminal:

    $ ls -l "mnt/hosts/{HOSTNAME}/latest"

**WARNING:** Mounting the restic repository via fuse will open an exclusive lock and prevent all scheduled backups until the lock is released.

[direnv]: https://direnv.net/

[Homebrew]: https://brew.sh/

[restic]: https://restic.net/

# Credit

This repo is forked from https://github.com/ixc/restic-pg-dump-docker which is a restic backup container for postgres.