5fad2bd408
On wide screens, the position of the documentation (how-to and reference guide) is at same level as #it's-your-data.-keep-it-that-way. So the jump due to anchor link makes it seem like we're taken to top aka main content. Indicate that links are to the left so reader doesn't recurse.
168 lines
7.1 KiB
Markdown
168 lines
7.1 KiB
Markdown
---
|
|
title: borgmatic
|
|
permalink: index.html
|
|
---
|
|
|
|
## It's your data. Keep it that way.
|
|
|
|
<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
|
|
workstations. Protect your files with client-side encryption. Backup your
|
|
databases too. Monitor it all with integrated third-party services.
|
|
|
|
The canonical home of borgmatic is at <a href="https://torsion.org/borgmatic">https://torsion.org/borgmatic</a>.
|
|
|
|
Here's an example configuration file:
|
|
|
|
```yaml
|
|
location:
|
|
# List of source directories to backup.
|
|
source_directories:
|
|
- /home
|
|
- /etc
|
|
|
|
# Paths of local or remote repositories to backup to.
|
|
repositories:
|
|
- ssh://1234@usw-s001.rsync.net/./backups.borg
|
|
- ssh://k8pDxu32@k8pDxu32.repo.borgbase.com/./repo
|
|
- /var/lib/backups/local.borg
|
|
|
|
retention:
|
|
# Retention policy for how many backups to keep.
|
|
keep_daily: 7
|
|
keep_weekly: 4
|
|
keep_monthly: 6
|
|
|
|
consistency:
|
|
# List of checks to run to validate your backups.
|
|
checks:
|
|
- name: repository
|
|
- name: archives
|
|
frequency: 2 weeks
|
|
|
|
hooks:
|
|
# 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.
|
|
healthchecks: https://hc-ping.com/be067061-cf96-4412-8eae-62b0c50d6a8c
|
|
```
|
|
|
|
Want to see borgmatic in action? Check out the <a
|
|
href="https://asciinema.org/a/203761?autoplay=1" target="_blank">screencast</a>.
|
|
|
|
<a href="https://asciinema.org/a/203761?autoplay=1" target="_blank"><img src="https://asciinema.org/a/203761.png" width="480"></a>
|
|
|
|
borgmatic is powered by [Borg Backup](https://www.borgbackup.org/).
|
|
|
|
## Integrations
|
|
|
|
<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://www.mongodb.com/"><img src="docs/static/mongodb.png" alt="MongoDB" height="60px" style="margin-bottom:20px;"></a>
|
|
<a href="https://sqlite.org/"><img src="docs/static/sqlite.png" alt="SQLite" 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>
|
|
<a href="https://www.pagerduty.com/"><img src="docs/static/pagerduty.png" alt="PagerDuty" height="60px" style="margin-bottom:20px;"></a>
|
|
<a href="https://ntfy.sh/"><img src="docs/static/ntfy.png" alt="ntfy" 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>
|
|
|
|
|
|
## 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 (left panel on wide screens)
|
|
for <a href="https://torsion.org/borgmatic/#documentation">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.)
|
|
|
|
<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>
|
|
</ul>
|
|
|
|
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.
|
|
|
|
## 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
|
|
tracker](https://projects.torsion.org/borgmatic-collective/borgmatic/issues).
|
|
In order to create a new issue or add a comment, you'll need to
|
|
[register](https://projects.torsion.org/user/sign_up?invite_code=borgmatic)
|
|
first. If you prefer to use an existing GitHub account, you can skip account
|
|
creation and [login directly](https://projects.torsion.org/user/login).
|
|
|
|
Also see the [security
|
|
policy](https://torsion.org/borgmatic/docs/security-policy/) for any security
|
|
issues.
|
|
|
|
|
|
### Social
|
|
|
|
Check out the [Borg subreddit](https://www.reddit.com/r/BorgBackup/) for
|
|
general Borg and borgmatic discussion and support.
|
|
|
|
Also follow [borgmatic on Mastodon](https://fosstodon.org/@borgmatic).
|
|
|
|
|
|
### Chat
|
|
|
|
To chat with borgmatic developers or users, check out the `#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 don't get a response
|
|
right away, please hang around a while—or file a ticket instead.
|
|
|
|
|
|
### Other
|
|
|
|
Other questions or comments? Contact
|
|
[witten@torsion.org](mailto:witten@torsion.org).
|
|
|
|
|
|
### Contributing
|
|
|
|
borgmatic [source code is
|
|
available](https://projects.torsion.org/borgmatic-collective/borgmatic) and is also mirrored
|
|
on [GitHub](https://github.com/borgmatic-collective/borgmatic) for convenience.
|
|
|
|
borgmatic is licensed under the GNU General Public License version 3 or any
|
|
later version.
|
|
|
|
If you'd like to contribute to borgmatic development, please feel free to
|
|
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)
|
|
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](https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/) for
|
|
info on cloning source code, running tests, etc.
|
|
|
|
<a href="https://build.torsion.org/borgmatic-collective/borgmatic" alt="build status"></a>
|
|
|