Simple, configuration-driven backup software for servers and workstations

Dan Helfman b94999bba4 Fix "borgmatic umount" so it only runs Borg once instead of once per repository / configuration file. 5 anni fa
.gitea 612e1fea67 Add database version to issue template. 5 anni fa
borgmatic b94999bba4 Fix "borgmatic umount" so it only runs Borg once instead of once per repository / configuration file. 5 anni fa
docs df2be9620b Mount whole repositories via "borgmatic mount" without any "--archive" flag (#253). 5 anni fa
sample a472735616 Merge sample cron files. 5 anni fa
scripts 2c46f53ef6 Attempt to upgrade version of pip used in CI. 5 anni fa
tests b94999bba4 Fix "borgmatic umount" so it only runs Borg once instead of once per repository / configuration file. 5 anni fa
.dockerignore cd91dbd4f7 Include sub-command help in documentation. 6 anni fa
.drone.yml 93f453cecf Add Python 3.8 to build matrix. 5 anni fa
.eleventy.js 1e8edc05e9 Marketing. 5 anni fa
.gitignore f8bc67be8d Config generation support for sequences of maps, needed for database dump hooks (#225). 5 anni fa
AUTHORS 6cdc92bd0c Fix for "borgmatic restore" showing success and incorrectly extracting archive files, even when no databases are configured to restore (#246). 5 anni fa
LICENSE 7b3efddcbd Adding GPL v3 license. 10 anni fa
MANIFEST.in 07222cd984 Fix visibility of "borgmatic prune --stats" output (#219). 5 anni fa
NEWS b94999bba4 Fix "borgmatic umount" so it only runs Borg once instead of once per repository / configuration file. 5 anni fa
README.md 693434f8aa Icon spacing hack that'll show up on GitHub. 5 anni fa
pyproject.toml 20b8b45aeb Remove all configuration from Tox file 6 anni fa
setup.cfg 76d79f0331 Suppress part of an obnoxious warning about disabling coverage (for end-to-end tests). 6 anni fa
setup.py df2be9620b Mount whole repositories via "borgmatic mount" without any "--archive" flag (#253). 5 anni fa
test_requirements.txt 76c569cf84 Update test requirements. 5 anni fa
tox.ini 08f017bc3e Remove broken Tox Python version filter when running Black (code formatter) environment directly. 5 anni fa

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.

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