Simple, configuration-driven backup software for servers and workstations

Dan Helfman d2c46e91fe Add rsync.net to hosting providers; includ random link rotation. 6 роки тому
borgmatic fb7a6dccaa Link to docs on skipping pruning entirely. 6 роки тому
docs d2c46e91fe Add rsync.net to hosting providers; includ random link rotation. 6 роки тому
sample 67f2862fb1 Change paths to reflect new pip install --user documentation. 6 роки тому
scripts bc4fb322b5 Move documenation build step last in CI. Refactor docs build scripts. 6 роки тому
static 469feadbc0 Adding missing PNG logo. 7 роки тому
tests 8424e443a9 Also read .yml ending configuration files 6 роки тому
.drone.yml bc4fb322b5 Move documenation build step last in CI. Refactor docs build scripts. 6 роки тому
.eleventy.js 308cb31bf9 Remove some of the link rewriting to hopefully fix broken docs links. 6 роки тому
.gitignore 53967f6324 Trigger build. 6 роки тому
AUTHORS 52e4f48eb9 Add validate-borgmatic-config command 6 роки тому
LICENSE 7b3efddcbd Adding GPL v3 license. 10 роки тому
MANIFEST.in 4d7556f68b Basic YAML configuration file parsing. 8 роки тому
NEWS bc4fb322b5 Move documenation build step last in CI. Refactor docs build scripts. 6 роки тому
README.md d2c46e91fe Add rsync.net to hosting providers; includ random link rotation. 6 роки тому
pyproject.toml 20b8b45aeb Remove all configuration from Tox file 6 роки тому
setup.cfg b94dbff216 Add isort configuration 6 роки тому
setup.py 9bc1b71017 Clarify description in setup.py. 6 роки тому
test_requirements.txt b94dbff216 Add isort configuration 6 роки тому
tox.ini 917a0dd0a0 Pass posargs to pytest in main testenv 6 роки тому

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.