Simple, configuration-driven backup software for servers and workstations

Dan Helfman 30523a7c89 Update home page example of Healthchecks configuration not to use deprecated config. há 1 ano atrás
.gitea bac2aabe66 Attempt to unbreak ticket filing. há 1 ano atrás
borgmatic 77b1907d03 Update Healthchecks deprecation warning message for clarity. há 1 ano atrás
docs 09594c85bf Be more explicit in documentation that you don't have to use an environment variable for passphrases. há 1 ano atrás
sample 1d7c7eaaa7 Add sample systemd user serivce for running borgmatic as a non-root user (#669). há 2 anos atrás
scripts 5f06884d5a Fix Apprise/PyYAML end-to-end test breakage (#715). há 1 ano atrás
tests c687dafdd2 Fix a traceback when an invalid command-line flag or action is used (#768). há 1 ano atrás
.dockerignore cd91dbd4f7 Include sub-command help in documentation. há 6 anos atrás
.drone.yml 06c2154e6a Build docs regardless of Drone "event" (push, etc.). há 1 ano atrás
.eleventy.js 66d2f49f18 docs: copy to clipboard support há 2 anos atrás
.flake8 5d19d86e4a Add flake8-quotes to complain about incorrect quoting so I don't have to! há 2 anos atrás
.gitignore cf8882f2bc Run arbitrary Borg commands with new "borgmatic borg" action (#425). há 4 anos atrás
AUTHORS 6cdc92bd0c Fix for "borgmatic restore" showing success and incorrectly extracting archive files, even when no databases are configured to restore (#246). há 5 anos atrás
LICENSE 7b3efddcbd Adding GPL v3 license. há 10 anos atrás
MANIFEST.in 07222cd984 Fix visibility of "borgmatic prune --stats" output (#219). há 5 anos atrás
NEWS c687dafdd2 Fix a traceback when an invalid command-line flag or action is used (#768). há 1 ano atrás
README.md 30523a7c89 Update home page example of Healthchecks configuration not to use deprecated config. há 1 ano atrás
SECURITY.md 065be1d9d4 More inclusive language. há 2 anos atrás
pyproject.toml 20b8b45aeb Remove all configuration from Tox file há 6 anos atrás
setup.cfg 8cb5a42a9e Drop deprecated pkg_resources in favor of importlib.metadata and packaging. há 2 anos atrás
setup.py f011431463 Apprise hook documentation (#715). há 1 ano atrás
test_requirements.txt e7169f6fb2 Upgrade certifi test dependency to fix security alert. há 1 ano atrás
tox.ini 7ee37a890e Fix broken end-to-end tests by no longer using an editable package there, a work-around for https://github.com/pypa/packaging-problems/issues/609 há 2 anos atrás

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.
before_backup:
    - 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

PostgreSQL MySQL MariaDB MongoDB SQLite Healthchecks Cronitor Cronhub PagerDuty ntfy Loki Apprise BorgBase

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 is also mirrored 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. We also accept Pull Requests on GitHub, if that's more your thing. 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.

Build Status