mirrors/borgmatic: Simple, configuration-driven backup software for servers and workstations @ aa7c7651e59064e5fbfb745fea32c1fa6db6e57b

Simple, configuration-driven backup software for servers and workstations

627 Commit

Dan Helfman aa7c7651e5 Fix config repositories consumption.		6 anni fa
borgmatic	aa7c7651e5 Fix config repositories consumption.	6 anni fa
docs	d1b29e82da borgmatic command-line reference.	6 anni fa
sample	e5870a169b Add example for cron in Alpine Linux (#24)	7 anni fa
scripts	73d67e29b4 Support for Borg create & prune --stats via borgmatic command-line flag (#100)	6 anni fa
static	469feadbc0 Adding missing PNG logo.	7 anni fa
tests	aa7c7651e5 Fix config repositories consumption.	6 anni fa
.drone.yml	eb2a4ff1f0 Add Python 3.5 to continuous integration.	6 anni fa
.gitignore	d29c7956bc Upgrade ruamel.yaml compatibility version range and fix support for Python 3.7 (#38, #76).	7 anni fa
AUTHORS	7252b8d614 Rework logging/verbosity system (#90)	6 anni fa
LICENSE	7b3efddcbd Adding GPL v3 license.	10 anni fa
MANIFEST.in	4d7556f68b Basic YAML configuration file parsing.	8 anni fa
NEWS	1a980d6321 Organize options within command-line help into logical groups.	6 anni fa
README.md	d1b29e82da borgmatic command-line reference.	6 anni fa
setup.cfg	7c77a5a8a5 No longer producing univeral (Python 2 + 3) wheel.	8 anni fa
setup.py	fcf4e03c2f exclude tests from distribution packages	6 anni fa
test_requirements.txt	71b1c3dfb0 Make automated tests support running in Python 3.5.	6 anni fa
tox.ini	e323290e61 Switch from bash to sh for black wrapper.	6 anni fa

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.

README.md