Skip to content

Commit 4db95da

Browse files
release-controller[bot]release-controller[bot]
authored andcommitted
3.12.1 release
1 parent 306a89c commit 4db95da

File tree

3 files changed

+14
-9
lines changed

3 files changed

+14
-9
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# GitHub Enterprise Server Backup Utilities
22

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].
45

56
**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.
67

docs/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Getting started
22

3-
1. [Download the latest version of backup-utils][1] and extract the repository using `tar`:
3+
1. [Download the latest release version][1] and extract the repository using `tar`:
44

55
`tar -xzvf /path/to/github-backup-utils-vMAJOR.MINOR.PATCH.tar.gz`
66

docs/requirements.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ However, if your rsync package has backported the CVE fix without backporting th
3434

3535
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).
3636

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+
3741
## Storage requirements
3842

3943
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
6569
Starting with Backup Utilities v2.13.0, version support is inline with that of the
6670
[GitHub Enterprise Server upgrade requirements][8] and as such, support is limited to
6771
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.
6973

7074
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.
7276
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.
7579

7680
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
7882
offer support for GitHub Enterprise Server 2.1.0 and earlier.
7983

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
8185
the restore target's version of GitHub Enterprise Server. For example, to restore a
8286
snapshot of GitHub Enterprise Server 2.11, the target GitHub Enterprise Server appliance must
8387
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.
8589

8690
**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.`.
8791

0 commit comments

Comments
 (0)