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 e009bfeaa2 Update Healthchecks/Cronitor/Cronhub monitoring integrations to fire for "check" and "prune" actions, not just "create" (#249). 7 hours ago
.gitea Add database version to issue template. 4 weeks ago
borgmatic Update Healthchecks/Cronitor/Cronhub monitoring integrations to fire for "check" and "prune" actions, not just "create" (#249). 7 hours ago
docs Update Healthchecks/Cronitor/Cronhub monitoring integrations to fire for "check" and "prune" actions, not just "create" (#249). 7 hours ago
sample Merge sample cron files. 2 months ago
scripts Switch to read-only container filesystem to avoid *.pyc getting created with busted permissions. 1 day ago
tests Update Healthchecks/Cronitor/Cronhub monitoring integrations to fire for "check" and "prune" actions, not just "create" (#249). 7 hours ago
.dockerignore Include sub-command help in documentation. 5 months ago
.drone.yml Run end-to-end tests on developer machines with Docker Compose for approximate parity with continuous integration tests. 1 day ago
.eleventy.js Marketing. 4 weeks ago
.gitignore Config generation support for sequences of maps, needed for database dump hooks (#225). 1 month ago
AUTHORS Fix for "borgmatic restore" showing success and incorrectly extracting archive files, even when no databases are configured to restore (#246). 4 weeks ago
LICENSE Adding GPL v3 license. 5 years ago
MANIFEST.in Fix visibility of "borgmatic prune --stats" output (#219). 2 months ago
NEWS Update Healthchecks/Cronitor/Cronhub monitoring integrations to fire for "check" and "prune" actions, not just "create" (#249). 7 hours ago
README.md Icon spacing hack that'll show up on GitHub. 4 weeks ago
pyproject.toml Remove all configuration from Tox file 7 months ago
setup.cfg Suppress part of an obnoxious warning about disabling coverage (for end-to-end tests). 6 months ago
setup.py Add "borgmatic init" repository probing fix to NEWS. 8 hours ago
test_requirements.txt Update test requirements. 1 month ago
tox.ini Switch to read-only container filesystem to avoid *.pyc getting created with busted permissions. 1 day ago

README.md


title: borgmatic

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.

Here’s an example configuration file:

location:
    # List of source directories to backup.
    source_directories:
        - /home
        - /etc

    # Paths to local or remote repositories.
    repositories:
        - user@backupserver:sourcehostname.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      rsync.net      BorgBase     

How-to guides

Reference guides

Hosting providers

Need somewhere to store your encrypted offsite backups? The following hosting providers include specific support for Borg/borgmatic. Using these links and services helps support borgmatic development and hosting. (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

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 Freenode, either via web chat or a native IRC client.

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

Contributing

borgmatic is hosted at https://torsion.org/borgmatic with source code available. It’s also mirrored on GitHub for convenience.

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