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 b37dd1a79e Document use case of running backups conditionally based on laptop power level (#419). 2 months ago
.gitea Add database version to issue template. 2 years ago
borgmatic Fix error handling to error loudly when Borg gets killed due to running out of memory (#423)! 2 months ago
docs Document use case of running backups conditionally based on laptop power level (#419). 2 months ago
sample Document use case of running backups conditionally based on laptop power level (#419). 2 months ago
scripts Fix release script based on GitHub authentication query parameter deprecation. 3 months ago
tests Fix error handling to error loudly when Borg gets killed due to running out of memory (#423)! 2 months ago
.dockerignore Include sub-command help in documentation. 2 years ago
.drone.yml "Fix" build failure with Alpine Edge by switching from Edge to Alpine 3.13. 4 months ago
.eleventy.js Add documentation navigation links on left side of all documentation pages. 12 months ago
.gitignore Config generation support for sequences of maps, needed for database dump hooks (#225). 2 years 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 Document use case of running backups conditionally based on laptop power level (#419). 2 months ago
README.md Move #borgmatic IRC channel from Freenode to Libera Chat due to Freenode takeover drama. 2 months ago
SECURITY.md Add security policy, such as it is. 2 years ago
pyproject.toml Remove all configuration from Tox file 2 years ago
setup.cfg Add support for ruamel.yaml 0.17.x YAML parsing library (#404). 4 months ago
setup.py Document use case of running backups conditionally based on laptop power level (#419). 2 months ago
test_requirements.txt Upgrade "py" test dependency (security). 3 months ago
tox.ini Add support for Python 3.9. 4 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.)

  • 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

Additionally, Hetzner has a compatible storage offering, but does 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