Simple, configuration-driven backup software for servers and workstations
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Luke Murphy 20b8b45aeb
Remove all configuration from Tox file
2 years ago
borgmatic More tests for colored logging. 2 years ago
docs Mention continuous integration badge in NEWS. 2 years ago
sample Add example for cron in Alpine Linux (#24) 3 years ago
scripts Update push script to support branches. 3 years ago
static Adding missing PNG logo. 4 years ago
tests More tests for colored logging. 2 years ago
.drone.yml Pin pip version: cherrypick of 2 years ago
.gitignore Upgrade ruamel.yaml compatibility version range and fix support for Python 3.7 (#38, #76). 3 years ago
AUTHORS Add validate-borgmatic-config command 3 years ago
LICENSE Adding GPL v3 license. 7 years ago Basic YAML configuration file parsing. 4 years ago
NEWS Pin pip version: cherrypick of 2 years ago Linkify build status badge. 2 years ago
pyproject.toml Remove all configuration from Tox file 2 years ago
setup.cfg Remove all configuration from Tox file 2 years ago Integrate colorama for colored output. 2 years ago
test_requirements.txt Add colorama to testing dependencies 2 years ago
tox.ini Remove all configuration from Tox file 2 years ago

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.