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 90be5b84b1 Fix changelog development version. 3 months ago
.gitea Add database version to issue template. 3 years ago
borgmatic Warn when ignoring a configured "read_special" value of false, as true is needed when database hooks are enabled (#587). 3 months ago
docs Add "borgmatic borg" documentation note about interactive prompts. 3 months ago
sample Fix duplicate bind path in sample systemd service. 3 months ago
scripts Support for Borg 2's rcreate and rinfo sub-commands (#557). 4 months ago
tests Warn when ignoring a configured "read_special" value of false, as true is needed when database hooks are enabled (#587). 3 months ago
.dockerignore Include sub-command help in documentation. 4 years ago
.drone.yml Switch to self-hosted container registry for borgmatic documentation image. 4 months ago
.eleventy.js Switch to more accessible header permalink anchors in documentation. 4 months ago
.gitignore Run arbitrary Borg commands with new "borgmatic borg" action (#425). 1 year ago
AUTHORS Fix for "borgmatic restore" showing success and incorrectly extracting archive files, even when no databases are configured to restore (#246). 3 years ago
LICENSE Adding GPL v3 license. 8 years ago
MANIFEST.in Fix visibility of "borgmatic prune --stats" output (#219). 3 years ago
NEWS Fix changelog development version. 3 months ago
README.md Update ssh:// examples in documentation to use relative paths on the remote machine (#557). 4 months ago
SECURITY.md Wording tweaks to security policy. 1 year ago
pyproject.toml Remove all configuration from Tox file 4 years ago
setup.cfg Add support for ruamel.yaml 0.17.x YAML parsing library (#404). 2 years ago
setup.py Warn when ignoring a configured "read_special" value of false, as true is needed when database hooks are enabled (#587). 3 months ago
test_requirements.txt Add tests for compact action (#394). 10 months ago
tox.ini Code formatting. 10 months 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.

The canonical home of borgmatic is at https://torsion.org/borgmatic.

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:
        - ssh://1234@usw-s001.rsync.net/./backups.borg
        - ssh://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:
        - name: repository
        - name: archives
          frequency: 2 weeks

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      MongoDB      Healthchecks      Cronitor      Cronhub      PagerDuty      ntfy      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 off-site backups? The following hosting providers include specific support for Borg/borgmatic—and fund borgmatic development and hosting when you use these links to sign up. (These are referral links, but without any tracking scripts or cookies.)

  • BorgBase: Borg hosting service with support for monitoring, 2FA, and append-only repos

Additionally, rsync.net and Hetzner have compatible storage offerings, but do not currently fund borgmatic development or hosting.

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 Libera Chat, either via web chat or a native IRC client. If you don't get a response right away, please hang around a while—or file a ticket instead.

Also see the security policy for any security issues.

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

Contributing

borgmatic source code is 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