Simple, configuration-driven backup software for servers and workstations
Go to file
Luke Murphy 20b8b45aeb
Remove all configuration from Tox file
This puts tool configuration in their familiar and standard
locations and simplifies the Tox configuration to just laying
out the environments and factors.

This also allows users who do not want to deal with overhead of Tox (for
whatever reasons ...) to run pytest/black/etc. and have the same
2019-05-14 13:17:15 +02:00
borgmatic More tests for colored logging. 2019-05-13 21:10:26 -07:00
docs Mention continuous integration badge in NEWS. 2019-05-13 14:54:24 -07:00
sample Add example for cron in Alpine Linux (#24) 2018-09-05 21:58:30 -07:00
scripts Update push script to support branches. 2019-02-18 13:51:33 -08:00
static Adding missing PNG logo. 2017-10-28 10:31:30 -07:00
tests More tests for colored logging. 2019-05-13 21:10:26 -07:00
.drone.yml Pin pip version: cherrypick of witten/borgmatic#172 2019-05-13 20:01:25 -07:00
.gitignore Upgrade ruamel.yaml compatibility version range and fix support for Python 3.7 (#38, #76). 2018-07-22 11:25:06 -07:00
AUTHORS Add validate-borgmatic-config command 2019-05-10 00:10:28 +02:00
LICENSE Adding GPL v3 license. 2014-11-18 18:22:51 -08:00 Basic YAML configuration file parsing. 2017-07-04 16:52:24 -07:00
NEWS Pin pip version: cherrypick of witten/borgmatic#172 2019-05-13 20:01:25 -07:00
pyproject.toml Remove all configuration from Tox file 2019-05-14 13:17:15 +02:00 Linkify build status badge. 2019-05-13 22:33:28 -07:00
setup.cfg Remove all configuration from Tox file 2019-05-14 13:17:15 +02:00 Integrate colorama for colored output. 2019-05-13 19:50:36 +00:00
test_requirements.txt Add colorama to testing dependencies 2019-05-13 13:40:17 +02:00
tox.ini Remove all configuration from Tox file 2019-05-14 13:17:15 +02:00

title permalink
borgmatic borgmatic/index.html

Build Status


borgmatic logo

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:

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

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

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

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

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

borgmatic is hosted at 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


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


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.