key_migrate-to-repokey.rst.inc 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
  2. .. _borg_key_migrate-to-repokey:
  3. borg key migrate-to-repokey
  4. ---------------------------
  5. .. code-block:: none
  6. borg [common options] key migrate-to-repokey [options] REPOSITORY
  7. .. only:: html
  8. .. class:: borg-options-table
  9. +-------------------------------------------------------+----------------+--+
  10. | **positional arguments** |
  11. +-------------------------------------------------------+----------------+--+
  12. | | ``REPOSITORY`` | |
  13. +-------------------------------------------------------+----------------+--+
  14. | **optional arguments** |
  15. +-------------------------------------------------------+----------------+--+
  16. | .. class:: borg-common-opt-ref |
  17. | |
  18. | :ref:`common_options` |
  19. +-------------------------------------------------------+----------------+--+
  20. .. raw:: html
  21. <script type='text/javascript'>
  22. $(window).load(function () {
  23. $('.borg-options-table colgroup').remove();
  24. })
  25. </script>
  26. .. only:: latex
  27. REPOSITORY
  28. :ref:`common_options`
  29. |
  30. Description
  31. ~~~~~~~~~~~
  32. This command migrates a repository from passphrase mode (removed in Borg 1.0)
  33. to repokey mode.
  34. You will be first asked for the repository passphrase (to open it in passphrase
  35. mode). This is the same passphrase as you used to use for this repo before 1.0.
  36. It will then derive the different secrets from this passphrase.
  37. Then you will be asked for a new passphrase (twice, for safety). This
  38. passphrase will be used to protect the repokey (which contains these same
  39. secrets in encrypted form). You may use the same passphrase as you used to
  40. use, but you may also use a different one.
  41. After migrating to repokey mode, you can change the passphrase at any time.
  42. But please note: the secrets will always stay the same and they could always
  43. be derived from your (old) passphrase-mode passphrase.