migrate-to-repokey.rst.inc 2.1 KB

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