Home Explore Help
Sign In
mirrors
/
borg
mirror of https://github.com/borgbackup/borg
2
0
Fork 0
Files Issues 0 Wiki
Tree: b8303a38bf
Branches Tags
borg
/
docs
/
usage
/
upgrade.rst.inc

upgrade.rst.inc 2.1 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364 
  1. .. _borg_upgrade:
    2. 

  2. 

  3. borg upgrade
    4. 

  4. ------------
    5. 

  5. ::
    6. 

  6. 

  7.     borg upgrade <options> REPOSITORY
    8. 

  8. 

  9. positional arguments
    10. 

  10.     REPOSITORY
    11. 

  11.         path to the repository to be upgraded
    12. 

  12. 

  13. optional arguments
    14. 

  14.     ``-p``, ``--progress``
    15. 

  15.         | show progress display while upgrading the repository
    16. 

  16.     ``-n``, ``--dry-run``
    17. 

  17.         | do not change repository
    18. 

  18.     ``-i``, ``--inplace``
    19. 

  19.         | rewrite repository in place, with no chance of going back to older
    20. 

  20.         |                                versions of the repository.
    21. 

  21. 

  22. `Common options`_
    23. 

  23.     |
    24. 

  24. 

  25. Description
    26. 

  26. ~~~~~~~~~~~
    27. 

  27. 

  28. Upgrade an existing Borg repository.
    29. 

  29. This currently supports converting an Attic repository to Borg and also
    30. 

  30. helps with converting Borg 0.xx to 1.0.
    31. 

  31. 

  32. Currently, only LOCAL repositories can be upgraded (issue #465).
    33. 

  33. 

  34. It will change the magic strings in the repository's segments
    35. 

  35. to match the new Borg magic strings. The keyfiles found in
    36. 

  36. $ATTIC_KEYS_DIR or ~/.attic/keys/ will also be converted and
    37. 

  37. copied to $BORG_KEYS_DIR or ~/.config/borg/keys.
    38. 

  38. 

  39. The cache files are converted, from $ATTIC_CACHE_DIR or
    40. 

  40. ~/.cache/attic to $BORG_CACHE_DIR or ~/.cache/borg, but the
    41. 

  41. cache layout between Borg and Attic changed, so it is possible
    42. 

  42. the first backup after the conversion takes longer than expected
    43. 

  43. due to the cache resync.
    44. 

  44. 

  45. Upgrade should be able to resume if interrupted, although it
    46. 

  46. will still iterate over all segments. If you want to start
    47. 

  47. from scratch, use `borg delete` over the copied repository to
    48. 

  48. make sure the cache files are also removed:
    49. 

  49. 

  50.     borg delete borg
    51. 

  51. 

  52. Unless ``--inplace`` is specified, the upgrade process first
    53. 

  53. creates a backup copy of the repository, in
    54. 

  54. REPOSITORY.upgrade-DATETIME, using hardlinks. This takes
    55. 

  55. longer than in place upgrades, but is much safer and gives
    56. 

  56. progress information (as opposed to ``cp -al``). Once you are
    57. 

  57. satisfied with the conversion, you can safely destroy the
    58. 

  58. backup copy.
    59. 

  59. 

  60. WARNING: Running the upgrade in place will make the current
    61. 

  61. copy unusable with older version, with no way of going back
    62. 

  62. to previous versions. This can PERMANENTLY DAMAGE YOUR
    63. 

  63. REPOSITORY!  Attic CAN NOT READ BORG REPOSITORIES, as the
    64. 

  64. magic strings have changed. You have been warned.
    65.