Skip to main content

Simple, configuration-driven backup software for servers and workstations

Project description


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

Project details


Release history Release notifications | RSS feed

This version

2.0.7

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

borgmatic-2.0.7.tar.gz (684.5 kB view details)

Uploaded Source

Built Distribution

borgmatic-2.0.7-py3-none-any.whl (229.3 kB view details)

Uploaded Python 3

File details

Details for the file borgmatic-2.0.7.tar.gz.

File metadata

  • Download URL: borgmatic-2.0.7.tar.gz
  • Upload date:
  • Size: 684.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for borgmatic-2.0.7.tar.gz
Algorithm Hash digest
SHA256 1ee9ca5d5b83193747f82cc841bb64374a11328710ee0561e8c7fa2fbc258406
MD5 efb64f6473cb88444477d48b1d225ebd
BLAKE2b-256 145adb4f743b29fe9b7446c06575a0f5c26b55b6ca7aa04eaf905bd3dfc3fad4

See more details on using hashes here.

File details

Details for the file borgmatic-2.0.7-py3-none-any.whl.

File metadata

  • Download URL: borgmatic-2.0.7-py3-none-any.whl
  • Upload date:
  • Size: 229.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for borgmatic-2.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 ec9615ce7887713949a849df79931d9c4a89cc7d74f0b6b8d70d64e44152633a
MD5 83edd9f54fc490d400e5074b15bdf1d5
BLAKE2b-256 0ad2812146b18ed35eea02516ef2be8c4558ec5ca16942029b13720523208b3d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page