Simple, configuration-driven backup software for servers and workstations

Dan Helfman 2f75c9aa9e Bump Tox minimum version. 5 tahun lalu
.gitea c9f5d9b048 In issue template, use python3 instead of python. 6 tahun lalu
borgmatic c12c47cace Fix "borgmatic list --successful" with a slightly better heuristic for listing successful (non-checkpoint) archives. 5 tahun lalu
docs c12c47cace Fix "borgmatic list --successful" with a slightly better heuristic for listing successful (non-checkpoint) archives. 5 tahun lalu
sample a472735616 Merge sample cron files. 5 tahun lalu
scripts b1941bcce9 Automatically rewrite links to localhost when developing on docs locally. 5 tahun lalu
static 469feadbc0 Adding missing PNG logo. 7 tahun lalu
tests 128ebf04ce Dead man's switch via healthchecks.io integration (#223) + new monitoring documentation. 5 tahun lalu
.dockerignore cd91dbd4f7 Include sub-command help in documentation. 6 tahun lalu
.drone.yml cf4c6c274d Upgrade build to Alpine 3.10. 5 tahun lalu
.eleventy.js b1941bcce9 Automatically rewrite links to localhost when developing on docs locally. 5 tahun lalu
.gitignore 899a7c8318 Add some wheel metadata do .gitignore. 6 tahun lalu
AUTHORS 52e4f48eb9 Add validate-borgmatic-config command 6 tahun lalu
LICENSE 7b3efddcbd Adding GPL v3 license. 10 tahun lalu
MANIFEST.in 07222cd984 Fix visibility of "borgmatic prune --stats" output (#219). 5 tahun lalu
NEWS c12c47cace Fix "borgmatic list --successful" with a slightly better heuristic for listing successful (non-checkpoint) archives. 5 tahun lalu
README.md 128ebf04ce Dead man's switch via healthchecks.io integration (#223) + new monitoring documentation. 5 tahun lalu
pyproject.toml 20b8b45aeb Remove all configuration from Tox file 6 tahun lalu
setup.cfg 76d79f0331 Suppress part of an obnoxious warning about disabling coverage (for end-to-end tests). 6 tahun lalu
setup.py c12c47cace Fix "borgmatic list --successful" with a slightly better heuristic for listing successful (non-checkpoint) archives. 5 tahun lalu
test_requirements.txt 128ebf04ce Dead man's switch via healthchecks.io integration (#223) + new monitoring documentation. 5 tahun lalu
tox.ini 60650ccfc7 Follow latest Tox developments 5 tahun lalu

README.md


title: borgmatic

permalink: index.html

Build Status

Overview

borgmatic logo

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

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