A wrapper script for Borg backup software that creates and prunes backups
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 66eb18d5ea Upgrade pip and tox in tests. 3 weeks ago
.gitea Add database version to issue template. 3 months ago
borgmatic Fix the "--stats" and "--files" flags so that they yield output at verbosity 0 (#290). 3 weeks ago
docs Fix PagerDuty link. 3 weeks ago
sample Revert "Use absolute paths in systemd commands." 1 month ago
scripts Upgrade pip and tox in tests. 3 weeks ago
tests Specify "--archive latest" to all actions that accept an archive (#289). 4 weeks ago
.dockerignore Include sub-command help in documentation. 8 months ago
.drone.yml Run end-to-end tests on developer machines with Docker Compose for approximate parity with continuous integration tests. 2 months ago
.eleventy.js Marketing. 3 months ago
.gitignore Config generation support for sequences of maps, needed for database dump hooks (#225). 4 months ago
AUTHORS Fix for "borgmatic restore" showing success and incorrectly extracting archive files, even when no databases are configured to restore (#246). 3 months ago
LICENSE Adding GPL v3 license. 5 years ago
MANIFEST.in Fix visibility of "borgmatic prune --stats" output (#219). 5 months ago
NEWS Fix the "--stats" and "--files" flags so that they yield output at verbosity 0 (#290). 3 weeks ago
README.md Add security policy, such as it is. 3 weeks ago
SECURITY.md Add security policy, such as it is. 3 weeks ago
pyproject.toml Remove all configuration from Tox file 9 months ago
setup.cfg Suppress part of an obnoxious warning about disabling coverage (for end-to-end tests). 8 months ago
setup.py Specify "--archive latest" to all actions that accept an archive (#289). 4 weeks ago
test_requirements.txt Update test requirements. 3 months ago
tox.ini Switch to read-only container filesystem to avoid *.pyc getting created with busted permissions. 2 months ago

README.md


It's your data. Keep it that way.

borgmatic logo

borgmatic is simple, configuration-driven backup software for servers and workstations. Protect your files with client-side encryption. Backup your databases too. Monitor it all with integrated third-party services.

Here's an example configuration file:

location:
    # List of source directories to backup.
    source_directories:
        - /home
        - /etc

    # Paths of local or remote repositories to backup to.
    repositories:
        - 1234@usw-s001.rsync.net:backups.borg
        - k8pDxu32@k8pDxu32.repo.borgbase.com:repo
        - /var/lib/backups/local.borg

retention:
    # Retention policy for how many backups to keep.
    keep_daily: 7
    keep_weekly: 4
    keep_monthly: 6

consistency:
    # List of checks to run to validate your backups.
    checks:
        - repository
        - archives

hooks:
    # Custom preparation scripts to run.
    before_backup:
        - prepare-for-backup.sh

    # Databases to dump and include in backups.
    postgresql_databases:
        - name: users

    # Third-party services to notify you if backups aren't happening.
    healthchecks: https://hc-ping.com/be067061-cf96-4412-8eae-62b0c50d6a8c

Want to see borgmatic in action? Check out the screencast.

borgmatic is powered by Borg Backup.

Integrations

PostgreSQL      MySQL      MariaDB      Healthchecks      Cronitor      Cronhub      PagerDuty      rsync.net      BorgBase     

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.

Also see the security policy for any security issues.

Other questions or comments? Contact witten@torsion.org.

Contributing

borgmatic is hosted at https://torsion.org/borgmatic with source code available. It's also mirrored on GitHub for convenience.

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.

Build Status