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 9c75063c05 Unbreak console snippet in docs. 3 weeks ago
.gitea Note about including config file. 1 month ago
borgmatic Only log to syslog when run from a non-interactive console (e.g. a cron job). Related to #197. 3 weeks ago
docs Unbreak console snippet in docs. 3 weeks ago
sample Add docs/default about systemd journald rate limiting. 1 month ago
scripts Pass through several "borg list" flags (#193). 3 weeks ago
static Adding missing PNG logo. 1 year ago
tests Only log to syslog when run from a non-interactive console (e.g. a cron job). Related to #197. 3 weeks ago
.dockerignore Include sub-command help in documentation. 4 weeks ago
.drone.yml Undo purge. 1 month ago
.eleventy.js Remove some of the link rewriting to hopefully fix broken docs links. 1 month ago
.gitignore Add some wheel metadata do .gitignore. 1 month ago
AUTHORS Add validate-borgmatic-config command 2 months ago
LICENSE Adding GPL v3 license. 4 years ago
MANIFEST.in Basic YAML configuration file parsing. 2 years ago
NEWS Add note to documentation about using spaces instead of tabs for indentation, as YAML does not allow tabs (#199). 3 weeks ago
README.md Only show build status badge for master branch. 4 weeks ago
pyproject.toml Remove all configuration from Tox file 2 months ago
setup.cfg Suppress part of an obnoxious warning about disabling coverage (for end-to-end tests). 1 month ago
setup.py Add note to documentation about using spaces instead of tabs for indentation, as YAML does not allow tabs (#199). 3 weeks ago
test_requirements.txt Additional test coverage, and upgrade test requirements. 1 month ago
tox.ini Additional test coverage, and upgrade test requirements. 1 month ago

README.md


title: borgmatic

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.