index.rst 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. .. include:: global.rst.inc
  2. Darc
  3. ====
  4. |project_name| is a Deduplicating ARChiver written in Python.
  5. The main goal of |project_name| is to provide an efficient and secure way
  6. to backup data. The data deduplication technique used makes |project_name|
  7. suitable for taking daily backups.
  8. Main Features
  9. -------------
  10. Space efficient storage
  11. Variable block size `deduplication`_ is used to reduce the number of bytes
  12. stored by detecting redundant data. Each file is split into a number of
  13. variable length chunks and only chunks that have never been seen before
  14. are compressed and added to the repository.
  15. Optional data encryption
  16. All data can be protected using 256-bit AES_ encryption and data integrity
  17. and authenticity is verified using `HMAC-SHA256`_.
  18. Off-site backups
  19. |project_name| can store data on any remote host accessible over SSH as
  20. long as |project_name| is installed.
  21. Easy to use
  22. -----------
  23. Initialize a new backup :ref:`repository <repository_def>` and create your
  24. first backup :ref:`archive <archive_def>` in two lines::
  25. $ darc init /usbdrive/my-backup.darc
  26. $ darc create -v /usbdrive/my-backup.darc::documents ~/Documents
  27. See the :ref:`generalusage` section for more detailed examples.
  28. Easy installation
  29. -----------------
  30. You can use pip to install |project_name| quickly and easily::
  31. $ pip install darc
  32. Need more help with installing? See :ref:`installation`
  33. User's Guide
  34. ============
  35. .. toctree::
  36. :maxdepth: 2
  37. installation
  38. generalusage
  39. faq
  40. definitions
  41. Contribute
  42. ==========
  43. Found a bug? Have any ideas to improve |project_name|?
  44. Head over to |project_name|'s github_ page and create an issue or a pull
  45. request.
  46. You can also ask the author a question directly by
  47. `email <mailto:jonas@borgstrom.se>`_.