2018-09-01 22:45:13 -07:00
---
title: borgmatic
2019-05-20 11:41:39 -07:00
permalink: index.html
2018-09-01 22:38:17 -07:00
---
2019-05-13 22:56:49 +02:00
2019-11-14 09:34:53 -08:00
## It's your data. Keep it that way.
2014-10-30 22:34:03 -07:00
2019-11-14 09:34:53 -08:00
<img src="docs/static/borgmatic.png" alt="borgmatic logo" width="150px" style="float: right; padding-left: 1em;">
2018-08-29 22:44:12 -07:00
2019-05-26 13:35:51 -07:00
borgmatic is simple, configuration-driven backup software for servers and
2019-11-14 09:34:53 -08:00
workstations. Protect your files with client-side encryption. Backup your
databases too. Monitor it all with integrated third-party services.
2014-10-30 22:34:03 -07:00
2019-11-14 09:34:53 -08:00
Here's an example configuration file:
2014-11-25 16:01:59 -08:00
2017-07-04 18:23:59 -07:00
```yaml
location:
2019-11-14 09:34:53 -08:00
# List of source directories to backup.
2017-07-04 18:23:59 -07:00
source_directories:
- /home
- /etc
2020-01-18 20:00:18 -08:00
# Paths of local or remote repositories to backup to.
2017-07-22 22:56:46 -07:00
repositories:
2020-08-07 10:55:05 -07:00
- 1234@usw -s001.rsync.net:backups.borg
2020-08-27 15:21:53 -07:00
- k8pDxu32@k8pDxu32 .repo.borgbase.com:repo
2020-11-18 12:05:38 -08:00
- user1@scp2 .cdn.lima-labs.com:repo
2020-01-24 20:52:48 -08:00
- /var/lib/backups/local.borg
2017-07-04 18:23:59 -07:00
retention:
2019-11-14 09:34:53 -08:00
# Retention policy for how many backups to keep.
2017-07-04 18:23:59 -07:00
keep_daily: 7
keep_weekly: 4
keep_monthly: 6
consistency:
2019-11-14 09:34:53 -08:00
# List of checks to run to validate your backups.
2017-07-04 18:23:59 -07:00
checks:
- repository
- archives
2019-10-22 16:28:42 -07:00
hooks:
2019-11-14 09:34:53 -08:00
# Custom preparation scripts to run.
2019-10-22 16:28:42 -07:00
before_backup:
- prepare-for-backup.sh
2019-11-14 09:34:53 -08:00
# Databases to dump and include in backups.
2019-10-22 16:28:42 -07:00
postgresql_databases:
- name: users
2019-11-14 09:34:53 -08:00
# Third-party services to notify you if backups aren't happening.
2019-10-22 16:28:42 -07:00
healthchecks: https://hc-ping.com/be067061-cf96-4412-8eae-62b0c50d6a8c
2016-01-20 13:11:15 +01:00
```
2015-05-10 22:00:31 -07:00
2018-09-30 11:11:07 -07:00
Want to see borgmatic in action? Check out the <a
href="https://asciinema.org/a/203761" target="_blank">screencast</a>.
2018-09-29 21:38:38 -07:00
<script src="https://asciinema.org/a/203761.js" id="asciicast-203761" async></script>
2018-02-19 17:44:20 -08:00
2019-11-14 09:34:53 -08:00
borgmatic is powered by [Borg Backup ](https://www.borgbackup.org/ ).
## Integrations
2019-11-14 09:45:38 -08: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-08-27 15:21:53 -07:00
<a href="https://www.pagerduty.com/"><img src="docs/static/pagerduty.png" alt="PagerDuty" height="60px" style="margin-bottom:20px;"></a>
<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>
2019-11-14 09:45:38 -08:00
<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 09:34:53 -08:00
2014-10-30 22:34:03 -07:00
2020-08-21 14:27:47 -07:00
## Getting started
Your first step is to [install and configure
borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups/).
For additional documentation, check out the links above for <a
href="https://torsion.org/borgmatic/#documentation ">borgmatic how-to and
reference guides</a>.
2019-02-04 22:12:33 -08:00
2019-05-18 20:59:50 -07: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 15:35:04 -07:00
<ul>
2020-08-27 15:21:53 -07:00
<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>
2019-05-29 15:35:04 -07:00
<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>
2020-11-18 12:05:38 -08:00
<li class="referral"><a href="https://storage.lima-labs.com/special-pricing-offer-for-borgmatic-users/">Lima-Labs</a>: Affordable, reliable cloud data storage accessable via SSH/SCP/FTP for Borg backups or any other bulk storage needs</li>
2020-11-17 14:04:24 -08:00
</ul>
2018-06-17 14:55:57 -07:00
## Support and contributing
2014-11-17 21:57:44 -08:00
2018-06-17 14:55:57 -07: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 15:01:03 -07: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 15:04:01 -07: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 15:01:03 -07:00
2020-01-30 15:42:48 -08:00
Also see the [security
policy](https://torsion.org/borgmatic/docs/security-policy/) for any security
issues.
Other questions or comments? Contact
[witten@torsion.org ](mailto:witten@torsion.org ).
2018-06-17 14:55:57 -07:00
### Contributing
2019-11-14 09:34:53 -08:00
borgmatic is hosted at <https://torsion.org/borgmatic> with [source code
2020-03-09 15:50:54 -07:00
available](https://projects.torsion.org/witten/borgmatic), and is also
mirrored on [GitHub ](https://github.com/witten/borgmatic ) for convenience.
borgmatic is licensed under the GNU General Public License version 3 or any
later version.
2019-11-14 09:34:53 -08:00
2018-06-17 14:55:57 -07: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-03 22:20:59 -08:00
Also, please check out the [borgmatic development
2019-05-25 21:48:05 -07: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 09:34:53 -08:00
<a href="https://build.torsion.org/witten/borgmatic" alt="build status"></a>
