Simple, configuration-driven backup software for servers and workstations https://torsion.org/borgmatic/
 
 
Go to file
Dan Helfman af422ad705
continuous-integration/drone/push Build was killed Details
Add documentation note about upgrading multiple pipx installations of borgmatic.
2023-09-18 13:46:41 -07:00
.gitea/issue_template Attempt to unbreak ticket filing. 2023-09-12 09:50:38 -07:00
borgmatic Add documentation note about upgrading multiple pipx installations of borgmatic. 2023-09-18 13:46:41 -07:00
docs Add documentation note about upgrading multiple pipx installations of borgmatic. 2023-09-18 13:46:41 -07:00
sample Add sample systemd user serivce for running borgmatic as a non-root user (#669). 2023-06-14 14:57:57 -07:00
scripts Fix for database "restore" action not actually restore anything (#738). 2023-08-14 12:43:21 -07:00
tests Fix error handling to log command output as one record per line (#754). 2023-09-14 21:10:52 -07:00
.dockerignore Include sub-command help in documentation. 2019-06-22 22:04:56 -07:00
.drone.yml Fix for database "restore" action not actually restore anything (#738). 2023-08-14 12:43:21 -07:00
.eleventy.js docs: copy to clipboard support 2023-03-23 14:45:23 +05:30
.flake8 Add flake8-quotes to complain about incorrect quoting so I don't have to! 2023-03-07 14:08:35 -08:00
.gitignore Run arbitrary Borg commands with new "borgmatic borg" action (#425). 2021-06-17 20:41:44 -07:00
AUTHORS Fix for "borgmatic restore" showing success and incorrectly extracting archive files, even when no databases are configured to restore (#246). 2019-11-13 10:41:57 -08:00
LICENSE Adding GPL v3 license. 2014-11-18 18:22:51 -08:00
MANIFEST.in Fix visibility of "borgmatic prune --stats" output (#219). 2019-09-23 13:07:51 -07:00
NEWS Fix tense typo. 2023-09-17 23:25:57 -07:00
README.md Update documentation for section removal (#721). 2023-07-11 19:42:14 -07:00
SECURITY.md More inclusive language. 2023-04-20 14:28:04 -07:00
pyproject.toml Remove all configuration from Tox file 2019-05-14 13:17:15 +02:00
setup.cfg Drop deprecated pkg_resources in favor of importlib.metadata and packaging. 2023-04-14 21:21:25 -07:00
setup.py Add borgmatic version introducing Loki hook to docs (#743). 2023-08-27 20:30:13 -07:00
test_requirements.txt Upgrade requests test requirement (security). 2023-05-23 08:43:45 -07:00
tox.ini 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 2023-04-14 23:22:07 -07:00

README.md

title permalink
borgmatic 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: 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      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