Metadata-Version: 2.4
Name: borgmatic
Version: 2.1.6
Summary: Simple, configuration-driven backup software for servers and workstations
Author-email: Dan Helfman <witten@torsion.org>
License-Expression: GPL-3.0-or-later
Project-URL: Homepage, https://torsion.org/borgmatic
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: System Administrators
Classifier: Programming Language :: Python
Classifier: Topic :: Security :: Cryptography
Classifier: Topic :: System :: Archiving :: Backup
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: jsonschema
Requires-Dist: packaging
Requires-Dist: requests
Requires-Dist: ruamel.yaml>0.15.0
Provides-Extra: apprise
Requires-Dist: apprise; extra == "apprise"
Provides-Extra: browse
Requires-Dist: textual; extra == "browse"
Requires-Dist: binaryornot; extra == "browse"
Provides-Extra: browse-dev
Requires-Dist: textual-dev; extra == "browse-dev"
Dynamic: license-file

---
title: borgmatic
permalink: index.html
---
borgmatic logo

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 https://torsion.org/borgmatic/

Here's an example configuration file:

```yaml
# 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.
commands:
    - before: action
      when: [create]
      run: [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:
    ping_url: https://hc-ping.com/be067061-cf96-4412-8eae-62b0c50d6a8c
```

borgmatic is powered by [Borg Backup](https://www.borgbackup.org/).

## Integrations

### Data

### Monitoring

### Credentials

## Getting started

Your first steps are to
[install](https://torsion.org/borgmatic/how-to/install-borgmatic/) and
[configure borgmatic](https://torsion.org/borgmatic/how-to/set-up-backups/).

For additional documentation, check out the links on the top/left
for borgmatic how-to and
reference guides (https://torsion.org/borgmatic/#documentation).

## 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 referral links to sign up:

- BorgBase (https://www.borgbase.com/?utm_source=borgmatic): Borg hosting service with support for monitoring, 2FA, and append-only repos
 
- Hetzner (https://hetzner.cloud/?ref=v9dOJ98Ic9I8): A "storage box" that includes support for Borg

Additionally, rsync.net has a compatible storage offering, but does not 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/security-policy/) for any security
issues.

### Social

Follow borgmatic on
Mastodon (https://floss.social/@borgmatic).

### Chat

To chat with borgmatic developers or users, check out the `#borgmatic`
IRC channel on Libera Chat, either via web chat (https://web.libera.chat/#borgmatic) or a native IRC client. 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 also
has a read-only mirror 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. In general, contributions are very welcome. We don't bite!

Also, please check out the [borgmatic development
how-to](https://torsion.org/borgmatic/how-to/develop-on-borgmatic/) for
info on cloning source code, running tests, etc.

### Recent contributors

Thanks to all borgmatic contributors! There are multiple ways to contribute to
this project, so the following includes those who have fixed bugs, contributed
features, *or* filed tickets.

{% include borgmatic/contributors.html %}
