Simple, configuration-driven backup software for servers and workstations (fork)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

150 lines
7.0 KiB

2 years ago
7 years ago
2 years ago
2 years ago
7 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
7 years ago
7 years ago
2 years ago
2 years ago
2 years ago
  1. ---
  2. title: borgmatic
  3. permalink: index.html
  4. ---
  5. ## It's your data. Keep it that way.
  6. <img src="docs/static/borgmatic.png" alt="borgmatic logo" width="150px" style="float: right; padding-left: 1em;">
  7. borgmatic is simple, configuration-driven backup software for servers and
  8. workstations. Protect your files with client-side encryption. Backup your
  9. databases too. Monitor it all with integrated third-party services.
  10. Here's an example configuration file:
  11. ```yaml
  12. location:
  13. # List of source directories to backup.
  14. source_directories:
  15. - /home
  16. - /etc
  17. # Paths of local or remote repositories to backup to.
  18. repositories:
  19. - 1234@usw-s001.rsync.net:backups.borg
  20. - k8pDxu32@k8pDxu32.repo.borgbase.com:repo
  21. - /var/lib/backups/local.borg
  22. retention:
  23. # Retention policy for how many backups to keep.
  24. keep_daily: 7
  25. keep_weekly: 4
  26. keep_monthly: 6
  27. consistency:
  28. # List of checks to run to validate your backups.
  29. checks:
  30. - repository
  31. - archives
  32. hooks:
  33. # Custom preparation scripts to run.
  34. before_backup:
  35. - prepare-for-backup.sh
  36. # Databases to dump and include in backups.
  37. postgresql_databases:
  38. - name: users
  39. # Third-party services to notify you if backups aren't happening.
  40. healthchecks: https://hc-ping.com/be067061-cf96-4412-8eae-62b0c50d6a8c
  41. ```
  42. Want to see borgmatic in action? Check out the <a
  43. href="https://asciinema.org/a/203761" target="_blank">screencast</a>.
  44. <script src="https://asciinema.org/a/203761.js" id="asciicast-203761" async></script>
  45. borgmatic is powered by [Borg Backup](https://www.borgbackup.org/).
  46. ## Integrations
  47. <a href="https://www.postgresql.org/"><img src="docs/static/postgresql.png" alt="PostgreSQL" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  48. <a href="https://www.mysql.com/"><img src="docs/static/mysql.png" alt="MySQL" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  49. <a href="https://mariadb.com/"><img src="docs/static/mariadb.png" alt="MariaDB" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  50. <a href="https://healthchecks.io/"><img src="docs/static/healthchecks.png" alt="Healthchecks" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  51. <a href="https://cronitor.io/"><img src="docs/static/cronitor.png" alt="Cronitor" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  52. <a href="https://cronhub.io/"><img src="docs/static/cronhub.png" alt="Cronhub" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  53. <a href="https://www.pagerduty.com/"><img src="docs/static/pagerduty.png" alt="PagerDuty" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  54. <a href="https://www.rsync.net/cgi-bin/borg.cgi?campaign=borg&adgroup=borgmatic"><img src="docs/static/rsyncnet.png" alt="rsync.net" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  55. <a href="https://www.borgbase.com/?utm_source=borgmatic"><img src="docs/static/borgbase.png" alt="BorgBase" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  56. ## How-to guides
  57. * [Set up backups with borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups/) ⬅ *Start here!*
  58. * [Make per-application backups](https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/)
  59. * [Deal with very large backups](https://torsion.org/borgmatic/docs/how-to/deal-with-very-large-backups/)
  60. * [Inspect your backups](https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/)
  61. * [Monitor your backups](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/)
  62. * [Extract a backup](https://torsion.org/borgmatic/docs/how-to/extract-a-backup/)
  63. * [Backup your databases](https://torsion.org/borgmatic/docs/how-to/backup-your-databases/)
  64. * [Add preparation and cleanup steps to backups](https://torsion.org/borgmatic/docs/how-to/add-preparation-and-cleanup-steps-to-backups/)
  65. * [Backup to a removable drive or an intermittent server](https://torsion.org/borgmatic/docs/how-to/backup-to-a-removable-drive-or-an-intermittent-server/)
  66. * [Upgrade borgmatic](https://torsion.org/borgmatic/docs/how-to/upgrade/)
  67. * [Develop on borgmatic](https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/)
  68. ## Reference guides
  69. * [borgmatic configuration reference](https://torsion.org/borgmatic/docs/reference/configuration/)
  70. * [borgmatic command-line reference](https://torsion.org/borgmatic/docs/reference/command-line/)
  71. ## Hosting providers
  72. Need somewhere to store your encrypted offsite backups? The following hosting
  73. providers include specific support for Borg/borgmatic. Using these links and
  74. services helps support borgmatic development and hosting. (These are referral
  75. links, but without any tracking scripts or cookies.)
  76. <ul>
  77. <li class="referral"><a href="https://www.rsync.net/cgi-bin/borg.cgi?campaign=borg&adgroup=borgmatic">rsync.net</a>: Cloud Storage provider with full support for borg and any other SSH/SFTP tool</li>
  78. <li class="referral"><a href="https://www.borgbase.com/?utm_source=borgmatic">BorgBase</a>: Borg hosting service with support for monitoring, 2FA, and append-only repos</li>
  79. </ul>
  80. ## Support and contributing
  81. ### Issues
  82. You've got issues? Or an idea for a feature enhancement? We've got an [issue
  83. tracker](https://projects.torsion.org/witten/borgmatic/issues). In order to
  84. create a new issue or comment on an issue, you'll need to [login
  85. first](https://projects.torsion.org/user/login). Note that you can login with
  86. an existing GitHub account if you prefer.
  87. If you'd like to chat with borgmatic developers or users, head on over to the
  88. `#borgmatic` IRC channel on Freenode, either via <a
  89. href="https://webchat.freenode.net/?channels=borgmatic">web chat</a> or a
  90. native <a href="irc://chat.freenode.net:6697">IRC client</a>.
  91. Also see the [security
  92. policy](https://torsion.org/borgmatic/docs/security-policy/) for any security
  93. issues.
  94. Other questions or comments? Contact
  95. [witten@torsion.org](mailto:witten@torsion.org).
  96. ### Contributing
  97. borgmatic is hosted at <https://torsion.org/borgmatic> with [source code
  98. available](https://projects.torsion.org/witten/borgmatic), and is also
  99. mirrored on [GitHub](https://github.com/witten/borgmatic) for convenience.
  100. borgmatic is licensed under the GNU General Public License version 3 or any
  101. later version.
  102. If you'd like to contribute to borgmatic development, please feel free to
  103. submit a [Pull Request](https://projects.torsion.org/witten/borgmatic/pulls)
  104. or open an [issue](https://projects.torsion.org/witten/borgmatic/issues) first
  105. to discuss your idea. We also accept Pull Requests on GitHub, if that's more
  106. your thing. In general, contributions are very welcome. We don't bite!
  107. Also, please check out the [borgmatic development
  108. how-to](https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/) for
  109. info on cloning source code, running tests, etc.
  110. <a href="https://build.torsion.org/witten/borgmatic" alt="build status">![Build Status](https://build.torsion.org/api/badges/witten/borgmatic/status.svg?ref=refs/heads/master)</a>