Simple, configuration-driven backup software for servers and workstations
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.
root 7cad5a8608 Add `temporary_directory` as a configuration option defaulting to $TMPDIR 1 month ago
.gitea Add database version to issue template. 10 months ago
borgmatic Add `temporary_directory` as a configuration option defaulting to $TMPDIR 1 month ago
docs systemd security settings 1 month ago
sample Add comment about MemoryDenyWriteExecute value and the tradeoffs thereof. 1 month ago
scripts Fix path in release script. 5 months ago
tests Merge branch 'master' into master 1 month ago
.dockerignore Include sub-command help in documentation. 1 year ago
.drone.yml Run end-to-end tests on developer machines with Docker Compose for approximate parity with continuous integration tests. 9 months ago
.eleventy.js Add documentation navigation links on left side of all documentation pages. 1 month ago
.gitignore Config generation support for sequences of maps, needed for database dump hooks (#225). 11 months ago
AUTHORS Fix for "borgmatic restore" showing success and incorrectly extracting archive files, even when no databases are configured to restore (#246). 10 months ago
LICENSE Adding GPL v3 license. 5 years ago
MANIFEST.in Fix visibility of "borgmatic prune --stats" output (#219). 1 year ago
NEWS Add systemd security improvement to NEWS. 1 month ago
README.md Add documentation navigation links on left side of all documentation pages. 1 month ago
SECURITY.md Add security policy, such as it is. 8 months ago
pyproject.toml Remove all configuration from Tox file 1 year ago
setup.cfg Suppress part of an obnoxious warning about disabling coverage (for end-to-end tests). 1 year ago
setup.py Add systemd security improvement to NEWS. 1 month ago
test_requirements.txt Update test requirements. 11 months ago
tox.ini Switch to read-only container filesystem to avoid *.pyc getting created with busted permissions. 9 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.

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:
        - k8pDxu32@k8pDxu32.repo.borgbase.com:repo
        - 1234@usw-s001.rsync.net:backups.borg
        - /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 BorgBase      rsync.net     

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 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.)

  • BorgBase: Borg hosting service with support for monitoring, 2FA, and append-only repos
  • rsync.net: Cloud Storage provider with full support for borg and any other SSH/SFTP tool

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