README 1.5 KB

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