psw/borgmatic: Workspace for adding Uptime Kuma hook to official borgmatic

Workspace for adding Uptime Kuma hook to official borgmatic

Find a file

Robin Schneider 52e4f48eb9 Add validate-borgmatic-config command Useful when generating the borgmatic configuration file with configuration management and before moving the generated file in place checking if it is actually valid.		2019-05-10 00:10:28 +02:00
borgmatic	Add validate-borgmatic-config command	2019-05-10 00:10:28 +02:00
docs	Clarify differences between Docker images.	2019-03-16 15:04:48 -07:00
sample	Add example for cron in Alpine Linux (#24 )	2018-09-05 21:58:30 -07:00
scripts	Update push script to support branches.	2019-02-18 13:51:33 -08:00
static	Adding missing PNG logo.	2017-10-28 10:31:30 -07:00
tests	Add validate-borgmatic-config command	2019-05-10 00:10:28 +02:00
.drone.yml	In continuous integration build matrix, use newer Alpine 3.9 instead of 3.8.	2019-05-07 16:19:03 -07:00
.gitignore	Upgrade ruamel.yaml compatibility version range and fix support for Python 3.7 (#38 , #76 ).	2018-07-22 11:25:06 -07:00
AUTHORS	Add validate-borgmatic-config command	2019-05-10 00:10:28 +02:00
LICENSE	Adding GPL v3 license.	2014-11-18 18:22:51 -08:00
MANIFEST.in	Basic YAML configuration file parsing.	2017-07-04 16:52:24 -07:00
NEWS	Fix for hooks executing when using --dry-run (#160 ).	2019-05-07 16:06:31 -07:00
README.md	Update extraction docs.	2019-02-18 22:43:32 -08:00
setup.cfg	No longer producing univeral (Python 2 + 3) wheel.	2017-07-23 17:34:17 -07:00
setup.py	Add validate-borgmatic-config command	2019-05-10 00:10:28 +02:00
test_requirements.txt	Make automated tests support running in Python 3.5.	2018-10-15 09:04:29 -07:00
tox.ini	Switch from bash to sh for black wrapper.	2018-10-15 09:25:57 -07:00

README.md

title	permalink
borgmatic	borgmatic/index.html

Overview

borgmatic is a simple Python wrapper script for the Borg backup software that initiates a backup, prunes any old backups according to a retention policy, and validates backups for consistency. The script 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", or both.
    checks:
        - repository
        - archives

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

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.

Other questions or comments? Contact mailto: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.