GitHub Enterprise Backup Utilities
Перейти к файлу
Shruti Corbett 4a6ab3a782
Merge pull request #966 from github/shcorbett-remove-parallel-beta-reference
Remove parallel beta reference
2022-10-13 14:05:28 -04:00
.github Merge branch 'master' into djdefi-checkoutv3 2022-08-05 12:30:40 -07:00
bin Bump version: 3.6.0 [ci skip] 2022-08-17 19:20:54 +00:00
debian Bump version: 3.6.0 [ci skip] 2022-08-17 19:20:54 +00:00
docs Update requirements.md 2022-10-13 09:29:16 -04:00
script Check for .tar.xz instead of .tar.gz when publishing Debian package 2022-02-15 20:06:07 +00:00
share/github-backup-utils Add verbose output for audit log output 2022-09-21 11:02:18 -07:00
test make stub script executable and quiet linter 2022-09-09 09:55:52 +10:00
.dockerignore Added git related dockerignore entries 2020-10-18 14:19:44 +02:00
.gitattributes Exclude .gitignore and .gitattributes files from archives 2014-08-04 09:05:29 -07:00
.gitignore Git ignores dist/ directory 2014-08-04 09:05:28 -07:00
.ruby-version Revert "Remove unrelated changes" 2017-09-14 09:15:58 +01:00
CONTRIBUTING.md Remove duplicated word 2016-09-07 22:57:12 +02:00
Dockerfile Buster to align with GHES 2022-08-04 09:41:27 -07:00
Dockerfile.alpine Merge branch 'master' into master 2021-03-31 21:10:45 -07:00
LICENSE Add MIT license 2014-07-23 14:20:02 +02:00
Makefile New makefile target 2016-07-27 19:06:14 +02:00
README.md Update README.md 2022-10-13 09:26:40 -04:00
RELEASING.md Update release steps to include syncing to/from backup-utils-private 2021-01-16 10:43:50 -08:00
STYLEGUIDE.md Improve wording 2018-04-06 11:27:33 +01:00
backup.config-example Update backup.config-example 2022-10-13 09:27:50 -04:00

README.md

GitHub Enterprise Server Backup Utilities

This repository includes backup and recovery utilities for GitHub Enterprise Server.

Note: The parallel backup and restore feature will require GNU awk and 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.

Note: the GitHub Enterprise Server version requirements have changed starting with Backup Utilities v2.13.0, released on 27 March 2018.

Features

Backup Utilities implement a number of advanced capabilities for backup hosts, built on top of the backup and restore features already included in GitHub Enterprise Server.

  • Complete GitHub Enterprise Server backup and recovery system via two simple utilities:
    ghe-backup and ghe-restore.
  • Online backups. The GitHub appliance need not be put in maintenance mode for the duration of the backup run.
  • Incremental backup of Git repository data. Only changes since the last snapshot are transferred, leading to faster backup runs and lower network bandwidth and machine utilization.
  • Efficient snapshot storage. Only data added since the previous snapshot consumes new space on the backup host.
  • Multiple backup snapshots with configurable retention periods.
  • Backup commands run under the lowest CPU/IO priority on the GitHub appliance, reducing performance impact while backups are in progress.
  • Runs under most Linux/Unix environments.
  • MIT licensed, open source software maintained by GitHub, Inc.

Documentation

Support

If you find a bug or would like to request a feature in Backup Utilities, please open an issue or pull request on this repository. If you have a question related to your specific GitHub Enterprise Server setup or would like assistance with backup site setup or recovery, please contact our Enterprise support team instead.