2017-02-05 13:22:06 +00:00
|
|
|
.\" Man page generated from reStructuredText.
|
|
|
|
|
.
|
|
|
|
|
.
|
|
|
|
|
.nr rst2man-indent-level 0
|
|
|
|
|
.
|
|
|
|
|
.de1 rstReportMargin
|
|
|
|
|
\\$1 \\n[an-margin]
|
|
|
|
|
level \\n[rst2man-indent-level]
|
|
|
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
|
|
|
-
|
|
|
|
|
\\n[rst2man-indent0]
|
|
|
|
|
\\n[rst2man-indent1]
|
|
|
|
|
\\n[rst2man-indent2]
|
|
|
|
|
..
|
|
|
|
|
.de1 INDENT
|
|
|
|
|
.\" .rstReportMargin pre:
|
|
|
|
|
. RS \\$1
|
|
|
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
|
|
|
. nr rst2man-indent-level +1
|
|
|
|
|
.\" .rstReportMargin post:
|
|
|
|
|
..
|
|
|
|
|
.de UNINDENT
|
|
|
|
|
. RE
|
|
|
|
|
.\" indent \\n[an-margin]
|
|
|
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
|
|
|
.nr rst2man-indent-level -1
|
|
|
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
|
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
|
|
|
..
|
2022-06-23 23:19:19 +00:00
|
|
|
.TH "BORG-UPGRADE" 1 "2022-06-25" "" "borg backup tool"
|
|
|
|
|
.SH NAME
|
|
|
|
|
borg-upgrade \- upgrade a repository from a previous version
|
2017-02-05 13:22:06 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.sp
|
2022-06-23 23:19:19 +00:00
|
|
|
borg [common options] upgrade [options]
|
2017-02-05 13:22:06 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.sp
|
2017-04-29 23:32:26 +00:00
|
|
|
Upgrade an existing, local Borg repository.
|
|
|
|
|
.SS When you do not need borg upgrade
|
|
|
|
|
.sp
|
|
|
|
|
Not every change requires that you run \fBborg upgrade\fP\&.
|
|
|
|
|
.sp
|
|
|
|
|
You do \fBnot\fP need to run it when:
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.IP \(bu 2
|
|
|
|
|
moving your repository to a different place
|
|
|
|
|
.IP \(bu 2
|
|
|
|
|
upgrading to another point release (like 1.0.x to 1.0.y),
|
|
|
|
|
except when noted otherwise in the changelog
|
|
|
|
|
.IP \(bu 2
|
|
|
|
|
upgrading from 1.0.x to 1.1.x,
|
|
|
|
|
except when noted otherwise in the changelog
|
|
|
|
|
.UNINDENT
|
2017-02-05 13:22:06 +00:00
|
|
|
.SS Borg 1.x.y upgrades
|
|
|
|
|
.sp
|
|
|
|
|
Use \fBborg upgrade \-\-tam REPO\fP 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
|
2022-12-29 22:26:54 +00:00
|
|
|
to 1.0.9 will raise a validation error, so perform this upgrade
|
|
|
|
|
only after updating all clients using the repository to 1.0.9 or newer.
|
2017-02-05 13:22:06 +00:00
|
|
|
.sp
|
|
|
|
|
This upgrade should be done on each client for safety reasons.
|
|
|
|
|
.sp
|
|
|
|
|
If a repository is accidentally modified with a pre\-1.0.9 client after
|
|
|
|
|
this upgrade, use \fBborg upgrade \-\-tam \-\-force REPO\fP to remedy it.
|
|
|
|
|
.sp
|
|
|
|
|
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 \fBborg upgrade \-\-disable\-tam REPO\fP\&.
|
|
|
|
|
.sp
|
|
|
|
|
See
|
|
|
|
|
\fI\%https://borgbackup.readthedocs.io/en/stable/changes.html#pre\-1\-0\-9\-manifest\-spoofing\-vulnerability\fP
|
|
|
|
|
for details.
|
2022-04-14 19:13:46 +00:00
|
|
|
.SS Borg 0.xx to Borg 1.x
|
2017-02-05 13:22:06 +00:00
|
|
|
.sp
|
2022-04-14 19:13:46 +00:00
|
|
|
This currently supports converting Borg 0.xx to 1.0.
|
2017-02-05 13:22:06 +00:00
|
|
|
.sp
|
|
|
|
|
Currently, only LOCAL repositories can be upgraded (issue #465).
|
|
|
|
|
.sp
|
2017-04-29 23:32:26 +00:00
|
|
|
Please note that \fBborg create\fP (since 1.0.0) uses bigger chunks by
|
2022-04-14 19:13:46 +00:00
|
|
|
default than old borg did, so the new chunks won\(aqt deduplicate
|
2017-04-29 23:32:26 +00:00
|
|
|
with the old chunks in the upgraded repository.
|
|
|
|
|
See \fB\-\-chunker\-params\fP option of \fBborg create\fP and \fBborg recreate\fP\&.
|
2017-02-05 13:22:06 +00:00
|
|
|
.SH OPTIONS
|
|
|
|
|
.sp
|
|
|
|
|
See \fIborg\-common(1)\fP for common options of Borg commands.
|
|
|
|
|
.SS optional arguments
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-n\fP,\fB \-\-dry\-run
|
2017-02-05 13:22:06 +00:00
|
|
|
do not change repository
|
|
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-\-inplace
|
2017-11-25 13:38:04 +00:00
|
|
|
rewrite repository in place, with no chance of going back to older versions of the repository.
|
2017-02-05 13:22:06 +00:00
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-\-force
|
2017-02-05 13:22:06 +00:00
|
|
|
Force upgrade
|
|
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-\-tam
|
2017-11-25 13:38:04 +00:00
|
|
|
Enable manifest authentication (in key and cache) (Borg 1.0.9 and later).
|
2017-02-05 13:22:06 +00:00
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-\-disable\-tam
|
2017-11-25 13:38:04 +00:00
|
|
|
Disable manifest authentication (in key and cache).
|
2017-02-05 13:22:06 +00:00
|
|
|
.UNINDENT
|
|
|
|
|
.SH EXAMPLES
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.INDENT 3.5
|
|
|
|
|
.sp
|
|
|
|
|
.nf
|
|
|
|
|
.ft C
|
|
|
|
|
# Upgrade the borg repository to the most recent version.
|
|
|
|
|
$ borg upgrade \-v /path/to/repo
|
2017-11-25 13:38:04 +00:00
|
|
|
making a hardlink copy in /path/to/repo.before\-upgrade\-2016\-02\-15\-20:51:55
|
2017-02-05 13:22:06 +00:00
|
|
|
opening attic repository with borg and converting
|
|
|
|
|
no key file found for repository
|
|
|
|
|
converting repo index /path/to/repo/index.0
|
|
|
|
|
converting 1 segments...
|
|
|
|
|
converting borg 0.xx to borg current
|
|
|
|
|
no key file found for repository
|
|
|
|
|
.ft P
|
|
|
|
|
.fi
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.sp
|
|
|
|
|
\fIborg\-common(1)\fP
|
|
|
|
|
.SH AUTHOR
|
|
|
|
|
The Borg Collective
|
|
|
|
|
.\" Generated by docutils manpage writer.
|
|
|
|
|
.
|
