key_export.rst.inc 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
  2. .. _borg_key_export:
  3. borg key export
  4. ---------------
  5. ::
  6. borg [common options] key export <options> REPOSITORY PATH
  7. positional arguments
  8. REPOSITORY
  9. PATH
  10. where to store the backup
  11. optional arguments
  12. ``--paper``
  13. | Create an export suitable for printing and later type-in
  14. ``--qr-html``
  15. | Create an html file suitable for printing and later type-in or qr scan
  16. :ref:`common_options`
  17. |
  18. Description
  19. ~~~~~~~~~~~
  20. If repository encryption is used, the repository is inaccessible
  21. without the key. This command allows to backup this essential key.
  22. There are two backup formats. The normal backup format is suitable for
  23. digital storage as a file. The ``--paper`` backup format is optimized
  24. for printing and typing in while importing, with per line checks to
  25. reduce problems with manual input.
  26. For repositories using keyfile encryption the key is saved locally
  27. on the system that is capable of doing backups. To guard against loss
  28. of this key, the key needs to be backed up independently of the main
  29. data backup.
  30. For repositories using the repokey encryption the key is saved in the
  31. repository in the config file. A backup is thus not strictly needed,
  32. but guards against the repository becoming inaccessible if the file
  33. is damaged for some reason.