Simple, configuration-driven backup software for servers and workstations

Dan Helfman 9bd8f1a6df Clarify consistency check configuration. 2 년 전
.gitea 612e1fea67 Add database version to issue template. 5 년 전
borgmatic 89500df429 Fix traceback when a configuration section is present but lacking any options (#604). 2 년 전
docs 9bd8f1a6df Clarify consistency check configuration. 2 년 전
sample 2e9f70d496 Do not inhibit idle in borgmatic.service 2 년 전
scripts 2774c2e4c0 Add support for Borg 2's "--match-archives" flag (replaces "--glob-archives") (#591). 2 년 전
tests 89500df429 Fix traceback when a configuration section is present but lacking any options (#604). 2 년 전
.dockerignore cd91dbd4f7 Include sub-command help in documentation. 6 년 전
.drone.yml 22149c6401 Switch to self-hosted container registry for borgmatic documentation image. 3 년 전
.eleventy.js 97fad15009 Switch to more accessible header permalink anchors in documentation. 2 년 전
.gitignore cf8882f2bc Run arbitrary Borg commands with new "borgmatic borg" action (#425). 4 년 전
AUTHORS 6cdc92bd0c Fix for "borgmatic restore" showing success and incorrectly extracting archive files, even when no databases are configured to restore (#246). 5 년 전
LICENSE 7b3efddcbd Adding GPL v3 license. 10 년 전
MANIFEST.in 07222cd984 Fix visibility of "borgmatic prune --stats" output (#219). 5 년 전
NEWS 6aeb74550d Clarify examples in include merging and deep merging documentation (#607). 2 년 전
README.md 22628ba5d4 Update ssh:// examples in documentation to use relative paths on the remote machine (#557). 2 년 전
SECURITY.md c63219936e Wording tweaks to security policy. 4 년 전
pyproject.toml 20b8b45aeb Remove all configuration from Tox file 6 년 전
setup.cfg c072678936 Add support for ruamel.yaml 0.17.x YAML parsing library (#404). 4 년 전
setup.py 89500df429 Fix traceback when a configuration section is present but lacking any options (#604). 2 년 전
test_requirements.txt 48f44d2f3d Add tests for compact action (#394). 3 년 전
tox.ini 9317cbaaf0 Code formatting. 3 년 전

README.md


title: borgmatic

permalink: 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