Skip to content

Commit 24bd388

Browse files
Added section about rsync compression
1 parent f0a969e commit 24bd388

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/usage.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,5 +115,11 @@ Please refer to [GHES Documentation](https://docs.github.com/en/enterprise-serve
115115

116116
If you are interested in performing incremental backups of the MySQL data in your GitHub Enterprise Server instance, see [Incremental MySQL Backups and Restores](incremental-mysql-backups-and-restores.md) for details.
117117

118+
## Rsync compression
119+
120+
From backup-utils v3.11.0 onwards, we have disabled rsync compression by default to improve transfer speed and reduce CPU usage durign the transfer process.
121+
122+
If you would like to use compression with rsync, you can add `GHE_RSYNC_COMPRESSION_ENABLED=true` in your `backup.config` file.
123+
118124
[1]: https://github.com/github/backup-utils/blob/master/docs/getting-started.md
119125
[2]: requirements.md

0 commit comments

Comments
 (0)