README.rst 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. |build|
  2. What is Attic?
  3. --------------
  4. Attic is a deduplicating backup program. The main goal of Attic is to provide
  5. an efficient and secure way to backup data. The data deduplication
  6. technique used makes Attic suitable for daily backups since only changes
  7. are stored.
  8. Easy to use
  9. ~~~~~~~~~~~
  10. Initialize backup repository and create a backup archive::
  11. $ attic init /usbdrive/my-backup.attic
  12. $ attic create -v /usbdrive/my-backup.attic::documents ~/Documents
  13. Main features
  14. ~~~~~~~~~~~~~
  15. Space efficient storage
  16. Variable block size deduplication is used to reduce the number of bytes
  17. stored by detecting redundant data. Each file is split into a number of
  18. variable length chunks and only chunks that have never been seen before are
  19. compressed and added to the repository.
  20. Optional data encryption
  21. All data can be protected using 256-bit AES encryption and data integrity
  22. and authenticity is verified using a MAC (message authentication code).
  23. Off-site backups
  24. Attic can store data on any remote host accessible over SSH. This is
  25. most efficient if Attic is also installed on the remote host.
  26. Backups mountable as filesystems
  27. Backup archives are mountable as userspace filesystems for easy backup
  28. verification and restores.
  29. What do I need?
  30. ---------------
  31. Attic requires Python 3.2 or above to work.
  32. Attic also requires a sufficiently recent OpenSSL (>= 1.0.0).
  33. In order to mount archives as filesystems, llfuse is required.
  34. For other python requirements, please see setup.py install_requires.
  35. How do I install it?
  36. --------------------
  37. ::
  38. $ pip install Attic
  39. Where are the docs?
  40. -------------------
  41. Go to https://attic-backup.org/ 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 attic/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/attic/merge.svg
  49. :alt: Build Status
  50. :target: https://travis-ci.org/attic/merge