foreword.rst 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. .. include:: global.rst.inc
  2. .. _foreword:
  3. Foreword
  4. ========
  5. |project_name| is a secure backup program for Linux, FreeBSD and Mac OS X.
  6. |project_name| is designed for efficient data storage where only new or
  7. modified data is stored.
  8. 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 added to the repository (and optionally compressed).
  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. If you don't have |project_name|
  21. installed there, you can use some network filesytem (sshfs, nfs, ...)
  22. to mount a filesystem located on your remote host and use it like it was
  23. local (but that will be slower).
  24. Backups mountable as filesystems
  25. Backup archives are :ref:`mountable <borg_mount>` as
  26. `userspace filesystems`_ for easy backup verification and restores.
  27. Glossary
  28. --------
  29. .. _deduplication_def:
  30. Deduplication
  31. Deduplication is a technique for improving storage utilization by
  32. eliminating redundant data.
  33. .. _archive_def:
  34. Archive
  35. An archive is a collection of files along with metadata that include file
  36. permissions, directory structure and various file attributes.
  37. Since each archive in a repository must have a unique name a good naming
  38. convention is ``hostname-YYYY-MM-DD``.
  39. .. _repository_def:
  40. Repository
  41. A repository is a filesystem directory storing data from zero or more
  42. archives. The data in a repository is both deduplicated and
  43. optionally encrypted making it both efficient and safe. Repositories are
  44. created using :ref:`borg_init` and the contents can be listed using
  45. :ref:`borg_list`.
  46. Key file
  47. When a repository is initialized a key file containing a password
  48. protected encryption key is created. It is vital to keep this file safe
  49. since the repository data is totally inaccessible without it.