Simple, configuration-driven backup software for servers and workstations

Dan Helfman a527f76d08 Add back checkout now that NodeJS is installed on the host. 1 سال پیش
.gitea a527f76d08 Add back checkout now that NodeJS is installed on the host. 1 سال پیش
borgmatic 16bc0de3fb Support for NO_COLOR environment variable (#835). 1 سال پیش
docs 43c7c3b6be First attempt at using Gitea Actions to run tests. 1 سال پیش
sample 2f3c0bec5b Update systemd .service example 1 سال پیش
scripts 43c7c3b6be First attempt at using Gitea Actions to run tests. 1 سال پیش
tests 43c7c3b6be First attempt at using Gitea Actions to run tests. 1 سال پیش
.dockerignore cd91dbd4f7 Include sub-command help in documentation. 6 سال پیش
.drone.yml 06c2154e6a Build docs regardless of Drone "event" (push, etc.). 1 سال پیش
.eleventy.js 66d2f49f18 docs: copy to clipboard support 2 سال پیش
.flake8 5d19d86e4a Add flake8-quotes to complain about incorrect quoting so I don't have to! 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). 5 سال پیش
NEWS 2f6ad9d173 Add NO_COLOR support to NEWS (#835). 1 سال پیش
README.md 30523a7c89 Update home page example of Healthchecks configuration not to use deprecated config. 1 سال پیش
SECURITY.md 065be1d9d4 More inclusive language. 2 سال پیش
pyproject.toml 20b8b45aeb Remove all configuration from Tox file 6 سال پیش
setup.cfg 8cb5a42a9e Drop deprecated pkg_resources in favor of importlib.metadata and packaging. 2 سال پیش
setup.py 5586aab967 Clarify documentation about restoring a database: borgmatic does not create the database upon restore. 1 سال پیش
test_requirements.txt 009062128d Remove Python 3.8+ restriction, as only Python 3.8+ is supported. 1 سال پیش
tox.ini 715e2ac127 Add test support for Python 3.12. 1 سال پیش

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