Browse Source

ran build_usage

Thomas Waldmann 8 years ago
parent
commit
1c55930840
1 changed files with 26 additions and 1 deletions
  1. 26 1
      docs/usage/upgrade.rst.inc

+ 26 - 1
docs/usage/upgrade.rst.inc

@@ -8,7 +8,7 @@ borg upgrade
 
     usage: borg upgrade [-h] [--critical] [--error] [--warning] [--info] [--debug]
                         [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M]
-                        [--remote-path PATH] [-p] [-n] [-i]
+                        [--remote-path PATH] [-p] [-n] [-i] [--force] [--tam]
                         [REPOSITORY]
     
     upgrade a repository from a previous version
@@ -34,11 +34,36 @@ borg upgrade
       -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.
+      --force               Force upgrade
+      --tam                 Enable manifest authentication (in key and cache)
+                            (Borg 1.0.9 and later)
     
 Description
 ~~~~~~~~~~~
 
 Upgrade an existing Borg repository.
+
+Borg 1.x.y upgrades
+-------------------
+
+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.
+
+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
+-------------------------------
+
 This currently supports converting an Attic repository to Borg and also
 helps with converting Borg 0.xx to 1.0.