Simple, configuration-driven backup software for servers and workstations

Dan Helfman 631da1465e Add support for Python 3.9. 4 anni fa
.gitea 612e1fea67 Add database version to issue template. 5 anni fa
borgmatic eb4b4cc92b Fix line length in schema. 4 anni fa
docs 5d82b42ab8 Fix link to issue tracker in documentation 4 anni fa
sample 717c90a7d0 Clarify in systemd service file comment that security settings are optional. 4 anni fa
scripts 8b8f92d717 Prevent newer (borgmatic-unsupported) version of Black code formatter installing in Alpine Edge. 4 anni fa
tests 4897a78fd3 Fix database tests broken by PostgreSQL upgrade in Alpine Edge. 4 anni fa
.dockerignore cd91dbd4f7 Include sub-command help in documentation. 6 anni fa
.drone.yml 4897a78fd3 Fix database tests broken by PostgreSQL upgrade in Alpine Edge. 4 anni fa
.eleventy.js 79d4888e22 Add documentation navigation links on left side of all documentation pages. 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 631da1465e Add support for Python 3.9. 4 anni fa
README.md 97af16bd86 Add Lima-Labs to examples. 4 anni fa
SECURITY.md 1ddde0910c Add security policy, such as it is. 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 ea6cd53067 Update versions of test dependencies (test_requirements.txt and test containers). 4 anni fa
test_requirements.txt 631da1465e Add support for Python 3.9. 4 anni fa
tox.ini 631da1465e Add support for Python 3.9. 4 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 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 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
  • Lima-Labs: Affordable, reliable cloud data storage accessable via SSH/SCP/FTP for Borg backups or any other bulk storage needs

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