Simple, configuration-driven backup software for servers and workstations

Dan Helfman 1709f57ff0 Fix hang when restoring a PostgreSQL "tar" format database dump (#430). %!s(int64=4) %!d(string=hai) anos
.gitea 612e1fea67 Add database version to issue template. %!s(int64=5) %!d(string=hai) anos
borgmatic 1709f57ff0 Fix hang when restoring a PostgreSQL "tar" format database dump (#430). %!s(int64=4) %!d(string=hai) anos
docs 9c972cb0e5 Add documentation note about systemd configuration with alternate install methods (#428). %!s(int64=4) %!d(string=hai) anos
sample bc2e611a74 Suppress console output in sample crontab/systemd service files (#379). %!s(int64=4) %!d(string=hai) anos
scripts 88cb49dcc4 Fix release script based on GitHub authentication query parameter deprecation. %!s(int64=4) %!d(string=hai) anos
tests 1709f57ff0 Fix hang when restoring a PostgreSQL "tar" format database dump (#430). %!s(int64=4) %!d(string=hai) anos
.dockerignore cd91dbd4f7 Include sub-command help in documentation. %!s(int64=6) %!d(string=hai) anos
.drone.yml d543109ef4 "Fix" build failure with Alpine Edge by switching from Edge to Alpine 3.13. %!s(int64=4) %!d(string=hai) anos
.eleventy.js 79d4888e22 Add documentation navigation links on left side of all documentation pages. %!s(int64=5) %!d(string=hai) anos
.gitignore cf8882f2bc Run arbitrary Borg commands with new "borgmatic borg" action (#425). %!s(int64=4) %!d(string=hai) anos
AUTHORS 6cdc92bd0c Fix for "borgmatic restore" showing success and incorrectly extracting archive files, even when no databases are configured to restore (#246). %!s(int64=5) %!d(string=hai) anos
LICENSE 7b3efddcbd Adding GPL v3 license. %!s(int64=10) %!d(string=hai) anos
MANIFEST.in 07222cd984 Fix visibility of "borgmatic prune --stats" output (#219). %!s(int64=6) %!d(string=hai) anos
NEWS 1709f57ff0 Fix hang when restoring a PostgreSQL "tar" format database dump (#430). %!s(int64=4) %!d(string=hai) anos
README.md f5c61c8013 Move #borgmatic IRC channel from Freenode to Libera Chat due to Freenode takeover drama. %!s(int64=4) %!d(string=hai) anos
SECURITY.md 1ddde0910c Add security policy, such as it is. %!s(int64=5) %!d(string=hai) anos
pyproject.toml 20b8b45aeb Remove all configuration from Tox file %!s(int64=6) %!d(string=hai) anos
setup.cfg c072678936 Add support for ruamel.yaml 0.17.x YAML parsing library (#404). %!s(int64=4) %!d(string=hai) anos
setup.py 27d37b606b Better error messages! Switch the library used for validating configuration files (from pykwalify to jsonschema). %!s(int64=4) %!d(string=hai) anos
test_requirements.txt 27d37b606b Better error messages! Switch the library used for validating configuration files (from pykwalify to jsonschema). %!s(int64=4) %!d(string=hai) anos
tox.ini 631da1465e Add support for Python 3.9. %!s(int64=4) %!d(string=hai) anos

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.

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