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

Simple, configuration-driven backup software for servers and workstations

Luke Murphy a621ce199a Add tests for borgmatic.logger.to_bool		6 lat temu
borgmatic	1f524d6c87 Add borgmatic custom logger	6 lat temu
docs	0320d449ec Add documentation about colorama	6 lat temu
sample	e5870a169b Add example for cron in Alpine Linux (#24)	7 lat temu
scripts	36305c50b1 Update push script to support branches.	6 lat temu
static	469feadbc0 Adding missing PNG logo.	7 lat temu
tests	a621ce199a Add tests for borgmatic.logger.to_bool	6 lat temu
.drone.yml	f5e1e8bec9 In continuous integration build matrix, use newer Alpine 3.9 instead of 3.8.	6 lat temu
.gitignore	d29c7956bc Upgrade ruamel.yaml compatibility version range and fix support for Python 3.7 (#38, #76).	7 lat temu
AUTHORS	52e4f48eb9 Add validate-borgmatic-config command	6 lat temu
LICENSE	7b3efddcbd Adding GPL v3 license.	10 lat temu
MANIFEST.in	4d7556f68b Basic YAML configuration file parsing.	8 lat temu
NEWS	8650a15db1 Document validate-borgmatic-config and add a few tests.	6 lat temu
README.md	26071de2e7 Update extraction docs.	6 lat temu
setup.cfg	7c77a5a8a5 No longer producing univeral (Python 2 + 3) wheel.	8 lat temu
setup.py	adf7856162 Add new colorama dependency	6 lat temu
test_requirements.txt	30f007687a Add colorama to testing dependencies	6 lat temu
tox.ini	e323290e61 Switch from bash to sh for black wrapper.	6 lat temu

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