2018-09-02 05:45:13 +00:00
---
title: borgmatic
2019-05-20 18:41:39 +00:00
permalink: index.html
2018-09-02 05:38:17 +00:00
---
2019-05-13 20:56:49 +00:00
2019-11-14 17:34:53 +00:00
## It's your data. Keep it that way.
2014-10-31 05:34:03 +00:00
2019-11-14 17:34:53 +00:00
< img src = "docs/static/borgmatic.png" alt = "borgmatic logo" width = "150px" style = "float: right; padding-left: 1em;" >
2018-08-30 05:44:12 +00:00
2019-05-26 20:35:51 +00:00
borgmatic is simple, configuration-driven backup software for servers and
2019-11-14 17:34:53 +00:00
workstations. Protect your files with client-side encryption. Backup your
databases too. Monitor it all with integrated third-party services.
2014-10-31 05:34:03 +00:00
2019-11-14 17:34:53 +00:00
Here's an example configuration file:
2014-11-26 00:01:59 +00:00
2017-07-05 01:23:59 +00:00
```yaml
location:
2019-11-14 17:34:53 +00:00
# List of source directories to backup.
2017-07-05 01:23:59 +00:00
source_directories:
- /home
- /etc
2020-01-19 04:00:18 +00:00
# Paths of local or remote repositories to backup to.
2017-07-23 05:56:46 +00:00
repositories:
2020-01-19 04:00:18 +00:00
- 1234@usw-s001.rsync.net:backups.borg
- k8pDxu32@k8pDxu32.repo.borgbase.com:repo
2020-01-25 04:52:48 +00:00
- /var/lib/backups/local.borg
2017-07-05 01:23:59 +00:00
retention:
2019-11-14 17:34:53 +00:00
# Retention policy for how many backups to keep.
2017-07-05 01:23:59 +00:00
keep_daily: 7
keep_weekly: 4
keep_monthly: 6
consistency:
2019-11-14 17:34:53 +00:00
# List of checks to run to validate your backups.
2017-07-05 01:23:59 +00:00
checks:
- repository
- archives
2019-10-22 23:28:42 +00:00
hooks:
2019-11-14 17:34:53 +00:00
# Custom preparation scripts to run.
2019-10-22 23:28:42 +00:00
before_backup:
- prepare-for-backup.sh
2019-11-14 17:34:53 +00:00
# Databases to dump and include in backups.
2019-10-22 23:28:42 +00:00
postgresql_databases:
- name: users
2019-11-14 17:34:53 +00:00
# Third-party services to notify you if backups aren't happening.
2019-10-22 23:28:42 +00:00
healthchecks: https://hc-ping.com/be067061-cf96-4412-8eae-62b0c50d6a8c
2016-01-20 12:11:15 +00:00
```
2015-05-11 05:00:31 +00:00
2018-09-30 18:11:07 +00:00
Want to see borgmatic in action? Check out the < a
href="https://asciinema.org/a/203761" target="_blank">screencast< / a > .
2018-09-30 04:38:38 +00:00
< script src = "https://asciinema.org/a/203761.js" id = "asciicast-203761" async > < / script >
2018-02-20 01:44:20 +00:00
2019-11-14 17:34:53 +00:00
borgmatic is powered by [Borg Backup ](https://www.borgbackup.org/ ).
## Integrations
2019-11-14 17:45:38 +00:00
< a href = "https://www.postgresql.org/" > < img src = "docs/static/postgresql.png" alt = "PostgreSQL" height = "60px" style = "margin-bottom:20px;" > < / a >
< a href = "https://www.mysql.com/" > < img src = "docs/static/mysql.png" alt = "MySQL" height = "60px" style = "margin-bottom:20px;" > < / a >
< a href = "https://mariadb.com/" > < img src = "docs/static/mariadb.png" alt = "MariaDB" height = "60px" style = "margin-bottom:20px;" > < / a >
< a href = "https://healthchecks.io/" > < img src = "docs/static/healthchecks.png" alt = "Healthchecks" height = "60px" style = "margin-bottom:20px;" > < / a >
< a href = "https://cronitor.io/" > < img src = "docs/static/cronitor.png" alt = "Cronitor" height = "60px" style = "margin-bottom:20px;" > < / a >
< a href = "https://cronhub.io/" > < img src = "docs/static/cronhub.png" alt = "Cronhub" height = "60px" style = "margin-bottom:20px;" > < / a >
2020-01-27 23:32:09 +00:00
< a href = "https://www.pagerduty.com/" > < img src = "docs/static/pagerduty.png" alt = "PagerDuty" height = "60px" style = "margin-bottom:20px;" > < / a >
2019-11-14 17:45:38 +00:00
< a href = "https://www.rsync.net/cgi-bin/borg.cgi?campaign=borg&adgroup=borgmatic" > < img src = "docs/static/rsyncnet.png" alt = "rsync.net" height = "60px" style = "margin-bottom:20px;" > < / a >
< a href = "https://www.borgbase.com/?utm_source=borgmatic" > < img src = "docs/static/borgbase.png" alt = "BorgBase" height = "60px" style = "margin-bottom:20px;" > < / a >
2019-11-14 17:34:53 +00:00
2014-10-31 05:34:03 +00:00
2019-02-04 06:20:59 +00:00
## How-to guides
2014-10-31 05:34:03 +00:00
2019-05-26 04:48:05 +00:00
* [Set up backups with borgmatic ](https://torsion.org/borgmatic/docs/how-to/set-up-backups/ ) ⬅ *Start here!*
* [Make per-application backups ](https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/ )
* [Deal with very large backups ](https://torsion.org/borgmatic/docs/how-to/deal-with-very-large-backups/ )
* [Inspect your backups ](https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/ )
2019-10-15 17:49:14 +00:00
* [Monitor your backups ](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/ )
2019-11-01 04:45:47 +00:00
* [Extract a backup ](https://torsion.org/borgmatic/docs/how-to/extract-a-backup/ )
2019-10-23 22:35:37 +00:00
* [Backup your databases ](https://torsion.org/borgmatic/docs/how-to/backup-your-databases/ )
2019-07-05 16:03:08 +00:00
* [Add preparation and cleanup steps to backups ](https://torsion.org/borgmatic/docs/how-to/add-preparation-and-cleanup-steps-to-backups/ )
2020-01-25 04:52:48 +00:00
* [Backup to a removable drive or an intermittent server ](https://torsion.org/borgmatic/docs/how-to/backup-to-a-removable-drive-or-an-intermittent-server/ )
2019-05-26 04:48:05 +00:00
* [Upgrade borgmatic ](https://torsion.org/borgmatic/docs/how-to/upgrade/ )
* [Develop on borgmatic ](https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/ )
2016-06-10 18:53:45 +00:00
2017-07-10 18:06:28 +00:00
2019-02-05 06:12:33 +00:00
## Reference guides
2019-05-26 04:48:05 +00:00
* [borgmatic configuration reference ](https://torsion.org/borgmatic/docs/reference/configuration/ )
* [borgmatic command-line reference ](https://torsion.org/borgmatic/docs/reference/command-line/ )
2019-02-05 06:12:33 +00:00
2019-05-19 03:59:50 +00:00
## 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.)
2019-05-29 22:35:04 +00:00
< ul >
< li class = "referral" > < a href = "https://www.rsync.net/cgi-bin/borg.cgi?campaign=borg&adgroup=borgmatic" > rsync.net< / a > : Cloud Storage provider with full support for borg and any other SSH/SFTP tool< / li >
< li class = "referral" > < a href = "https://www.borgbase.com/?utm_source=borgmatic" > BorgBase< / a > : Borg hosting service with support for monitoring, 2FA, and append-only repos< / li >
< / ul >
2019-05-19 03:59:50 +00:00
2018-06-17 21:55:57 +00:00
## Support and contributing
2014-11-18 05:57:44 +00:00
2018-06-17 21:55:57 +00:00
### 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.
2019-05-19 22:01:03 +00:00
If you'd like to chat with borgmatic developers or users, head on over to the
`#borgmatic` IRC channel on Freenode, either via < a
2019-05-19 22:04:01 +00:00
href="https://webchat.freenode.net/?channels=borgmatic">web chat< / a > or a
native < a href = "irc://chat.freenode.net:6697" > IRC client< / a > .
2019-05-19 22:01:03 +00:00
2018-06-17 21:55:57 +00:00
Other questions or comments? Contact < mailto:witten @ torsion . org > .
### Contributing
2019-11-14 17:34:53 +00:00
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.
2018-06-17 21:55:57 +00:00
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!
2019-02-04 06:20:59 +00:00
Also, please check out the [borgmatic development
2019-05-26 04:48:05 +00:00
how-to](https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/) for
info on cloning source code, running tests, etc.
2019-11-14 17:34:53 +00:00
< a href = "https://build.torsion.org/witten/borgmatic" alt = "build status" > < / a >
