Simple, configuration-driven backup software for servers and workstations https://torsion.org/borgmatic/
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 8fde19a7dc Update systemd service example to return a permission error when a system call isn't permitted. 11 hours ago
.gitea Add database version to issue template. 1 year ago
borgmatic Fix line length in schema. 5 days ago
docs Document that passphrase is used for Borg keyfile encryption, not just repokey encryption (#373). 5 days ago
sample Update systemd service example to return a permission error when a system call isn't permitted. 11 hours ago
scripts Prevent newer (borgmatic-unsupported) version of Black code formatter installing in Alpine Edge. 5 days ago
tests Tweak to test failing on some machines. 4 days ago
.dockerignore Include sub-command help in documentation. 1 year ago
.drone.yml Drop support for Python 3.5. Only support black code formatter on Python 3.8+. 1 week ago
.eleventy.js Add documentation navigation links on left side of all documentation pages. 3 months ago
.gitignore Config generation support for sequences of maps, needed for database dump hooks (#225). 1 year ago
AUTHORS Fix for "borgmatic restore" showing success and incorrectly extracting archive files, even when no databases are configured to restore (#246). 1 year ago
LICENSE Adding GPL v3 license. 6 years ago
MANIFEST.in Fix visibility of "borgmatic prune --stats" output (#219). 1 year ago
NEWS Update systemd service example to return a permission error when a system call isn't permitted. 11 hours ago
README.md Add Lima-Labs to examples. 1 week ago
SECURITY.md Add security policy, such as it is. 10 months ago
pyproject.toml Remove all configuration from Tox file 1 year ago
setup.cfg Suppress part of an obnoxious warning about disabling coverage (for end-to-end tests). 1 year ago
setup.py Update versions of test dependencies (test_requirements.txt and test containers). 1 week ago
test_requirements.txt Drop support for Python 3.5. Only support black code formatter on Python 3.8+. 1 week ago
tox.ini Drop support for Python 3.5. Only support black code formatter on Python 3.8+. 1 week ago

README.md

title permalink
borgmatic index.html

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
        - user1@scp2.cdn.lima-labs.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     

Getting started

Your first step is to install and configure borgmatic.

For additional documentation, check out the links above for borgmatic how-to and 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
  • Lima-Labs: Affordable, reliable cloud data storage accessable via SSH/SCP/FTP for Borg backups or any other bulk storage needs

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, and is also mirrored on GitHub for convenience.

borgmatic is licensed under the GNU General Public License version 3 or any later version.

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