README.rst 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. What is darc?
  2. -------------
  3. Darc is a Deduplicating ARChiver written in Python. The main goal of darc is
  4. to provide an efficient and secure way to backup data. The data deduplication
  5. technique used makes darc suitable for daily backups since only actual changes
  6. are stored.
  7. Easy to use
  8. ~~~~~~~~~~~
  9. Initialze backup repository and create a backup archive::
  10. $ darc init /usbdrive/my-backup.darc
  11. $ darc create -v /usbdrive/my-backup.darc::documents ~/Documents
  12. Main features
  13. ~~~~~~~~~~~~~
  14. Space efficient storage
  15. Variable block size deduplication is used to reduce the number of bytes
  16. stored by detecting redundant data. Each file is split into a number of
  17. variable length chunks and only chunks that have never been seen before are
  18. compressed and added to the repository.
  19. Optional data encryption
  20. All data can be protected using 256-bit AES encryption and data integrity
  21. and authenticity is verified using HMAC-SHA256.
  22. Off-site backups
  23. darc can store data on any remote host accessible over SSH as long as
  24. darc is installed.
  25. What do I need?
  26. ---------------
  27. Darc requires Python 3.2 or above to work. Besides Python darc also requires
  28. msgpack-python and sufficiently recent OpenSSL (>= 1.0.0).
  29. How do I install it?
  30. --------------------
  31. ::
  32. $ python setup.py install
  33. Where are the docs?
  34. -------------------
  35. Go to https://pythonhosted.org/darc/ for a prebuilt version of the docs. You
  36. can also build them yourself form the docs folder.
  37. Where are the tests?
  38. --------------------
  39. The tests are in the darc/testsuite package. To run the test suite use the
  40. following command::
  41. $ python -m darc.testsuite.run
  42. Where can I get help?
  43. ---------------------
  44. Send questions, comments, patches, etc. to jonas@borgstrom.se. Issues and
  45. pull requests can also be created on https://github.com/jborg/darc