migrate-to-repokey.rst.inc 1.9 KB

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