key_export.rst.inc 1.4 KB

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