Simple, configuration-driven backup software for servers and workstations

Dan Helfman e933ecf046 Add drone CI note and badge. vor 6 Jahren
borgmatic 37362150fe Color records that are logged via logger.handle() as well. vor 6 Jahren
docs 4010a2ed77 Add note about Drone CI to contributing docs vor 6 Jahren
sample e5870a169b Add example for cron in Alpine Linux (#24) vor 7 Jahren
scripts 36305c50b1 Update push script to support branches. vor 6 Jahren
static 469feadbc0 Adding missing PNG logo. vor 7 Jahren
tests a621ce199a Add tests for borgmatic.logger.to_bool vor 6 Jahren
.drone.yml f5e1e8bec9 In continuous integration build matrix, use newer Alpine 3.9 instead of 3.8. vor 6 Jahren
.gitignore d29c7956bc Upgrade ruamel.yaml compatibility version range and fix support for Python 3.7 (#38, #76). vor 7 Jahren
AUTHORS 52e4f48eb9 Add validate-borgmatic-config command vor 6 Jahren
LICENSE 7b3efddcbd Adding GPL v3 license. vor 10 Jahren
MANIFEST.in 4d7556f68b Basic YAML configuration file parsing. vor 8 Jahren
NEWS a7ba97803f Add colored output to NEWS. vor 6 Jahren
README.md 2f36096e1a Add Drone build badge vor 6 Jahren
setup.cfg 7c77a5a8a5 No longer producing univeral (Python 2 + 3) wheel. vor 8 Jahren
setup.py 31dc903877 Integrate colorama for colored output. vor 6 Jahren
test_requirements.txt 30f007687a Add colorama to testing dependencies vor 6 Jahren
tox.ini e323290e61 Switch from bash to sh for black wrapper. vor 6 Jahren

README.md


title: borgmatic

permalink: borgmatic/index.html

Build Status

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.