Simple, configuration-driven backup software for servers and workstations

Dan Helfman 60b1f9921d Don't use pip wrapper script in CI. há 6 anos atrás
borgmatic 1c0dc3f904 Run isort over the source há 6 anos atrás
docs 9f6407ada6 Mention continuous integration badge in NEWS. há 6 anos atrás
sample 67f2862fb1 Change paths to reflect new pip install --user documentation. há 6 anos atrás
scripts ed2c6053de Upgrade pip to a particular version during local test and CI. há 6 anos atrás
static 469feadbc0 Adding missing PNG logo. há 7 anos atrás
tests 1c0dc3f904 Run isort over the source há 6 anos atrás
.drone.yml 60b1f9921d Don't use pip wrapper script in CI. há 6 anos atrás
.gitignore d29c7956bc Upgrade ruamel.yaml compatibility version range and fix support for Python 3.7 (#38, #76). há 7 anos atrás
AUTHORS 52e4f48eb9 Add validate-borgmatic-config command há 6 anos atrás
LICENSE 7b3efddcbd Adding GPL v3 license. há 10 anos atrás
MANIFEST.in 4d7556f68b Basic YAML configuration file parsing. há 8 anos atrás
NEWS ed2c6053de Upgrade pip to a particular version during local test and CI. há 6 anos atrás
README.md 2dd899f287 Linkify build status badge. há 6 anos atrás
pyproject.toml 20b8b45aeb Remove all configuration from Tox file há 6 anos atrás
setup.cfg b94dbff216 Add isort configuration há 6 anos atrás
setup.py 1c0dc3f904 Run isort over the source há 6 anos atrás
test_requirements.txt b94dbff216 Add isort configuration há 6 anos atrás
tox.ini ed2c6053de Upgrade pip to a particular version during local test and CI. há 6 anos atrás

README.md


title: borgmatic

permalink: borgmatic/index.html

Build Status

Overview

borgmatic logo

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 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.