116 lines
4.3 KiB
Markdown
116 lines
4.3 KiB
Markdown
---
|
|
title: borgmatic
|
|
permalink: borgmatic/index.html
|
|
---
|
|
<a href="https://build.torsion.org/witten/borgmatic" alt="build status"></a>
|
|
|
|
## Overview
|
|
|
|
<img src="https://projects.torsion.org/witten/borgmatic/raw/branch/master/static/borgmatic.png" alt="borgmatic logo" width="150px" style="float: right; padding-left: 1em;">
|
|
|
|
borgmatic is a simple Python wrapper script for the
|
|
[Borg](https://www.borgbackup.org/) 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:
|
|
|
|
```yaml
|
|
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](https://projects.torsion.org/witten/borgmatic). It's also mirrored
|
|
on [GitHub](https://github.com/witten/borgmatic) for convenience.
|
|
|
|
Want to see borgmatic in action? Check out the <a
|
|
href="https://asciinema.org/a/203761" target="_blank">screencast</a>.
|
|
|
|
<script src="https://asciinema.org/a/203761.js" id="asciicast-203761" async></script>
|
|
|
|
|
|
## How-to guides
|
|
|
|
* [Set up backups with borgmatic](docs/how-to/set-up-backups.md) ⬅ *Start here!*
|
|
* [Make per-application backups](docs/how-to/make-per-application-backups.md)
|
|
* [Deal with very large backups](docs/how-to/deal-with-very-large-backups.md)
|
|
* [Inspect your backups](docs/how-to/inspect-your-backups.md)
|
|
* [Restore a backup](docs/how-to/restore-a-backup.md)
|
|
* [Run preparation steps before backups](docs/how-to/run-preparation-steps-before-backups.md)
|
|
* [Upgrade borgmatic](docs/how-to/upgrade.md)
|
|
* [Develop on borgmatic](docs/how-to/develop-on-borgmatic.md)
|
|
|
|
|
|
## Reference guides
|
|
|
|
* [borgmatic configuration reference](docs/reference/configuration.md)
|
|
* [borgmatic command-line reference](docs/reference/command-line.md)
|
|
|
|
|
|
## 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.)
|
|
|
|
* [BorgBase](https://www.borgbase.com/?utm_source=borgmatic): 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](https://projects.torsion.org/witten/borgmatic/issues). In order to
|
|
create a new issue or comment on an issue, you'll need to [login
|
|
first](https://projects.torsion.org/user/login). 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 <a
|
|
href="https://webchat.freenode.net/?channels=borgmatic">web chat</a> or a
|
|
native <a href="irc://chat.freenode.net:6697">IRC client</a>.
|
|
|
|
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](https://projects.torsion.org/witten/borgmatic/pulls)
|
|
or open an [issue](https://projects.torsion.org/witten/borgmatic/issues) 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](docs/how-to/develop-on-borgmatic.md) for info on cloning source code,
|
|
running tests, etc.
|