mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-27 02:08:54 +00:00
Code Issues Releases Wiki Activity
borg/docs/usage/upgrade.rst.inc

98 lines
3.4 KiB
PHP
Raw Normal View History

update usage files
2016-07-05 21:30:08 +00:00
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
.. _borg_upgrade:
borg upgrade
------------
::
Better help texts and Sphinx reproduction of usage - Group options - Nicer list of options in Sphinx - Deduplicate 'Common options' (including --help) The latter is done by explicitly declaring --help in the common_parser, which is then inherited by the sub-parsers; no change in observable behaviour.
2016-04-09 23:28:18 +00:00
borg upgrade <options> REPOSITORY
positional arguments
REPOSITORY
path to the repository to be upgraded
optional arguments
``-p``, ``--progress``
| show progress display while upgrading the repository
``-n``, ``--dry-run``
| do not change repository
``-i``, ``--inplace``
| rewrite repository in place, with no chance of going back to older
| versions of the repository.
ran build_usage
2016-12-20 22:09:28 +00:00
``--force``
| Force upgrade
``--tam``
| Enable manifest authentication (in key and cache) (Borg 1.0.9 and later)
``--disable-tam``
| Disable manifest authentication (in key and cache)
Better help texts and Sphinx reproduction of usage - Group options - Nicer list of options in Sphinx - Deduplicate 'Common options' (including --help) The latter is done by explicitly declaring --help in the common_parser, which is then inherited by the sub-parsers; no change in observable behaviour.
2016-04-09 23:28:18 +00:00
`Common options`_
|
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
Description
~~~~~~~~~~~
docs: borg upgrade also handles borg 0.xx -> 1.0
2016-02-07 18:23:06 +00:00
Upgrade an existing Borg repository.
ran build_usage
2016-12-20 22:09:28 +00:00
Borg 1.x.y upgrades
ran setup.py build_usage
2017-01-14 16:19:19 +00:00
+++++++++++++++++++
ran build_usage
2016-12-20 22:09:28 +00:00
Use ``borg upgrade --tam REPO`` to require manifest authentication
introduced with Borg 1.0.9 to address security issues. This means
that modifying the repository after doing this with a version prior
to 1.0.9 will raise a validation error, so only perform this upgrade
after updating all clients using the repository to 1.0.9 or newer.
This upgrade should be done on each client for safety reasons.
If a repository is accidentally modified with a pre-1.0.9 client after
this upgrade, use ``borg upgrade --tam --force REPO`` to remedy it.
If you routinely do this you might not want to enable this upgrade
(which will leave you exposed to the security issue). You can
reverse the upgrade by issuing ``borg upgrade --disable-tam REPO``.
See
https://borgbackup.readthedocs.io/en/stable/changes.html#pre-1-0-9-manifest-spoofing-vulnerability
for details.
Attic and Borg 0.xx to Borg 1.x
ran setup.py build_usage
2017-01-14 16:19:19 +00:00
+++++++++++++++++++++++++++++++
ran build_usage
2016-12-20 22:09:28 +00:00
docs: borg upgrade also handles borg 0.xx -> 1.0
2016-02-07 18:23:06 +00:00
This currently supports converting an Attic repository to Borg and also
helps with converting Borg 0.xx to 1.0.
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
borg upgrade: add to docs that only LOCAL repos are supported
2016-02-07 20:08:20 +00:00
Currently, only LOCAL repositories can be upgraded (issue #465).
ran setup.py build_usage
2016-01-23 19:54:20 +00:00
It will change the magic strings in the repository's segments
to match the new Borg magic strings. The keyfiles found in
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
$ATTIC_KEYS_DIR or ~/.attic/keys/ will also be converted and
run build_usage
2016-02-07 13:50:39 +00:00
copied to $BORG_KEYS_DIR or ~/.config/borg/keys.
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
ran setup.py build_usage
2016-01-23 19:54:20 +00:00
The cache files are converted, from $ATTIC_CACHE_DIR or
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
~/.cache/attic to $BORG_CACHE_DIR or ~/.cache/borg, but the
cache layout between Borg and Attic changed, so it is possible
the first backup after the conversion takes longer than expected
due to the cache resync.
ran setup.py build_usage
2016-01-23 19:54:20 +00:00
Upgrade should be able to resume if interrupted, although it
will still iterate over all segments. If you want to start
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
from scratch, use `borg delete` over the copied repository to
make sure the cache files are also removed:
borg delete borg
ran setup.py build_usage
2016-01-23 19:54:20 +00:00
Unless ``--inplace`` is specified, the upgrade process first
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
creates a backup copy of the repository, in
ran setup.py build_usage
2016-01-23 19:54:20 +00:00
REPOSITORY.upgrade-DATETIME, using hardlinks. This takes
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
longer than in place upgrades, but is much safer and gives
ran setup.py build_usage
2016-01-23 19:54:20 +00:00
progress information (as opposed to ``cp -al``). Once you are
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
satisfied with the conversion, you can safely destroy the
backup copy.
ran setup.py build_usage
2016-01-23 19:54:20 +00:00
WARNING: Running the upgrade in place will make the current
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
copy unusable with older version, with no way of going back
ran setup.py build_usage
2016-01-23 19:54:20 +00:00
to previous versions. This can PERMANENTLY DAMAGE YOUR
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
REPOSITORY! Attic CAN NOT READ BORG REPOSITORIES, as the
ran setup.py build_usage
2016-01-23 19:54:20 +00:00
magic strings have changed. You have been warned.
Reference in a new issue Copy permalink