Simple, configuration-driven backup software for servers and workstations

Dan Helfman 196a226a7e Add "check_i_know_what_i_am_doing" option to NEWS (#724). 2 vuotta sitten
.gitea 612e1fea67 Add database version to issue template. 5 vuotta sitten
borgmatic 7d18f59079 Add a config entry for BORG_CHECK_I_KNOW_WHAT_I_AM_DOING env var 2 vuotta sitten
docs 9cafc16052 For "borgmatic borg", pass the repository to Borg via a Borg-supported environment variable (#575). 2 vuotta sitten
sample 1d7c7eaaa7 Add sample systemd user serivce for running borgmatic as a non-root user (#669). 2 vuotta sitten
scripts b5d9398910 Stop uploading GPG signatures to pypi since it no longer supports them. 2 vuotta sitten
tests 7d18f59079 Add a config entry for BORG_CHECK_I_KNOW_WHAT_I_AM_DOING env var 2 vuotta sitten
.dockerignore cd91dbd4f7 Include sub-command help in documentation. 6 vuotta sitten
.drone.yml 23809e9060 More Docker build fun (#326). 2 vuotta sitten
.eleventy.js 66d2f49f18 docs: copy to clipboard support 2 vuotta sitten
.flake8 5d19d86e4a Add flake8-quotes to complain about incorrect quoting so I don't have to! 2 vuotta sitten
.gitignore cf8882f2bc Run arbitrary Borg commands with new "borgmatic borg" action (#425). 4 vuotta sitten
AUTHORS 6cdc92bd0c Fix for "borgmatic restore" showing success and incorrectly extracting archive files, even when no databases are configured to restore (#246). 5 vuotta sitten
LICENSE 7b3efddcbd Adding GPL v3 license. 10 vuotta sitten
MANIFEST.in 07222cd984 Fix visibility of "borgmatic prune --stats" output (#219). 5 vuotta sitten
NEWS 196a226a7e Add "check_i_know_what_i_am_doing" option to NEWS (#724). 2 vuotta sitten
README.md fbbfc684ce Add referral link for Hetzner. 2 vuotta sitten
SECURITY.md 065be1d9d4 More inclusive language. 2 vuotta sitten
pyproject.toml 20b8b45aeb Remove all configuration from Tox file 6 vuotta sitten
setup.cfg 8cb5a42a9e Drop deprecated pkg_resources in favor of importlib.metadata and packaging. 2 vuotta sitten
setup.py bb6004fc4f Revamp "borg" action to support REPOSITORY and ARCHIVE env vars instead of implicitly injecting repository/archive into the Borg command (#575). 2 vuotta sitten
test_requirements.txt 05b989347c Upgrade requests test requirement (security). 2 vuotta sitten
tox.ini 7ee37a890e Fix broken end-to-end tests by no longer using an editable package there, a work-around for https://github.com/pypa/packaging-problems/issues/609 2 vuotta sitten

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:
        - path: ssh://k8pDxu32@k8pDxu32.repo.borgbase.com/./repo
          label: borgbase
        - path: /var/lib/backups/local.borg
          label: local

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:
        - name: repository
        - name: archives
          frequency: 2 weeks

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      MongoDB      SQLite      Healthchecks      Cronitor      Cronhub      PagerDuty      ntfy      BorgBase     

Getting started

Your first step is to install and configure borgmatic.

For additional documentation, check out the links above (left panel on wide screens) 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 referral links to sign up:

  • BorgBase: Borg hosting service with support for monitoring, 2FA, and append-only repos
  • Hetzner: A "storage box" that includes support for Borg

Additionally, rsync.net has a compatible storage offering, but does not fund borgmatic development or hosting.

Support and contributing

Issues

Are you experiencing an issue with borgmatic? Or do you have an idea for a feature enhancement? Head on over to our issue tracker. In order to create a new issue or add a comment, you'll need to register first. If you prefer to use an existing GitHub account, you can skip account creation and login directly.

Also see the security policy for any security issues.

Social

Follow borgmatic on Mastodon.

Chat

To chat with borgmatic developers or users, check out 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.

Other

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 to discuss your idea. Note that you'll need to register first. 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