{"id":27838181,"url":"https://github.com/witten/borgmatic","last_synced_at":"2025-05-02T23:01:57.484Z","repository":{"id":23475639,"uuid":"26840434","full_name":"borgmatic-collective/borgmatic","owner":"borgmatic-collective","description":"Simple, configuration-driven backup software for servers and workstations","archived":false,"fork":false,"pushed_at":"2025-05-02T01:46:48.000Z","size":4938,"stargazers_count":1952,"open_issues_count":1,"forks_count":103,"subscribers_count":28,"default_branch":"main","last_synced_at":"2025-05-02T02:40:01.029Z","etag":null,"topics":["apprise","backup","borg","borgbackup","btrfs","deduplication","healthchecks","loki","lvm","mariadb","mongodb","mysql","ntfy","postgresql","python","servers","sqlite","upitme-kuma","zabbix","zfs"],"latest_commit_sha":null,"homepage":"https://torsion.org/borgmatic/","language":"Python","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/borgmatic-collective.png","metadata":{"files":{"readme":"README.md","changelog":"NEWS","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2014-11-19T02:24:38.000Z","updated_at":"2025-05-02T01:46:51.000Z","dependencies_parsed_at":"2023-10-05T04:53:46.503Z","dependency_job_id":"ad3c6da8-6f12-4c36-820c-0185f6e69e1d","html_url":"https://github.com/borgmatic-collective/borgmatic","commit_stats":{"total_commits":2123,"total_committers":94,"mean_commits":"22.585106382978722","dds":"0.22421102213848332","last_synced_commit":"fd4f69f6c3d1a7b37536c23cb0368313e1d683ad"},"previous_names":["witten/borgmatic"],"tags_count":187,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borgmatic-collective%2Fborgmatic","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borgmatic-collective%2Fborgmatic/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borgmatic-collective%2Fborgmatic/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borgmatic-collective%2Fborgmatic/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/borgmatic-collective","download_url":"https://codeload.github.com/borgmatic-collective/borgmatic/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252118316,"owners_count":21697583,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apprise","backup","borg","borgbackup","btrfs","deduplication","healthchecks","loki","lvm","mariadb","mongodb","mysql","ntfy","postgresql","python","servers","sqlite","upitme-kuma","zabbix","zfs"],"created_at":"2025-05-02T23:01:55.632Z","updated_at":"2025-05-02T23:01:57.468Z","avatar_url":"https://github.com/borgmatic-collective.png","language":"Python","readme":"---\ntitle: borgmatic\npermalink: index.html\n---\n\n## It's your data. Keep it that way.\n\n\u003cimg src=\"docs/static/borgmatic.png\" alt=\"borgmatic logo\" width=\"150px\" style=\"float: right; padding-left: 1em;\"\u003e\n\nborgmatic is simple, configuration-driven backup software for servers and\nworkstations. Protect your files with client-side encryption. Backup your\ndatabases too. Monitor it all with integrated third-party services.\n\nThe canonical home of borgmatic is at \u003ca href=\"https://torsion.org/borgmatic\"\u003ehttps://torsion.org/borgmatic/\u003c/a\u003e\n\nHere's an example configuration file:\n\n```yaml\n# List of source directories to backup.\nsource_directories:\n    - /home\n    - /etc\n\n# Paths of local or remote repositories to backup to.\nrepositories:\n    - path: ssh://k8pDxu32@k8pDxu32.repo.borgbase.com/./repo\n      label: borgbase\n    - path: /var/lib/backups/local.borg\n      label: local\n\n# Retention policy for how many backups to keep.\nkeep_daily: 7\nkeep_weekly: 4\nkeep_monthly: 6\n\n# List of checks to run to validate your backups.\nchecks:\n    - name: repository\n    - name: archives\n      frequency: 2 weeks\n\n# Custom preparation scripts to run.\ncommands:\n    - before: action\n      when: [create]\n      run: [prepare-for-backup.sh]\n\n# Databases to dump and include in backups.\npostgresql_databases:\n    - name: users\n\n# Third-party services to notify you if backups aren't happening.\nhealthchecks:\n    ping_url: https://hc-ping.com/be067061-cf96-4412-8eae-62b0c50d6a8c\n```\n\nborgmatic is powered by [Borg Backup](https://www.borgbackup.org/).\n\n## Integrations\n\n### Data\n\n\u003ca href=\"https://www.postgresql.org/\"\u003e\u003cimg src=\"docs/static/postgresql.png\" alt=\"PostgreSQL\" height=\"60px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.mysql.com/\"\u003e\u003cimg src=\"docs/static/mysql.png\" alt=\"MySQL\" height=\"60px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://mariadb.com/\"\u003e\u003cimg src=\"docs/static/mariadb.png\" alt=\"MariaDB\" height=\"60px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.mongodb.com/\"\u003e\u003cimg src=\"docs/static/mongodb.png\" alt=\"MongoDB\" height=\"60px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://sqlite.org/\"\u003e\u003cimg src=\"docs/static/sqlite.png\" alt=\"SQLite\" height=\"60px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://openzfs.org/\"\u003e\u003cimg src=\"docs/static/openzfs.png\" alt=\"OpenZFS\" height=\"60px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://btrfs.readthedocs.io/\"\u003e\u003cimg src=\"docs/static/btrfs.png\" alt=\"Btrfs\" height=\"60px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://sourceware.org/lvm2/\"\u003e\u003cimg src=\"docs/static/lvm.png\" alt=\"LVM\" height=\"60px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://rclone.org\"\u003e\u003cimg src=\"docs/static/rclone.png\" alt=\"rclone\" height=\"60px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.borgbase.com/?utm_source=borgmatic\"\u003e\u003cimg src=\"docs/static/borgbase.png\" alt=\"BorgBase\" height=\"60px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\n\n### Monitoring\n\n\u003ca href=\"https://healthchecks.io/\"\u003e\u003cimg src=\"docs/static/healthchecks.png\" alt=\"Healthchecks\" height=\"60px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://uptime.kuma.pet/\"\u003e\u003cimg src=\"docs/static/uptimekuma.png\" alt=\"Uptime Kuma\" height=\"60px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://cronitor.io/\"\u003e\u003cimg src=\"docs/static/cronitor.png\" alt=\"Cronitor\" height=\"60px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://cronhub.io/\"\u003e\u003cimg src=\"docs/static/cronhub.png\" alt=\"Cronhub\" height=\"60px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.pagerduty.com/\"\u003e\u003cimg src=\"docs/static/pagerduty.png\" alt=\"PagerDuty\" height=\"60px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.pushover.net/\"\u003e\u003cimg src=\"docs/static/pushover.png\" alt=\"Pushover\" height=\"60px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://ntfy.sh/\"\u003e\u003cimg src=\"docs/static/ntfy.png\" alt=\"ntfy\" height=\"60px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://grafana.com/oss/loki/\"\u003e\u003cimg src=\"docs/static/loki.png\" alt=\"Loki\" height=\"60px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/caronc/apprise/wiki\"\u003e\u003cimg src=\"docs/static/apprise.png\" alt=\"Apprise\" height=\"60px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.zabbix.com/\"\u003e\u003cimg src=\"docs/static/zabbix.png\" alt=\"Zabbix\" height=\"40px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://sentry.io/\"\u003e\u003cimg src=\"docs/static/sentry.png\" alt=\"Sentry\" height=\"40px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\n\n### Credentials\n\n\u003ca href=\"https://systemd.io/\"\u003e\u003cimg src=\"docs/static/systemd.png\" alt=\"Sentry\" height=\"40px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.docker.com/\"\u003e\u003cimg src=\"docs/static/docker.png\" alt=\"Docker\" height=\"40px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://podman.io/\"\u003e\u003cimg src=\"docs/static/podman.png\" alt=\"Podman\" height=\"40px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://keepassxc.org/\"\u003e\u003cimg src=\"docs/static/keepassxc.png\" alt=\"Podman\" height=\"40px\" style=\"margin-bottom:20px; margin-right:20px;\"\u003e\u003c/a\u003e\n\n\n## Getting started\n\nYour first step is to [install and configure\nborgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups/).\n\nFor additional documentation, check out the links above (left panel on wide screens)\nfor \u003ca href=\"https://torsion.org/borgmatic/#documentation\"\u003eborgmatic how-to and\nreference guides\u003c/a\u003e.\n\n\n## Hosting providers\n\nNeed somewhere to store your encrypted off-site backups? The following hosting\nproviders include specific support for Borg/borgmatic—and fund borgmatic\ndevelopment and hosting when you use these referral links to sign up:\n\n\u003cul\u003e\n \u003cli class=\"referral\"\u003e\u003ca href=\"https://www.borgbase.com/?utm_source=borgmatic\"\u003eBorgBase\u003c/a\u003e: Borg hosting service with support for monitoring, 2FA, and append-only repos\u003c/li\u003e\n \u003cli class=\"referral\"\u003e\u003ca href=\"https://hetzner.cloud/?ref=v9dOJ98Ic9I8\"\u003eHetzner\u003c/a\u003e: A \"storage box\" that includes support for Borg\u003c/li\u003e\n\u003c/ul\u003e\n\nAdditionally, rsync.net has a compatible storage offering, but does not fund\nborgmatic development or hosting.\n\n## Support and contributing\n\n### Issues\n\nAre you experiencing an issue with borgmatic? Or do you have an idea for a\nfeature enhancement? Head on over to our [issue\ntracker](https://projects.torsion.org/borgmatic-collective/borgmatic/issues).\nIn order to create a new issue or add a comment, you'll need to\n[register](https://projects.torsion.org/user/sign_up?invite_code=borgmatic)\nfirst. If you prefer to use an existing GitHub account, you can skip account\ncreation and [login directly](https://projects.torsion.org/user/login).\n\nAlso see the [security\npolicy](https://torsion.org/borgmatic/docs/security-policy/) for any security\nissues.\n\n\n### Social\n\nFollow \u003ca rel=\"me\" href=\"https://floss.social/@borgmatic\"\u003eborgmatic on\nMastodon\u003c/a\u003e.\n\n\n### Chat\n\nTo chat with borgmatic developers or users, check out the `#borgmatic`\nIRC channel on Libera Chat, either via \u003ca\nhref=\"https://web.libera.chat/#borgmatic\"\u003eweb chat\u003c/a\u003e or a native \u003ca\nhref=\"ircs://irc.libera.chat:6697\"\u003eIRC client\u003c/a\u003e. If you don't get a response\nright away, please hang around a while—or file a ticket instead.\n\n\n### Other\n\nOther questions or comments? Contact\n[witten@torsion.org](mailto:witten@torsion.org).\n\n\n### Contributing\n\nborgmatic [source code is\navailable](https://projects.torsion.org/borgmatic-collective/borgmatic) and also\nhas a read-only mirror on\n[GitHub](https://github.com/borgmatic-collective/borgmatic) for convenience.\n\nborgmatic is licensed under the GNU General Public License version 3 or any\nlater version.\n\nIf you'd like to contribute to borgmatic development, please feel free to submit\na [pull\nrequest](https://projects.torsion.org/borgmatic-collective/borgmatic/pulls) or\nopen an\n[issue](https://projects.torsion.org/borgmatic-collective/borgmatic/issues) to\ndiscuss your idea. Note that you'll need to\n[register](https://projects.torsion.org/user/sign_up?invite_code=borgmatic)\nfirst. In general, contributions are very welcome. We don't bite!\n\nAlso, please check out the [borgmatic development\nhow-to](https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/) for\ninfo on cloning source code, running tests, etc.\n\n### Recent contributors\n\nThanks to all borgmatic contributors! There are multiple ways to contribute to\nthis project, so the following includes those who have fixed bugs, contributed\nfeatures, *or* filed tickets.\n\n{% include borgmatic/contributors.html %}\n","funding_links":[],"categories":["Python","Backup","Python (1887)"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwitten%2Fborgmatic","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwitten%2Fborgmatic","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwitten%2Fborgmatic/lists"}