Skip to content

Commit e6e76c6

Browse files
Update requirements to reflect rsync package compatability
1 parent 00c1703 commit e6e76c6

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/requirements.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,15 @@ storage and must have network connectivity with the GitHub Enterprise Server app
66
## Backup host requirements
77

88
Backup host software requirements are modest: Linux or other modern Unix operating
9-
system (Ubuntu is highly recommended) with [bash][1], [git][2], [OpenSSH][3] 5.6 or newer, [rsync][4] v3.2.5 or newer, and [jq][11] v1.5 or newer.
9+
system (Ubuntu is highly recommended) with [bash][1], [git][2], [OpenSSH][3] 5.6 or newer, [rsync][4] v2.6.4 or newer, and [jq][11] v1.5 or newer.
10+
11+
************ Update April 2023 ************
12+
13+
The recent fix to rsync for [CVE-2022-29154](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2022-29154) is causing severe performance impacts on backup-utils.
14+
15+
These impacts can be mitigated by using the `--trust-sender` flag with rsync. Unfortunately some Linux distributions have backported the fix for this CVE to their rsync package without also backporting the `--trust-sender` flag. If your backup host is running an operating system that has done this, your options are to either downgrade the rsync package to a version before the CVE fix was backported, or upgrade the rsync package to v3.2.5 or newer.
16+
17+
*******************************************
1018

1119
The parallel backup and restore feature will require [GNU awk][10] and [moreutils][9] to be installed.
1220

0 commit comments

Comments
 (0)