README.rst 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. |build|
  2. What is Borg?
  3. -------------
  4. Borg is a deduplicating backup program. The main goal of Borg is to provide
  5. an efficient and secure way to backup data. The data deduplication
  6. technique used makes Borg suitable for daily backups since only changes
  7. are stored.
  8. Borg is a fork of Attic and maintained by "The Borg Collective" (see AUTHORS file).
  9. Easy to use
  10. ~~~~~~~~~~~
  11. Initialize backup repository and create a backup archive::
  12. $ borg init /usbdrive/my-backup.borg
  13. $ borg create -v /usbdrive/my-backup.borg::documents ~/Documents
  14. Main features
  15. ~~~~~~~~~~~~~
  16. Space efficient storage
  17. Variable block size deduplication is used to reduce the number of bytes
  18. stored by detecting redundant data. Each file is split into a number of
  19. variable length chunks and only chunks that have never been seen before are
  20. compressed and added to the repository.
  21. Optional data encryption
  22. All data can be protected using 256-bit AES encryption and data integrity
  23. and authenticity is verified using HMAC-SHA256.
  24. Off-site backups
  25. Borg can store data on any remote host accessible over SSH. This is
  26. most efficient if Borg is also installed on the remote host.
  27. Backups mountable as filesystems
  28. Backup archives are mountable as userspace filesystems for easy backup
  29. verification and restores.
  30. What do I need?
  31. ---------------
  32. Borg requires Python 3.2 or above to work.
  33. Borg also requires a sufficiently recent OpenSSL (>= 1.0.0).
  34. In order to mount archives as filesystems, llfuse is required.
  35. How do I install it?
  36. --------------------
  37. ::
  38. $ pip3 install borgbackup
  39. Where are the docs?
  40. -------------------
  41. Go to https://borgbackup.github.io/ for a prebuilt version of the documentation.
  42. You can also build it yourself from the docs folder.
  43. Where are the tests?
  44. --------------------
  45. The tests are in the borg/testsuite package. To run the test suite use the
  46. following command::
  47. $ fakeroot -u tox # you need to have tox installed
  48. .. |build| image:: https://travis-ci.org/borgbackup/borg.svg
  49. :alt: Build Status
  50. :target: https://travis-ci.org/borgbackup/borg