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.
 
 
Dan Helfman bc4fb322b5 Move documenation build step last in CI. Refactor docs build scripts. 2 years ago
borgmatic Link to docs on skipping pruning entirely. 2 years ago
docs Add files for building documentation into a Docker image for web serving. 2 years ago
sample Change paths to reflect new pip install --user documentation. 2 years ago
scripts Move documenation build step last in CI. Refactor docs build scripts. 2 years ago
static Adding missing PNG logo. 4 years ago
tests Also read .yml ending configuration files 2 years ago
.drone.yml Move documenation build step last in CI. Refactor docs build scripts. 2 years ago
.eleventy.js Add files for building documentation into a Docker image for web serving. 2 years ago
.gitignore Add files for building documentation into a Docker image for web serving. 2 years ago
AUTHORS Add validate-borgmatic-config command 2 years ago
LICENSE Adding GPL v3 license. 7 years ago
MANIFEST.in Basic YAML configuration file parsing. 4 years ago
NEWS Move documenation build step last in CI. Refactor docs build scripts. 2 years ago
README.md Add files for building documentation into a Docker image for web serving. 2 years ago
pyproject.toml Remove all configuration from Tox file 2 years ago
setup.cfg Add isort configuration 2 years ago
setup.py Update NEWS with remove Python cache files before each Tox run. 2 years ago
test_requirements.txt Add isort configuration 2 years ago
tox.ini Pass posargs to pytest in main testenv 2 years ago

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.