Simple, configuration-driven backup software for servers and workstations

Dan Helfman 1a33e5fa1e Bump version for release. пре 2 месеци
.gitea c3c37dee13 Only build and deploy docs on pushes to main, not for pull requests. пре 4 месеци
.github 11da378304 Update GitHub pull request template, because it also shows up on Gitea apparently. пре 2 месеци
borgmatic 1b62be0949 Fix a bug in which quoted "extra_borg_options" values containing spaces are passed to Borg incorrectly. Add a "--comment" flag to the "create" action for creating an archive with a comment (#1108). пре 2 месеци
docs c2d2ce18a2 Clarify documentation about interacion between "--repository" flag and command hooks (#1112). пре 2 месеци
sample 295bfb0c57 Update the logic that probes for the borgmatic streaming database dump, bootstrap metadata, and check state directories to support more platforms and use cases (#934). пре 9 месеци
scripts 2f535056ee Removing asterisk escaping from release script, which apparently breaks Gitea changelog posting. пре 4 месеци
tests 1b62be0949 Fix a bug in which quoted "extra_borg_options" values containing spaces are passed to Borg incorrectly. Add a "--comment" flag to the "create" action for creating an archive with a comment (#1108). пре 2 месеци
.bandit 392fbcd19f Add missing Bandit configuration file. пре 2 месеци
.dockerignore cd91dbd4f7 Include sub-command help in documentation. пре 6 година
.eleventy.js 66d2f49f18 docs: copy to clipboard support пре 2 година
.gitignore cf8882f2bc Run arbitrary Borg commands with new "borgmatic borg" action (#425). пре 4 година
AUTHORS 6cdc92bd0c Fix for "borgmatic restore" showing success and incorrectly extracting archive files, even when no databases are configured to restore (#246). пре 5 година
LICENSE 7b3efddcbd Adding GPL v3 license. пре 10 година
MANIFEST.in 07222cd984 Fix visibility of "borgmatic prune --stats" output (#219). пре 6 година
NEWS 1a33e5fa1e Bump version for release. пре 2 месеци
README.md 5ac086fa73 Revert "Temporarily remove recent contributors due to broken Gitea API: https://github.com/go-gitea/gitea/issues/34682" пре 2 месеци
SECURITY.md 065be1d9d4 More inclusive language. пре 2 година
pyproject.toml 1a33e5fa1e Bump version for release. пре 2 месеци
test_requirements.txt 0d54fda27a Use the Bandit security analysis tool when running tests. пре 2 месеци
tox.ini 5a2cd1b261 Add support for Python 3.13. пре 6 месеци

README.md


title: borgmatic

permalink: index.html

It's your data. Keep it that way.

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:

# 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

PostgreSQL MySQL MariaDB MongoDB SQLite OpenZFS Btrfs LVM rclone BorgBase

Monitoring

Healthchecks Uptime Kuma Cronitor Cronhub PagerDuty Pushover ntfy Loki Apprise Zabbix Sentry

Credentials

Sentry Docker Podman Podman

Getting started

Your first step is to install and configure borgmatic.

For additional documentation, check out the links above (left panel on wide screens) for borgmatic how-to and reference guides.

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: 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 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 %}