Simple, configuration-driven backup software for servers and workstations
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.

141 lines
6.2 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
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. - user1@scp2.cdn.lima-labs.com:repo
  22. - /var/lib/backups/local.borg
  23. retention:
  24. # Retention policy for how many backups to keep.
  25. keep_daily: 7
  26. keep_weekly: 4
  27. keep_monthly: 6
  28. consistency:
  29. # List of checks to run to validate your backups.
  30. checks:
  31. - repository
  32. - archives
  33. hooks:
  34. # Custom preparation scripts to run.
  35. before_backup:
  36. - prepare-for-backup.sh
  37. # Databases to dump and include in backups.
  38. postgresql_databases:
  39. - name: users
  40. # Third-party services to notify you if backups aren't happening.
  41. healthchecks: https://hc-ping.com/be067061-cf96-4412-8eae-62b0c50d6a8c
  42. ```
  43. Want to see borgmatic in action? Check out the <a
  44. href="https://asciinema.org/a/203761" target="_blank">screencast</a>.
  45. <script src="https://asciinema.org/a/203761.js" id="asciicast-203761" async></script>
  46. borgmatic is powered by [Borg Backup](https://www.borgbackup.org/).
  47. ## Integrations
  48. <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;
  49. <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;
  50. <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;
  51. <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;
  52. <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;
  53. <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;
  54. <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;
  55. <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;
  56. <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;
  57. ## Getting started
  58. Your first step is to [install and configure
  59. borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups/).
  60. For additional documentation, check out the links above for <a
  61. href="https://torsion.org/borgmatic/#documentation">borgmatic how-to and
  62. reference guides</a>.
  63. ## Hosting providers
  64. Need somewhere to store your encrypted offsite backups? The following hosting
  65. providers include specific support for Borg/borgmatic. Using these links and
  66. services helps support borgmatic development and hosting. (These are referral
  67. links, but without any tracking scripts or cookies.)
  68. <ul>
  69. <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>
  70. <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>
  71. <li class="referral"><a href="https://storage.lima-labs.com/special-pricing-offer-for-borgmatic-users/">Lima-Labs</a>: Affordable, reliable cloud data storage accessable via SSH/SCP/FTP for Borg backups or any other bulk storage needs</li>
  72. </ul>
  73. ## Support and contributing
  74. ### Issues
  75. You've got issues? Or an idea for a feature enhancement? We've got an [issue
  76. tracker](https://projects.torsion.org/witten/borgmatic/issues). In order to
  77. create a new issue or comment on an issue, you'll need to [login
  78. first](https://projects.torsion.org/user/login). Note that you can login with
  79. an existing GitHub account if you prefer.
  80. If you'd like to chat with borgmatic developers or users, head on over to the
  81. `#borgmatic` IRC channel on Freenode, either via <a
  82. href="https://webchat.freenode.net/?channels=borgmatic">web chat</a> or a
  83. native <a href="irc://chat.freenode.net:6697">IRC client</a>.
  84. Also see the [security
  85. policy](https://torsion.org/borgmatic/docs/security-policy/) for any security
  86. issues.
  87. Other questions or comments? Contact
  88. [witten@torsion.org](mailto:witten@torsion.org).
  89. ### Contributing
  90. borgmatic is hosted at <https://torsion.org/borgmatic> with [source code
  91. available](https://projects.torsion.org/witten/borgmatic), and is also
  92. mirrored on [GitHub](https://github.com/witten/borgmatic) for convenience.
  93. borgmatic is licensed under the GNU General Public License version 3 or any
  94. later version.
  95. If you'd like to contribute to borgmatic development, please feel free to
  96. submit a [Pull Request](https://projects.torsion.org/witten/borgmatic/pulls)
  97. or open an [issue](https://projects.torsion.org/witten/borgmatic/issues) first
  98. to discuss your idea. We also accept Pull Requests on GitHub, if that's more
  99. your thing. In general, contributions are very welcome. We don't bite!
  100. Also, please check out the [borgmatic development
  101. how-to](https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/) for
  102. info on cloning source code, running tests, etc.
  103. <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>