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

Simple, configuration-driven backup software for servers and workstations

Dan Helfman 6cdc92bd0c Fix for "borgmatic restore" showing success and incorrectly extracting archive files, even when no databases are configured to restore (#246).		%!s(int64=5) %!d(string=hai) anos
.gitea	612e1fea67 Add database version to issue template.	%!s(int64=5) %!d(string=hai) anos
borgmatic	6cdc92bd0c Fix for "borgmatic restore" showing success and incorrectly extracting archive files, even when no databases are configured to restore (#246).	%!s(int64=5) %!d(string=hai) anos
docs	4c38810a32 Add note about rsyslog rate limiting.	%!s(int64=5) %!d(string=hai) anos
sample	a472735616 Merge sample cron files.	%!s(int64=5) %!d(string=hai) anos
scripts	2c46f53ef6 Attempt to upgrade version of pip used in CI.	%!s(int64=5) %!d(string=hai) anos
static	469feadbc0 Adding missing PNG logo.	%!s(int64=7) %!d(string=hai) anos
tests	6cdc92bd0c Fix for "borgmatic restore" showing success and incorrectly extracting archive files, even when no databases are configured to restore (#246).	%!s(int64=5) %!d(string=hai) anos
.dockerignore	cd91dbd4f7 Include sub-command help in documentation.	%!s(int64=6) %!d(string=hai) anos
.drone.yml	93f453cecf Add Python 3.8 to build matrix.	%!s(int64=5) %!d(string=hai) anos
.eleventy.js	5e3c2da79c Database dump hooks documentation (#225).	%!s(int64=5) %!d(string=hai) anos
.gitignore	f8bc67be8d Config generation support for sequences of maps, needed for database dump hooks (#225).	%!s(int64=5) %!d(string=hai) anos
AUTHORS	6cdc92bd0c Fix for "borgmatic restore" showing success and incorrectly extracting archive files, even when no databases are configured to restore (#246).	%!s(int64=5) %!d(string=hai) anos
LICENSE	7b3efddcbd Adding GPL v3 license.	%!s(int64=10) %!d(string=hai) anos
MANIFEST.in	07222cd984 Fix visibility of "borgmatic prune --stats" output (#219).	%!s(int64=5) %!d(string=hai) anos
NEWS	6cdc92bd0c Fix for "borgmatic restore" showing success and incorrectly extracting archive files, even when no databases are configured to restore (#246).	%!s(int64=5) %!d(string=hai) anos
README.md	bd3c51fc5a Documentation for database restores (#229).	%!s(int64=5) %!d(string=hai) anos
pyproject.toml	20b8b45aeb Remove all configuration from Tox file	%!s(int64=6) %!d(string=hai) anos
setup.cfg	76d79f0331 Suppress part of an obnoxious warning about disabling coverage (for end-to-end tests).	%!s(int64=6) %!d(string=hai) anos
setup.py	6cdc92bd0c Fix for "borgmatic restore" showing success and incorrectly extracting archive files, even when no databases are configured to restore (#246).	%!s(int64=5) %!d(string=hai) anos
test_requirements.txt	76c569cf84 Update test requirements.	%!s(int64=5) %!d(string=hai) anos
tox.ini	08f017bc3e Remove broken Tox Python version filter when running Black (code formatter) environment directly.	%!s(int64=5) %!d(string=hai) anos

title: borgmatic

permalink: index.html

Overview

borgmatic is simple, configuration-driven backup software for servers and workstations. Backup all of your machines from the command-line or scheduled jobs. No GUI required. Built atop Borg Backup, borgmatic initiates a backup, prunes any old backups according to a retention policy, and validates backups for consistency. borgmatic 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", etc.
    checks:
        - repository
        - archives

hooks:
    # Preparation scripts to run, databases to dump, and monitoring to perform.
    before_backup:
        - prepare-for-backup.sh
    postgresql_databases:
        - name: users
    healthchecks: https://hc-ping.com/be067061-cf96-4412-8eae-62b0c50d6a8c

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.)

rsync.net: Cloud Storage provider with full support for borg and any other SSH/SFTP tool
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 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