title: borgmatic permalink: index.html
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:
# 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.
Integrations
Data
Monitoring
Credentials
Getting started
Your first steps are to install and configure borgmatic.
For additional documentation, check out the links on the top/left for borgmatic how-to and reference guides.
Hosting providers
Need somewhere to store your encrypted off-site backups? The following hosting provider includes specific support for Borg/borgmatic—and funds borgmatic development and hosting when you use this referral links to sign up:
- BorgBase: Borg hosting service with support for monitoring, 2FA, and append-only repos
Additionally, Hetzner and rsync.net have compatible storage offerings, but do 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. In order to create a new issue or add a comment, you'll need to register 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 issues.
Social
Follow borgmatic on Mastodon.
Chat
To chat with borgmatic developers or users, check out the #borgmatic
IRC channel on Libera Chat, either via web chat 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.
Contributing
borgmatic source code is available and also has a read-only mirror on GitHub 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 or open an issue to discuss your idea. Note that you'll need to register first. 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.
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 %}
1 maintainer
Release files for borgmatic 2.1.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| borgmatic-2.1.8.tar.gz | 1.1 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| borgmatic-2.1.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.4 MB
Release files / borgmatic-2.1.8.tar.gz
| Download URL | borgmatic-2.1.8.tar.gz |
|---|---|
| Size | 1.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3e6b20948d77c31c211dd075a6fd6deb93777a80902de7090498b66cf47d8487
|
|
BLAKE2b-256 checksum How to use checksums |
9ebdd146400c656d2ed761af20233b87e44951ade59181935cb7540ff0338c64
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / borgmatic-2.1.8-py3-none-any.whl
| Download URL | borgmatic-2.1.8-py3-none-any.whl |
|---|---|
| Size | 282.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a0e8962d6cd237dd6ea23e0e80bcc888350e1bc5c5589925583a18fa811ce4b4
|
|
BLAKE2b-256 checksum How to use checksums |
98fa2747eca310607f41aa110a0e85bd61865c472c6364d22bdbff214b72ff43
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
