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

upgrade.rst.inc 2.2 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566 
  1. .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
    2. 

  2. 

  3. .. _borg_upgrade:
    4. 

  4. 

  5. borg upgrade
    6. 

  6. ------------
    7. 

  7. ::
    8. 

  8. 

  9.     borg upgrade <options> REPOSITORY
    10. 

  10. 

  11. positional arguments
    12. 

  12.     REPOSITORY
    13. 

  13.         path to the repository to be upgraded
    14. 

  14. 

  15. optional arguments
    16. 

  16.     ``-p``, ``--progress``
    17. 

  17.         | show progress display while upgrading the repository
    18. 

  18.     ``-n``, ``--dry-run``
    19. 

  19.         | do not change repository
    20. 

  20.     ``-i``, ``--inplace``
    21. 

  21.         | rewrite repository in place, with no chance of going back to older
    22. 

  22.         |                                versions of the repository.
    23. 

  23. 

  24. `Common options`_
    25. 

  25.     |
    26. 

  26. 

  27. Description
    28. 

  28. ~~~~~~~~~~~
    29. 

  29. 

  30. Upgrade an existing Borg repository.
    31. 

  31. This currently supports converting an Attic repository to Borg and also
    32. 

  32. helps with converting Borg 0.xx to 1.0.
    33. 

  33. 

  34. Currently, only LOCAL repositories can be upgraded (issue #465).
    35. 

  35. 

  36. It will change the magic strings in the repository's segments
    37. 

  37. to match the new Borg magic strings. The keyfiles found in
    38. 

  38. $ATTIC_KEYS_DIR or ~/.attic/keys/ will also be converted and
    39. 

  39. copied to $BORG_KEYS_DIR or ~/.config/borg/keys.
    40. 

  40. 

  41. The cache files are converted, from $ATTIC_CACHE_DIR or
    42. 

  42. ~/.cache/attic to $BORG_CACHE_DIR or ~/.cache/borg, but the
    43. 

  43. cache layout between Borg and Attic changed, so it is possible
    44. 

  44. the first backup after the conversion takes longer than expected
    45. 

  45. due to the cache resync.
    46. 

  46. 

  47. Upgrade should be able to resume if interrupted, although it
    48. 

  48. will still iterate over all segments. If you want to start
    49. 

  49. from scratch, use `borg delete` over the copied repository to
    50. 

  50. make sure the cache files are also removed:
    51. 

  51. 

  52.     borg delete borg
    53. 

  53. 

  54. Unless ``--inplace`` is specified, the upgrade process first
    55. 

  55. creates a backup copy of the repository, in
    56. 

  56. REPOSITORY.upgrade-DATETIME, using hardlinks. This takes
    57. 

  57. longer than in place upgrades, but is much safer and gives
    58. 

  58. progress information (as opposed to ``cp -al``). Once you are
    59. 

  59. satisfied with the conversion, you can safely destroy the
    60. 

  60. backup copy.
    61. 

  61. 

  62. WARNING: Running the upgrade in place will make the current
    63. 

  63. copy unusable with older version, with no way of going back
    64. 

  64. to previous versions. This can PERMANENTLY DAMAGE YOUR
    65. 

  65. REPOSITORY!  Attic CAN NOT READ BORG REPOSITORIES, as the
    66. 

  66. magic strings have changed. You have been warned.
    67.