key_export.rst.inc 1.3 KB

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