2018-09-02 07:45:13 +02:00
---
title: borgmatic
2019-05-20 20:41:39 +02:00
permalink: index.html
2018-09-02 07:38:17 +02:00
---
2019-05-13 22:56:49 +02:00
2019-11-14 18:34:53 +01:00
## It's your data. Keep it that way.
2014-10-31 06:34:03 +01:00
2019-11-14 18:34:53 +01:00
< img src = "docs/static/borgmatic.png" alt = "borgmatic logo" width = "150px" style = "float: right; padding-left: 1em;" >
2018-08-30 07:44:12 +02:00
2019-05-26 22:35:51 +02:00
borgmatic is simple, configuration-driven backup software for servers and
2019-11-14 18:34:53 +01:00
workstations. Protect your files with client-side encryption. Backup your
databases too. Monitor it all with integrated third-party services.
2014-10-31 06:34:03 +01:00
2021-04-09 23:54:21 +02:00
The canonical home of borgmatic is at < a href = "https://torsion.org/borgmatic" > https://torsion.org/borgmatic< / a > .
2019-11-14 18:34:53 +01:00
Here's an example configuration file:
2014-11-26 01:01:59 +01:00
2017-07-05 03:23:59 +02:00
```yaml
location:
2019-11-14 18:34:53 +01:00
# List of source directories to backup.
2017-07-05 03:23:59 +02:00
source_directories:
- /home
- /etc
2020-01-19 05:00:18 +01:00
# Paths of local or remote repositories to backup to.
2017-07-23 07:56:46 +02:00
repositories:
2020-08-07 19:55:05 +02:00
- 1234@usw-s001.rsync.net:backups.borg
2020-08-28 00:21:53 +02:00
- k8pDxu32@k8pDxu32.repo.borgbase.com:repo
2020-01-25 05:52:48 +01:00
- /var/lib/backups/local.borg
2017-07-05 03:23:59 +02:00
retention:
2019-11-14 18:34:53 +01:00
# Retention policy for how many backups to keep.
2017-07-05 03:23:59 +02:00
keep_daily: 7
keep_weekly: 4
keep_monthly: 6
consistency:
2019-11-14 18:34:53 +01:00
# List of checks to run to validate your backups.
2017-07-05 03:23:59 +02:00
checks:
2022-05-28 23:42:19 +02:00
- name: repository
- name: archives
frequency: 2 weeks
2019-10-23 01:28:42 +02:00
hooks:
2019-11-14 18:34:53 +01:00
# Custom preparation scripts to run.
2019-10-23 01:28:42 +02:00
before_backup:
- prepare-for-backup.sh
2019-11-14 18:34:53 +01:00
# Databases to dump and include in backups.
2019-10-23 01:28:42 +02:00
postgresql_databases:
- name: users
2019-11-14 18:34:53 +01:00
# Third-party services to notify you if backups aren't happening.
2019-10-23 01:28:42 +02:00
healthchecks: https://hc-ping.com/be067061-cf96-4412-8eae-62b0c50d6a8c
2016-01-20 13:11:15 +01:00
```
2015-05-11 07:00:31 +02:00
2018-09-30 20:11:07 +02:00
Want to see borgmatic in action? Check out the < a
2021-11-25 22:09:55 +01:00
href="https://asciinema.org/a/203761?autoplay=1" target="_blank">screencast< / a > .
2018-09-30 20:11:07 +02:00
2021-11-25 22:09:55 +01:00
< a href = "https://asciinema.org/a/203761?autoplay=1" target = "_blank" > < img src = "https://asciinema.org/a/203761.png" width = "480" > < / a >
2018-02-20 02:44:20 +01:00
2019-11-14 18:34:53 +01:00
borgmatic is powered by [Borg Backup ](https://www.borgbackup.org/ ).
## Integrations
2019-11-14 18:45:38 +01: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 >
2022-01-05 01:26:38 +01:00
< a href = "https://www.mongodb.com/" > < img src = "docs/static/mongodb.png" alt = "MongoDB" height = "60px" style = "margin-bottom:20px;" > < / a >
2019-11-14 18:45:38 +01:00
< 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-28 00:21:53 +02:00
< a href = "https://www.pagerduty.com/" > < img src = "docs/static/pagerduty.png" alt = "PagerDuty" height = "60px" style = "margin-bottom:20px;" > < / a >
2022-06-09 22:41:22 +02:00
< a href = "https://ntfy.sh/" > < img src = "docs/static/ntfy.png" alt = "ntfy" height = "60px" style = "margin-bottom:20px;" > < / a >
2019-11-14 18:45:38 +01: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 18:34:53 +01:00
2014-10-31 06:34:03 +01:00
2020-08-21 23:27:47 +02: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-05 07:12:33 +01:00
2019-05-19 05:59:50 +02:00
## Hosting providers
2021-04-19 02:28:11 +02:00
Need somewhere to store your encrypted off-site backups? The following hosting
2021-04-19 03:03:43 +02:00
providers include specific support for Borg/borgmatic—and fund borgmatic
development and hosting when you use these links to sign up. (These are
referral links, but without any tracking scripts or cookies.)
2019-05-19 05:59:50 +02:00
2019-05-30 00:35:04 +02:00
< ul >
< 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-17 23:04:24 +01:00
< / ul >
2021-11-16 05:06:09 +01:00
Additionally, [rsync.net ](https://www.rsync.net/products/borg.html ) and
[Hetzner ](https://www.hetzner.com/storage/storage-box ) have compatible storage
offerings, but do not currently fund borgmatic development or hosting.
2021-04-19 03:03:43 +02:00
2018-06-17 23:55:57 +02:00
## Support and contributing
2014-11-18 06:57:44 +01:00
2018-06-17 23:55:57 +02:00
### Issues
You've got issues? Or an idea for a feature enhancement? We've got an [issue
2021-09-14 20:32:01 +02:00
tracker](https://projects.torsion.org/borgmatic-collective/borgmatic/issues). In order to
2018-06-17 23:55:57 +02:00
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-20 00:01:03 +02:00
If you'd like to chat with borgmatic developers or users, head on over to the
2021-06-07 06:09:40 +02:00
`#borgmatic` IRC channel on Libera Chat, either via < a
href="https://web.libera.chat/#borgmatic">web chat< / a > or a
native < a href = "ircs://irc.libera.chat:6697" > IRC client< / a > . If you
2021-04-09 23:54:21 +02:00
don't get a response right away, please hang around a while—or file a ticket
instead.
2019-05-20 00:01:03 +02:00
2020-01-31 00:42:48 +01: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 23:55:57 +02:00
### Contributing
2021-04-09 23:54:21 +02:00
borgmatic [source code is
2021-09-14 20:32:01 +02:00
available](https://projects.torsion.org/borgmatic-collective/borgmatic) and is also mirrored
2021-09-14 19:18:10 +02:00
on [GitHub ](https://github.com/borgmatic-collective/borgmatic ) for convenience.
2020-03-09 23:50:54 +01:00
borgmatic is licensed under the GNU General Public License version 3 or any
later version.
2019-11-14 18:34:53 +01:00
2018-06-17 23:55:57 +02:00
If you'd like to contribute to borgmatic development, please feel free to
2021-09-14 20:32:01 +02:00
submit a [Pull Request ](https://projects.torsion.org/borgmatic-collective/borgmatic/pulls )
or open an [issue ](https://projects.torsion.org/borgmatic-collective/borgmatic/issues ) first
2018-06-17 23:55:57 +02:00
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 07:20:59 +01:00
Also, please check out the [borgmatic development
2019-05-26 06:48:05 +02: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 18:34:53 +01:00
2021-09-14 20:35:34 +02:00
< a href = "https://build.torsion.org/borgmatic-collective/borgmatic" alt = "build status" > < / a >
2019-11-14 18:34:53 +01:00
