Skip to content

niclaslindstedt/docker-backup

Repository files navigation

Docker Backup

Docker Pulls GitHub Repo Stars GitHub Issues Tests Release

Backup your Docker volumes and/or data folders and store them both short-term and long-term. Prune unwanted backups according to precise pruning settings, or when free space gets tight.

CAUTION: Do not use this for production environments. It has not been thorougly tested yet.

Features

  • Backup any Docker volume or folder on your host machine.
  • Easily restore backups with one command.
  • Encrypt your backups for safe storage in the cloud.
  • Verify your backups' integrity with sfv checksums.
  • Cron scheduling for precise backup schedules.
  • Pause your other Docker containers during backup/restoration to prevent invalid states
    • Note: This is only supported on the -docker tagged images.

Instructions

  1. Mount all volumes you want backed up in /volumes
  2. Mount the short-term backup location in /backup
  3. Mount the long-term storage location in /lts

For a list of commands, see the Commands wiki page.

See the Use cases wiki page for more advanced use cases.

Getting help

See the Frequently asked questions wiki page for a list of common questions.

Ask questions in the Discussions section if your question hasn't been answered in the FAQ.

Contributing

Submit a pull request! See the Development wiki page for information on how to get started with development.

If you're not a developer, you are more than welcome to submit an issue with a feature request or bug report.