Simple, configuration-driven backup software for servers and workstations
Go to file
Dan Helfman 9c9be65b2b Add files for building documentation into a Docker image for web serving. 2019-05-20 11:41:39 -07:00
borgmatic Also read .yml ending configuration files 2019-05-19 13:04:42 +02:00
docs Add files for building documentation into a Docker image for web serving. 2019-05-20 11:41:39 -07:00
sample Change paths to reflect new pip install --user documentation. 2019-05-14 10:00:50 -07:00
scripts Add files for building documentation into a Docker image for web serving. 2019-05-20 11:41:39 -07:00
static Adding missing PNG logo. 2017-10-28 10:31:30 -07:00
tests Also read .yml ending configuration files 2019-05-19 13:04:42 +02:00
.drone.yml Don't use pip wrapper script in CI. 2019-05-14 12:01:40 -07:00
.eleventy.js Add files for building documentation into a Docker image for web serving. 2019-05-20 11:41:39 -07:00
.gitignore Add files for building documentation into a Docker image for web serving. 2019-05-20 11:41:39 -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
MANIFEST.in Basic YAML configuration file parsing. 2017-07-04 16:52:24 -07:00
NEWS Add files for building documentation into a Docker image for web serving. 2019-05-20 11:41:39 -07:00
README.md Add files for building documentation into a Docker image for web serving. 2019-05-20 11:41:39 -07:00
pyproject.toml Remove all configuration from Tox file 2019-05-14 13:17:15 +02:00
setup.cfg Add isort configuration 2019-05-14 18:59:19 +02:00
setup.py Update NEWS with remove Python cache files before each Tox run. 2019-05-19 10:07:28 -07:00
test_requirements.txt Add isort configuration 2019-05-14 18:59:19 +02:00
tox.ini Pass posargs to pytest in main testenv 2019-05-19 23:53:43 +02:00

README.md

title permalink
borgmatic index.html

Build Status

Overview

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:

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

Hosting providers

Need somewhere to store your encrypted offsite backups? The following hosting providers include specific support for Borg/borgmatic. Using these links and services helps support borgmatic development and hosting. (These are referral links, but without any tracking scripts or cookies.)

  • BorgBase: Borg hosting service with support for monitoring, 2FA, and append-only repos.

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.

If you'd like to chat with borgmatic developers or users, head on over to the #borgmatic IRC channel on Freenode, either via web chat or a native IRC client.

Other questions or comments? Contact mailto: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.