You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

168 lines
6.9 KiB

title: borgmatic
permalink: index.html
4 years ago
## It's your data. Keep it that way.
9 years ago
4 years ago
<img src="docs/static/borgmatic.png" alt="borgmatic logo" width="150px" style="float: right; padding-left: 1em;">
borgmatic is simple, configuration-driven backup software for servers and
4 years ago
workstations. Protect your files with client-side encryption. Backup your
databases too. Monitor it all with integrated third-party services.
9 years ago
The canonical home of borgmatic is at <a href=""></a>.
4 years ago
Here's an example configuration file:
4 years ago
# List of source directories to backup.
- /home
- /etc
# Paths of local or remote repositories to backup to.
- ssh://
- ssh://
- /var/lib/backups/local.borg
4 years ago
# Retention policy for how many backups to keep.
keep_daily: 7
keep_weekly: 4
keep_monthly: 6
4 years ago
# List of checks to run to validate your backups.
- name: repository
- name: archives
frequency: 2 weeks
4 years ago
# Custom preparation scripts to run.
4 years ago
# Databases to dump and include in backups.
- name: users
4 years ago
# Third-party services to notify you if backups aren't happening.
Want to see borgmatic in action? Check out the <a
href="" target="_blank">screencast</a>.
<a href="" target="_blank"><img src="" width="480"></a>
4 years ago
borgmatic is powered by [Borg Backup](
## Integrations
<a href=""><img src="docs/static/postgresql.png" alt="PostgreSQL" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<a href=""><img src="docs/static/mysql.png" alt="MySQL" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<a href=""><img src="docs/static/mariadb.png" alt="MariaDB" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<a href=""><img src="docs/static/mongodb.png" alt="MongoDB" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<a href=""><img src="docs/static/healthchecks.png" alt="Healthchecks" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<a href=""><img src="docs/static/cronitor.png" alt="Cronitor" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<a href=""><img src="docs/static/cronhub.png" alt="Cronhub" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<a href=""><img src="docs/static/pagerduty.png" alt="PagerDuty" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<a href=""><img src="docs/static/ntfy.png" alt="ntfy" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<a href=""><img src="docs/static/borgbase.png" alt="BorgBase" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
4 years ago
9 years ago
## Getting started
Your first step is to [install and configure
For additional documentation, check out the links above for <a
href="">borgmatic how-to and
reference guides</a>.
## Hosting providers
Need somewhere to store your encrypted off-site backups? The following hosting
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.)
<li class="referral"><a href="">BorgBase</a>: Borg hosting service with support for monitoring, 2FA, and append-only repos</li>
Additionally, []( and
[Hetzner]( have compatible storage
offerings, but do not currently fund borgmatic development or hosting.
## Support and contributing
### Issues
Are you experiencing an issue with borgmatic? Or do you have an idea for a
feature enhancement? Head on over to our [issue
In order to create a new issue or add a comment, you'll need to
first. If you prefer to use an existing GitHub account, you can skip account
creation and [login directly](
Also see the [security
policy]( for any security
### Social
Check out the [Borg subreddit]( for
general Borg and borgmatic discussion and support.
Also follow [borgmatic on Mastodon](
### Chat
To chat with borgmatic developers or users, check out the `#borgmatic`
IRC channel on Libera Chat, either via <a
href="">web chat</a> or a native <a
href="ircs://">IRC client</a>. If you don't get a response
right away, please hang around a while—or file a ticket instead.
### Other
Other questions or comments? Contact
### Contributing
borgmatic [source code is
available]( and is also mirrored
on [GitHub]( for convenience.
borgmatic is licensed under the GNU General Public License version 3 or any
later version.
4 years ago
If you'd like to contribute to borgmatic development, please feel free to
submit a [Pull
Request]( or
open an
[issue]( to
discuss your idea. Note that you'll need to
first. 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]( for
info on cloning source code, running tests, etc.
4 years ago
<a href="" alt="build status">![Build Status](</a>
4 years ago