Simple, configuration-driven backup software for servers and workstations https://torsion.org/borgmatic/
Go to file
Dan Helfman 2781873faf
continuous-integration/drone/push Build is failing Details
continuous-integration/drone/tag Build is failing Details
Bump version for release.
2020-06-30 21:47:34 -07:00
.gitea Add database version to issue template. 2019-11-13 08:38:58 -08:00
borgmatic Formatting. 2020-06-25 20:25:29 -07:00
docs Fix duplicate logging to Healthchecks and send "after_*" hooks output to Healthchecks (#328). 2020-06-23 11:01:03 -07:00
sample Add note about indirect dbus dependency. 2020-05-21 19:56:32 -07:00
scripts Fix path in release script. 2020-04-24 16:05:50 -07:00
tests Fix duplicate logging to Healthchecks and send "after_*" hooks output to Healthchecks (#328). 2020-06-23 11:01:03 -07:00
.dockerignore Include sub-command help in documentation. 2019-06-22 22:04:56 -07:00
.drone.yml Run end-to-end tests on developer machines with Docker Compose for approximate parity with continuous integration tests. 2019-12-11 16:43:01 -08:00
.eleventy.js Marketing. 2019-11-14 09:34:53 -08:00
.gitignore Config generation support for sequences of maps, needed for database dump hooks (#225). 2019-10-21 15:17:47 -07:00
AUTHORS Fix for "borgmatic restore" showing success and incorrectly extracting archive files, even when no databases are configured to restore (#246). 2019-11-13 10:41:57 -08:00
LICENSE Adding GPL v3 license. 2014-11-18 18:22:51 -08:00
MANIFEST.in Fix visibility of "borgmatic prune --stats" output (#219). 2019-09-23 13:07:51 -07:00
NEWS Bump version for release. 2020-06-30 21:47:34 -07:00
README.md Clarify license version. 2020-03-09 15:50:54 -07:00
SECURITY.md Add security policy, such as it is. 2020-01-30 15:42:48 -08:00
pyproject.toml Remove all configuration from Tox file 2019-05-14 13:17:15 +02:00
setup.cfg Suppress part of an obnoxious warning about disabling coverage (for end-to-end tests). 2019-06-13 14:15:08 -07:00
setup.py Bump version for release. 2020-06-30 21:47:34 -07:00
test_requirements.txt Update test requirements. 2019-11-01 12:18:35 -07:00
tox.ini Switch to read-only container filesystem to avoid *.pyc getting created with busted permissions. 2019-12-11 21:24:37 -08:00

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.

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
        - /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     

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.

Also see the security policy for any security issues.

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

Contributing

borgmatic is hosted at https://torsion.org/borgmatic with source code 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