You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,7 @@
1
1
# GitHub Enterprise Server Backup Utilities
2
2
3
-
> ⚠️ After 2024-03-29, this repo will contain only releases and documentation. Instead of cloning the repo for a working copy of backup-utils, please [download it from the releases page](https://github.com/github/backup-utils/releases).
3
+
This repository includes backup and recovery utilities for
4
+
[GitHub Enterprise Server][1].
4
5
5
6
**Note**: The parallel backup and restore feature will require [GNU awk](https://www.gnu.org/software/gawk) and [moreutils](https://joeyh.name/code/moreutils) to be installed. Note that on some distributions/platforms, the `moreutils-parallel` package is separate from `moreutils` and must be installed on its own.
Copy file name to clipboardExpand all lines: docs/requirements.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,6 +34,10 @@ However, if your rsync package has backported the CVE fix without backporting th
34
34
35
35
Option #3 is required if your operating system's package manager does not have access to rsync v3.2.5 or later (e.g. Ubuntu Focal).
36
36
37
+
Please note that some operating systems have their own versioning scheme for packages (including `rsync`).
38
+
If your backup host is using one of these operating systems, you will not be able to rely on a version check to determine whether you are
39
+
affected by the `rsync` performance degredation described above.
40
+
37
41
## Storage requirements
38
42
39
43
Storage requirements vary based on current Git repository disk usage and growth
@@ -65,23 +69,23 @@ Please avoid using an NFS mount for the data directory (where backup data is sto
65
69
Starting with Backup Utilities v2.13.0, version support is inline with that of the
66
70
[GitHub Enterprise Server upgrade requirements][8] and as such, support is limited to
67
71
three versions of GitHub Enterprise Server: the version that corresponds with the version
68
-
of Backup Utilities, and the two versions prior to it.
72
+
of Backup Utilities, and the two releases prior to it.
69
73
70
74
For example, Backup Utilities v2.13.0 can be used to backup and restore all patch
71
-
versions from 2.11.0 to the latest patch version of GitHub Enterprise Server 2.13.
75
+
releases from 2.11.0 to the latest patch release of GitHub Enterprise Server 2.13.
72
76
Backup Utilities v2.14.0 will be released when GitHub Enterprise Server 2.14.0 is released
73
-
and will then be used to backup all versions of GitHub Enterprise Server from 2.12.0
74
-
to the latest patch version of GitHub Enterprise Server 2.14.
77
+
and will then be used to backup all releases of GitHub Enterprise Server from 2.12.0
78
+
to the latest patch release of GitHub Enterprise Server 2.14.
75
79
76
80
Backup Utilities v2.11.4 and earlier offer support for GitHub Enterprise Server 2.10
77
-
and earlier versions up to GitHub Enterprise Server 2.2.0. Backup Utilities v2.11.0 and earlier
81
+
and earlier releases up to GitHub Enterprise Server 2.2.0. Backup Utilities v2.11.0 and earlier
78
82
offer support for GitHub Enterprise Server 2.1.0 and earlier.
79
83
80
-
**Note**: You can restore a snapshot that's at most two feature versions behind
84
+
**Note**: You can restore a snapshot that's at most two feature releases behind
81
85
the restore target's version of GitHub Enterprise Server. For example, to restore a
82
86
snapshot of GitHub Enterprise Server 2.11, the target GitHub Enterprise Server appliance must
83
87
be running GitHub Enterprise Server 2.12.x or 2.13.x. You can't restore a snapshot from
84
-
2.10 to 2.13, because that's three versions ahead.
88
+
2.10 to 2.13, because that's three releases ahead.
85
89
86
90
**Note**: You _cannot_ restore a backup created from a newer version of GitHub Enterprise Server to an older version. For example, an attempt to restore a snapshot of GitHub Enterprise Server 2.21 to a GitHub Enterprise Server 2.20 environment will fail with an error of `Error: Snapshot can not be restored to an older release of GitHub Enterprise Server.`.
0 commit comments