mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-25 01:06:50 +00:00
Code Issues Releases Wiki Activity
borg/docs/usage/upgrade.rst.inc

112 lines
6.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
------------
docs: usage: avoid bash highlight, [options] instead of <options>
2017-06-06 22:44:53 +00:00
.. code-block:: none
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
python setup.py build_usage
2017-07-23 15:12:01 +00:00
borg [common options] upgrade [options] [REPOSITORY]
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
ran build_usage
2017-06-20 13:22:24 +00:00
.. only:: html
ran build_usage
2017-06-20 09:49:26 +00:00
ran build_usage
2017-06-20 13:22:24 +00:00
.. class:: borg-options-table
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
python setup.py build_usage
2017-07-23 15:12:01 +00:00
+-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+
| **positional arguments** |
+-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+
| | ``REPOSITORY`` | path to the repository to be upgraded |
+-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+
| **optional arguments** |
+-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+
| | ``-n``, ``--dry-run`` | do not change repository |
+-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+
| | ``--inplace`` | rewrite repository in place, with no chance of going back to older versions of the repository. |
+-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+
| | ``--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). |
+-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+
| .. class:: borg-common-opt-ref |
| |
| :ref:`common_options` |
+-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+
ran build_usage
2017-06-20 09:49:26 +00:00
ran build_usage
2017-06-20 13:22:24 +00:00
.. raw:: html
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
ran build_usage
2017-06-20 13:22:24 +00:00
<script type='text/javascript'>
docs: use DOM ready event, not document loaded event
2017-06-20 13:48:30 +00:00
$(document).ready(function () {
ran build_usage
2017-06-20 13:22:24 +00:00
$('.borg-options-table colgroup').remove();
})
</script>
docs: less space waste following "Common options"
2017-06-20 09:53:36 +00:00
ran build_usage
2017-06-20 13:22:24 +00:00
.. only:: latex
docs: less space waste following "Common options"
2017-06-20 09:53:36 +00:00
ran build_usage
2017-06-20 13:22:24 +00:00
REPOSITORY
path to the repository to be upgraded
optional arguments
-n, --dry-run do not change repository
python setup.py build_usage
2017-07-23 15:12:01 +00:00
--inplace rewrite repository in place, with no chance of going back to older versions of the repository.
ran build_usage
2017-06-20 13:22:24 +00:00
--force Force upgrade
python setup.py build_usage
2017-07-23 15:12:01 +00:00
--tam Enable manifest authentication (in key and cache) (Borg 1.0.9 and later).
--disable-tam Disable manifest authentication (in key and cache).
ran build_usage
2017-06-20 13:22:24 +00:00
:ref:`common_options`
|
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
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
~~~~~~~~~~~
ran build_usage
2017-04-29 23:31:20 +00:00
Upgrade an existing, local Borg repository.
When you do not need borg upgrade
+++++++++++++++++++++++++++++++++
Not every change requires that you run ``borg upgrade``.
You do **not** need to run it when:
- moving your repository to a different place
- upgrading to another point release (like 1.0.x to 1.0.y),
except when noted otherwise in the changelog
- upgrading from 1.0.x to 1.1.x,
except when noted otherwise in the changelog
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.
python setup.py build_usage
2022-04-14 19:09:23 +00:00
Borg 0.xx to Borg 1.x
+++++++++++++++++++++
ran build_usage
2016-12-20 22:09:28 +00:00
python setup.py build_usage
2022-04-14 19:09:23 +00:00
This currently supports 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 build_usage
2017-04-29 23:31:20 +00:00
Please note that ``borg create`` (since 1.0.0) uses bigger chunks by
python setup.py build_usage
2022-04-14 19:09:23 +00:00
default than old borg did, so the new chunks won't deduplicate
ran build_usage
2017-04-29 23:31:20 +00:00
with the old chunks in the upgraded repository.
python setup.py build_usage
2022-04-14 19:09:23 +00:00
See ``--chunker-params`` option of ``borg create`` and ``borg recreate``.
Reference in a new issue Copy permalink