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 2e99a1898c Fix f-string with missing expression. 4 days ago
.gitea Add database version to issue template. 2 years ago
borgmatic Fix f-string with missing expression. 4 days ago
docs Revise hosting provider links. 3 weeks ago
sample Update sample systemd service file comments about more granular read-only filesystem settings. 2 months ago
scripts Upgrade CI test dependencies. 1 month ago
tests Fix import ordering. 4 days ago
.dockerignore Include sub-command help in documentation. 2 years ago
.drone.yml Attempt to limit documentation pushing to commits (so, not pull requests). 3 weeks ago
.eleventy.js Add documentation navigation links on left side of all documentation pages. 1 year ago
.gitignore Run arbitrary Borg commands with new "borgmatic borg" action (#425). 6 months ago
AUTHORS Fix for "borgmatic restore" showing success and incorrectly extracting archive files, even when no databases are configured to restore (#246). 2 years ago
LICENSE Adding GPL v3 license. 7 years ago
MANIFEST.in Fix visibility of "borgmatic prune --stats" output (#219). 2 years ago
NEWS When command-line configuration override produces a parse error, error cleanly (#471). 4 days ago
README.md Enable auto-play on linked asciicast. 1 week ago
SECURITY.md Wording tweaks to security policy. 4 months ago
pyproject.toml Remove all configuration from Tox file 3 years ago
setup.cfg Add support for ruamel.yaml 0.17.x YAML parsing library (#404). 8 months ago
setup.py Add MySQL dump command adjustment to NEWS. 4 days ago
test_requirements.txt Better error messages! Switch the library used for validating configuration files (from pykwalify to jsonschema). 5 months ago
tox.ini Add support for Python 3.9. 8 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:
        - 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