A wrapper script for Borg backup software that creates and prunes backups
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Dan Helfman 1c88dda76a Fix for invalid JSON output when using multiple borgmatic configuration files (#155). 5 months ago
borgmatic Fix for invalid JSON output when using multiple borgmatic configuration files (#155). 5 months ago
docs Clarify differences between Docker images. 6 months ago
sample Add example for cron in Alpine Linux (#24) 1 year ago
scripts Update push script to support branches. 6 months ago
static Adding missing PNG logo. 1 year ago
tests Fix for invalid JSON output when using multiple borgmatic configuration files (#155). 5 months ago
.drone.yml Add Python 3.5 to continuous integration. 11 months ago
.gitignore Upgrade ruamel.yaml compatibility version range and fix support for Python 3.7 (#38, #76). 1 year ago
AUTHORS Rework logging/verbosity system (#90) 1 year ago
LICENSE Adding GPL v3 license. 4 years ago
MANIFEST.in Basic YAML configuration file parsing. 2 years ago
NEWS Fix for invalid JSON output when using multiple borgmatic configuration files (#155). 5 months ago
README.md Update extraction docs. 6 months ago
setup.cfg No longer producing univeral (Python 2 + 3) wheel. 2 years ago
setup.py Fix for invalid JSON output when using multiple borgmatic configuration files (#155). 5 months ago
test_requirements.txt Make automated tests support running in Python 3.5. 11 months ago
tox.ini Switch from bash to sh for black wrapper. 11 months ago

README.md


title: borgmatic

Overview

borgmatic is a simple Python wrapper script for the Borg backup software that initiates a backup, prunes any old backups according to a retention policy, and validates backups for consistency. The script supports specifying your settings in a declarative configuration file rather than having to put them all on the command-line, and handles common errors.

Here’s an example config file:

location:
    # List of source directories to backup. Globs are expanded.
    source_directories:
        - /home
        - /etc
        - /var/log/syslog*

    # Paths to local or remote repositories.
    repositories:
        - user@backupserver:sourcehostname.borg

    # Any paths matching these patterns are excluded from backups.
    exclude_patterns:
        - /home/*/.cache

retention:
    # Retention policy for how many backups to keep in each category.
    keep_daily: 7
    keep_weekly: 4
    keep_monthly: 6

consistency:
    # List of consistency checks to run: "repository", "archives", or both.
    checks:
        - repository
        - archives

borgmatic is hosted at https://torsion.org/borgmatic with source code available. It’s also mirrored on GitHub for convenience.

Want to see borgmatic in action? Check out the screencast.

How-to guides

Reference guides

Support and contributing

Issues

You’ve got issues? Or an idea for a feature enhancement? We’ve got an issue tracker. In order to create a new issue or comment on an issue, you’ll need to login first. Note that you can login with an existing GitHub account if you prefer.

Other questions or comments? Contact witten@torsion.org.

Contributing

If you’d like to contribute to borgmatic development, please feel free to submit a Pull Request or open an issue first to discuss your idea. We also accept Pull Requests on GitHub, if that’s more your thing. In general, contributions are very welcome. We don’t bite!

Also, please check out the borgmatic development how-to for info on cloning source code, running tests, etc.