Skip to content

Commit e4f3ae7

Browse files
release-controller[bot]release-controller[bot]
authored andcommitted
3.12.0 release
1 parent 2b993ac commit e4f3ae7

File tree

2 files changed

+10
-12
lines changed

2 files changed

+10
-12
lines changed

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 release version][1] and extract the repository using `tar`:
3+
1. [Download the latest version of backup-utils][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: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,10 @@ storage and must have network connectivity with the GitHub Enterprise Server app
77

88
Backup host software requirements are modest: Linux or other modern Unix operating system (Ubuntu is highly recommended) with [bash][1], [git][2] 1.7.6 or newer, [OpenSSH][3] 5.6 or newer, [rsync][4] v2.6.4 or newer* (see [below](april-2023-update-of-rsync-requirements) for exceptions), [jq][11] v1.5 or newer and [bc][12] v1.0.7 or newer. See below for an update on rsync.
99

10-
Ubuntu is the operating system we use to test `backup-utils` and it’s what we recommend you use too. You are welcome to use a different operating system, and we'll do our best to help you if you run into issues. But we can't guarantee that we'll be able to resolve issues that are specific to that operating system.
11-
12-
Additionally, we encourage the use of [Docker](docker.md), as it ensures compatible versions of the aforementioned software are available to backup-utils.
13-
1410
The parallel backup and restore feature will require [GNU awk][10] and [moreutils][9] to be installed.
1511

12+
We encourage the use of [Docker](docker.md), as it ensures compatible versions of the aforementioned software are available to backup-utils.
13+
1614
The backup host must be able to establish outbound network connections to the GitHub appliance over SSH. TCP port 122 is used to backup GitHub Enterprise Server.
1715

1816
CPU and memory requirements are dependent on the size of the GitHub Enterprise Server appliance. We recommend a minimum of 4 cores and 8GB of RAM for the host running [GitHub Enterprise Backup Utilities](https://github.com/github/backup-utils). We recommend monitoring the backup host's CPU and memory usage to ensure it is sufficient for your environment.
@@ -67,23 +65,23 @@ Please avoid using an NFS mount for the data directory (where backup data is sto
6765
Starting with Backup Utilities v2.13.0, version support is inline with that of the
6866
[GitHub Enterprise Server upgrade requirements][8] and as such, support is limited to
6967
three versions of GitHub Enterprise Server: the version that corresponds with the version
70-
of Backup Utilities, and the two releases prior to it.
68+
of Backup Utilities, and the two versions prior to it.
7169

7270
For example, Backup Utilities v2.13.0 can be used to backup and restore all patch
73-
releases from 2.11.0 to the latest patch release of GitHub Enterprise Server 2.13.
71+
versions from 2.11.0 to the latest patch version of GitHub Enterprise Server 2.13.
7472
Backup Utilities v2.14.0 will be released when GitHub Enterprise Server 2.14.0 is released
75-
and will then be used to backup all releases of GitHub Enterprise Server from 2.12.0
76-
to the latest patch release of GitHub Enterprise Server 2.14.
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.
7775

7876
Backup Utilities v2.11.4 and earlier offer support for GitHub Enterprise Server 2.10
79-
and earlier releases up to GitHub Enterprise Server 2.2.0. Backup Utilities v2.11.0 and earlier
77+
and earlier versions up to GitHub Enterprise Server 2.2.0. Backup Utilities v2.11.0 and earlier
8078
offer support for GitHub Enterprise Server 2.1.0 and earlier.
8179

82-
**Note**: You can restore a snapshot that's at most two feature releases behind
80+
**Note**: You can restore a snapshot that's at most two feature versions behind
8381
the restore target's version of GitHub Enterprise Server. For example, to restore a
8482
snapshot of GitHub Enterprise Server 2.11, the target GitHub Enterprise Server appliance must
8583
be running GitHub Enterprise Server 2.12.x or 2.13.x. You can't restore a snapshot from
86-
2.10 to 2.13, because that's three releases ahead.
84+
2.10 to 2.13, because that's three versions ahead.
8785

8886
**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.`.
8987

0 commit comments

Comments
 (0)