Simple, configuration-driven backup software for servers and workstations https://torsion.org/borgmatic/
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.
Dan Helfman 2a771161e7 Finish test coverage for MySQL restore (#228). пре 34 минута
.gitea In issue template, use python3 instead of python. пре 2 месеци
borgmatic Finish test coverage for MySQL restore (#228). пре 34 минута
docs Fix installation path in docs. пре 4 дана
sample Merge sample cron files. пре 1 месец
scripts Attempt to upgrade version of pip used in CI. пре 1 недеља
static Adding missing PNG logo. пре 2 година
tests Finish test coverage for MySQL restore (#228). пре 34 минута
.dockerignore Include sub-command help in documentation. пре 4 месеци
.drone.yml Add Python 3.8 to build matrix. пре 1 недеља
.eleventy.js Database dump hooks documentation (#225). пре 2 недеља
.gitignore Config generation support for sequences of maps, needed for database dump hooks (#225). пре 3 недеља
AUTHORS Indicate in AUTHORS that it's not an exhaustive list. пре 1 дан
LICENSE Adding GPL v3 license. пре 5 година
MANIFEST.in Fix visibility of "borgmatic prune --stats" output (#219). пре 1 месец
NEWS Database dump hooks for MySQL/MariaDB (#228). пре 3 дана
README.md Documentation for database restores (#229). пре 1 недеља
pyproject.toml Remove all configuration from Tox file пре 6 месеци
setup.cfg Suppress part of an obnoxious warning about disabling coverage (for end-to-end tests). пре 5 месеци
setup.py Database dump hooks for MySQL/MariaDB (#228). пре 3 дана
test_requirements.txt Update test requirements. пре 1 недеља
tox.ini Remove broken Tox Python version filter when running Black (code formatter) environment directly. пре 1 недеља

README.md


title: borgmatic

Build Status

Overview

borgmatic logo

borgmatic is simple, configuration-driven backup software for servers and workstations. Backup all of your machines from the command-line or scheduled jobs. No GUI required. Built atop Borg Backup, borgmatic initiates a backup, prunes any old backups according to a retention policy, and validates backups for consistency. borgmatic supports specifying your settings in a declarative configuration file, rather than having to put them all on the command-line, and handles common errors.

Here’s an example config file:

location:
    # List of source directories to backup. Globs are expanded.
    source_directories:
        - /home
        - /etc
        - /var/log/syslog*

    # Paths to local or remote repositories.
    repositories:
        - user@backupserver:sourcehostname.borg

    # Any paths matching these patterns are excluded from backups.
    exclude_patterns:
        - /home/*/.cache

retention:
    # Retention policy for how many backups to keep in each category.
    keep_daily: 7
    keep_weekly: 4
    keep_monthly: 6

consistency:
    # List of consistency checks to run: "repository", "archives", etc.
    checks:
        - repository
        - archives

hooks:
    # Preparation scripts to run, databases to dump, and monitoring to perform.
    before_backup:
        - prepare-for-backup.sh
    postgresql_databases:
        - name: users
    healthchecks: https://hc-ping.com/be067061-cf96-4412-8eae-62b0c50d6a8c

borgmatic is hosted at https://torsion.org/borgmatic with source code available. It’s also mirrored on GitHub for convenience.

Want to see borgmatic in action? Check out the screencast.

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.

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

Contributing

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.