migrate-to-repokey.rst.inc 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
  2. .. _borg_migrate-to-repokey:
  3. borg migrate-to-repokey
  4. -----------------------
  5. ::
  6. usage: borg migrate-to-repokey [-h] [--critical] [--error] [--warning]
  7. [--info] [--debug] [--lock-wait N] [--show-rc]
  8. [--no-files-cache] [--umask M]
  9. [--remote-path PATH]
  10. [REPOSITORY]
  11. Migrate passphrase -> repokey
  12. positional arguments:
  13. REPOSITORY
  14. optional arguments:
  15. -h, --help show this help message and exit
  16. --critical work on log level CRITICAL
  17. --error work on log level ERROR
  18. --warning work on log level WARNING (default)
  19. --info, -v, --verbose
  20. work on log level INFO
  21. --debug work on log level DEBUG
  22. --lock-wait N wait for the lock, but max. N seconds (default: 1).
  23. --show-rc show/log the return code (rc)
  24. --no-files-cache do not load/update the file metadata cache used to
  25. detect unchanged files
  26. --umask M set umask to M (local and remote, default: 0077)
  27. --remote-path PATH use PATH as borg executable on the remote (default:
  28. "borg")
  29. Description
  30. ~~~~~~~~~~~
  31. This command migrates a repository from passphrase mode (not supported any
  32. more) to repokey mode.
  33. You will be first asked for the repository passphrase (to open it in passphrase
  34. mode). This is the same passphrase as you used to use for this repo before 1.0.
  35. It will then derive the different secrets from this passphrase.
  36. Then you will be asked for a new passphrase (twice, for safety). This
  37. passphrase will be used to protect the repokey (which contains these same
  38. secrets in encrypted form). You may use the same passphrase as you used to
  39. use, but you may also use a different one.
  40. After migrating to repokey mode, you can change the passphrase at any time.
  41. But please note: the secrets will always stay the same and they could always
  42. be derived from your (old) passphrase-mode passphrase.