Simple, configuration-driven backup software for servers and workstations

Dan Helfman 5ea2d644a2 Fix error handling when --extract repository guard fails. 6 tahun lalu
borgmatic 5ea2d644a2 Fix error handling when --extract repository guard fails. 6 tahun lalu
docs d1b29e82da borgmatic command-line reference. 6 tahun lalu
sample e5870a169b Add example for cron in Alpine Linux (#24) 7 tahun lalu
scripts 36305c50b1 Update push script to support branches. 6 tahun lalu
static 469feadbc0 Adding missing PNG logo. 7 tahun lalu
tests 5ea2d644a2 Fix error handling when --extract repository guard fails. 6 tahun lalu
.drone.yml eb2a4ff1f0 Add Python 3.5 to continuous integration. 6 tahun lalu
.gitignore d29c7956bc Upgrade ruamel.yaml compatibility version range and fix support for Python 3.7 (#38, #76). 7 tahun lalu
AUTHORS 7252b8d614 Rework logging/verbosity system (#90) 7 tahun lalu
LICENSE 7b3efddcbd Adding GPL v3 license. 10 tahun lalu
MANIFEST.in 4d7556f68b Basic YAML configuration file parsing. 8 tahun lalu
NEWS 36305c50b1 Update push script to support branches. 6 tahun lalu
README.md d1b29e82da borgmatic command-line reference. 6 tahun lalu
setup.cfg 7c77a5a8a5 No longer producing univeral (Python 2 + 3) wheel. 8 tahun lalu
setup.py fcf4e03c2f exclude tests from distribution packages 6 tahun lalu
test_requirements.txt 71b1c3dfb0 Make automated tests support running in Python 3.5. 6 tahun lalu
tox.ini e323290e61 Switch from bash to sh for black wrapper. 6 tahun lalu

README.md


title: borgmatic

permalink: borgmatic/index.html

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.