Repository files navigation

borgmatic is simple, configuration-driven backup software for servers andworkstations. Protect your files with client-side encryption. Backup yourdatabases too. Monitor it all with integrated third-party services.

The canonical home of borgmatic is athttps://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/./repolabel:borgbase    -path:/var/lib/backups/local.borglabel:local# Retention policy for how many backups to keep.keep_daily:7keep_weekly:4keep_monthly:6# List of checks to run to validate your backups.checks:    -name:repository    -name:archivesfrequency:2 weeks# Custom preparation scripts to run.commands:    -before:actionwhen:[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 byBorg Backup.

Your first step is toinstall and configureborgmatic.

For additional documentation, check out the links above (left panel on wide screens)forborgmatic how-to andreference guides.

Need somewhere to store your encrypted off-site backups? The following hostingproviders include specific support for Borg/borgmatic—and fund borgmaticdevelopment and hosting when you use these referral links to sign up:

• BorgBase: Borg hosting service with support for monitoring, 2FA, and append-only repos
• Hetzner: A "storage box" that includes support for Borg

Additionally, rsync.net has a compatible storage offering, but does not fundborgmatic development or hosting.

Are you experiencing an issue with borgmatic? Or do you have an idea for afeature enhancement? Head on over to ourissuetracker.In order to create a new issue or add a comment, you'll need toregisterfirst. If you prefer to use an existing GitHub account, you can skip accountcreation andlogin directly.

Also see thesecuritypolicy for any securityissues.

Followborgmatic onMastodon.

To chat with borgmatic developers or users, check out the#borgmaticIRC channel on Libera Chat, either viaweb chat or a native IRC client. If you don't get a responseright away, please hang around a while—or file a ticket instead.

Other questions or comments? Contactwitten@torsion.org.

borgmaticsource code isavailable and alsohas a read-only mirror onGitHub for convenience.

borgmatic is licensed under the GNU General Public License version 3 or anylater version.

If you'd like to contribute to borgmatic development, please feel free to submitapullrequest oropen anissue todiscuss your idea. Note that you'll need toregisterfirst. In general, contributions are very welcome. We don't bite!

Also, please check out theborgmatic developmenthow-to forinfo on cloning source code, running tests, etc.

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

{% include borgmatic/contributors.html %}