Simple, configuration-driven backup software for servers and workstations

Fabian Schilling 85e0334826 Add missing working_directory arg to pass tests 3 سال پیش
.gitea 612e1fea67 Add database version to issue template. 5 سال پیش
borgmatic 2a80e48a92 Pass working directory to execute functions 3 سال پیش
docs 9c19591768 Revise hosting provider links. 3 سال پیش
sample 1004500d65 Update sample systemd service file comments about more granular read-only filesystem settings. 3 سال پیش
scripts 7881327004 Upgrade CI test dependencies. 3 سال پیش
tests 85e0334826 Add missing working_directory arg to pass tests 3 سال پیش
.dockerignore cd91dbd4f7 Include sub-command help in documentation. 6 سال پیش
.drone.yml 794ae94ac4 Attempt to limit documentation pushing to commits (so, not pull requests). 3 سال پیش
.eleventy.js 79d4888e22 Add documentation navigation links on left side of all documentation pages. 5 سال پیش
.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). 6 سال پیش
NEWS a1673d1fa1 Fix unicode error when restoring particular MySQL databases (#476). 3 سال پیش
README.md 240547102f Enable auto-play on linked asciicast. 3 سال پیش
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 f34951c088 Add MySQL dump command adjustment to NEWS. 3 سال پیش
test_requirements.txt 27d37b606b Better error messages! Switch the library used for validating configuration files (from pykwalify to jsonschema). 4 سال پیش
tox.ini 631da1465e Add support for Python 3.9. 4 سال پیش

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:
        - 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 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
  • Lima-Labs: Affordable, reliable cloud data storage accessable via SSH/SCP/FTP for Borg backups or any other bulk storage needs

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