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
2023-04-28 15:36:03 +00:00
The canonical home of borgmatic is at < a href = "https://torsion.org/borgmatic" > https://torsion.org/borgmatic/< / a >
2021-04-09 21:54:21 +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
2023-07-12 02:42:14 +00:00
# List of source directories to backup.
source_directories:
- /home
- /etc
# Paths of local or remote repositories to backup to.
repositories:
- path: ssh://k8pDxu32@k8pDxu32.repo.borgbase.com/./repo
label: borgbase
- path: /var/lib/backups/local.borg
label: local
# Retention policy for how many backups to keep.
keep_daily: 7
keep_weekly: 4
keep_monthly: 6
# List of checks to run to validate your backups.
checks:
- name: repository
- name: archives
frequency: 2 weeks
# Custom preparation scripts to run.
before_backup:
- prepare-for-backup.sh
# Databases to dump and include in backups.
postgresql_databases:
- name: users
# Third-party services to notify you if backups aren't happening.
2023-10-11 19:56:21 +00:00
healthchecks:
ping_url: 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
2019-11-14 17:34:53 +00:00
borgmatic is powered by [Borg Backup ](https://www.borgbackup.org/ ).
## Integrations
2023-10-05 16:06:06 +00:00
< a href = "https://www.postgresql.org/" > < img src = "docs/static/postgresql.png" alt = "PostgreSQL" height = "60px" style = "margin-bottom:20px; margin-right:20px;" > < / a >
< a href = "https://www.mysql.com/" > < img src = "docs/static/mysql.png" alt = "MySQL" height = "60px" style = "margin-bottom:20px; margin-right:20px;" > < / a >
< a href = "https://mariadb.com/" > < img src = "docs/static/mariadb.png" alt = "MariaDB" height = "60px" style = "margin-bottom:20px; margin-right:20px;" > < / a >
< a href = "https://www.mongodb.com/" > < img src = "docs/static/mongodb.png" alt = "MongoDB" height = "60px" style = "margin-bottom:20px; margin-right:20px;" > < / a >
< a href = "https://sqlite.org/" > < img src = "docs/static/sqlite.png" alt = "SQLite" height = "60px" style = "margin-bottom:20px; margin-right:20px;" > < / a >
2024-11-23 18:50:58 +00:00
< a href = "https://openzfs.org/" > < img src = "docs/static/openzfs.png" alt = "OpenZFS" height = "60px" style = "margin-bottom:20px; margin-right:20px;" > < / a >
2024-11-30 17:36:52 +00:00
< a href = "https://btrfs.readthedocs.io/" > < img src = "docs/static/btrfs.png" alt = "Btrfs" height = "60px" style = "margin-bottom:20px; margin-right:20px;" > < / a >
2024-11-25 02:59:21 +00:00
< a href = "https://rclone.org" > < img src = "docs/static/rclone.png" alt = "rclone" height = "60px" style = "margin-bottom:20px; margin-right:20px;" > < / a >
2023-10-05 16:06:06 +00:00
< a href = "https://healthchecks.io/" > < img src = "docs/static/healthchecks.png" alt = "Healthchecks" height = "60px" style = "margin-bottom:20px; margin-right:20px;" > < / a >
2024-06-21 16:00:44 +00:00
< a href = "https://uptime.kuma.pet/" > < img src = "docs/static/uptimekuma.png" alt = "Uptime Kuma" height = "60px" style = "margin-bottom:20px; margin-right:20px;" > < / a >
2023-10-05 16:06:06 +00:00
< a href = "https://cronitor.io/" > < img src = "docs/static/cronitor.png" alt = "Cronitor" height = "60px" style = "margin-bottom:20px; margin-right:20px;" > < / a >
< a href = "https://cronhub.io/" > < img src = "docs/static/cronhub.png" alt = "Cronhub" height = "60px" style = "margin-bottom:20px; margin-right:20px;" > < / a >
< a href = "https://www.pagerduty.com/" > < img src = "docs/static/pagerduty.png" alt = "PagerDuty" height = "60px" style = "margin-bottom:20px; margin-right:20px;" > < / a >
2024-10-30 19:43:06 +00:00
< a href = "https://www.pushover.net/" > < img src = "docs/static/pushover.png" alt = "Pushover" height = "60px" style = "margin-bottom:20px; margin-right:20px;" > < / a >
2023-10-05 16:06:06 +00:00
< a href = "https://ntfy.sh/" > < img src = "docs/static/ntfy.png" alt = "ntfy" height = "60px" style = "margin-bottom:20px; margin-right:20px;" > < / a >
< a href = "https://grafana.com/oss/loki/" > < img src = "docs/static/loki.png" alt = "Loki" height = "60px" style = "margin-bottom:20px; margin-right:20px;" > < / a >
< a href = "https://github.com/caronc/apprise/wiki" > < img src = "docs/static/apprise.png" alt = "Apprise" height = "60px" style = "margin-bottom:20px; margin-right:20px;" > < / a >
2024-10-29 17:33:19 +00:00
< a href = "https://www.zabbix.com/" > < img src = "docs/static/zabbix.png" alt = "Zabbix" height = "40px" style = "margin-bottom:20px; margin-right:20px;" > < / a >
2023-10-05 16:06:06 +00:00
< a href = "https://www.borgbase.com/?utm_source=borgmatic" > < img src = "docs/static/borgbase.png" alt = "BorgBase" height = "60px" style = "margin-bottom:20px; margin-right:20px;" > < / a >
2019-11-14 17:34:53 +00:00
2014-10-31 05:34:03 +00:00
2020-08-21 21:27:47 +00:00
## Getting started
Your first step is to [install and configure
borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups/).
2023-03-15 11:54:49 +00:00
For additional documentation, check out the links above (left panel on wide screens)
for < a href = "https://torsion.org/borgmatic/#documentation" > borgmatic how-to and
2020-08-21 21:27:47 +00:00
reference guides< / a > .
2019-02-05 06:12:33 +00:00
2019-05-19 03:59:50 +00:00
## Hosting providers
2021-04-19 00:28:11 +00:00
Need somewhere to store your encrypted off-site backups? The following hosting
2021-04-19 01:03:43 +00:00
providers include specific support for Borg/borgmatic—and fund borgmatic
2023-07-03 05:14:36 +00:00
development and hosting when you use these referral links to sign up:
2019-05-19 03:59:50 +00:00
2019-05-29 22:35:04 +00: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 >
2023-07-03 05:14:36 +00:00
< li class = "referral" > < a href = "https://hetzner.cloud/?ref=v9dOJ98Ic9I8" > Hetzner< / a > : A "storage box" that includes support for Borg< / li >
2020-11-17 22:04:24 +00:00
< / ul >
2023-07-03 05:14:36 +00:00
Additionally, rsync.net has a compatible storage offering, but does not fund
borgmatic development or hosting.
2021-04-19 01:03:43 +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
2022-12-16 19:39:05 +00:00
Are you experiencing an issue with borgmatic? Or do you have an idea for a
feature enhancement? Head on over to our [issue
2022-12-14 07:44:27 +00:00
tracker](https://projects.torsion.org/borgmatic-collective/borgmatic/issues).
2022-12-16 19:39:05 +00:00
In order to create a new issue or add a comment, you'll need to
2022-12-14 07:44:27 +00:00
[register ](https://projects.torsion.org/user/sign_up?invite_code=borgmatic )
2022-12-16 19:39:05 +00:00
first. If you prefer to use an existing GitHub account, you can skip account
creation and [login directly ](https://projects.torsion.org/user/login ).
2022-12-14 07:44:27 +00:00
2022-12-16 19:39:05 +00:00
Also see the [security
policy](https://torsion.org/borgmatic/docs/security-policy/) for any security
issues.
### Social
2023-07-01 05:55:47 +00:00
Follow [borgmatic on Mastodon ](https://fosstodon.org/@borgmatic ).
2022-12-16 19:39:05 +00:00
### Chat
To chat with borgmatic developers or users, check out the `#borgmatic`
2022-12-14 07:44:27 +00:00
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 don't get a response
right away, please hang around a while—or file a ticket instead.
2019-05-19 22:01:03 +00:00
2022-12-16 19:39:05 +00:00
### Other
2020-01-30 23:42:48 +00:00
Other questions or comments? Contact
[witten@torsion.org ](mailto:witten@torsion.org ).
2018-06-17 21:55:57 +00:00
### Contributing
2021-04-09 21:54:21 +00:00
borgmatic [source code is
2021-09-14 18:32:01 +00:00
available](https://projects.torsion.org/borgmatic-collective/borgmatic) and is also mirrored
2021-09-14 17:18:10 +00:00
on [GitHub ](https://github.com/borgmatic-collective/borgmatic ) for convenience.
2020-03-09 22:50:54 +00:00
borgmatic is licensed under the GNU General Public License version 3 or any
later version.
2019-11-14 17:34:53 +00:00
2018-06-17 21:55:57 +00:00
If you'd like to contribute to borgmatic development, please feel free to
2022-12-14 07:56:32 +00: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 ) to
discuss your idea. Note that you'll need to
[register ](https://projects.torsion.org/user/sign_up?invite_code=borgmatic )
2022-12-16 19:39:05 +00:00
first. We also accept Pull Requests on GitHub, if that's more your thing. In
general, contributions are very welcome. We don't bite!
2018-06-17 21:55:57 +00:00
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.
2024-07-06 17:15:16 +00:00
### Recent contributors
{% include borgmatic/contributors.html %}