GitHub Enterprise Backup Utilities
Перейти к файлу
release-controller[bot] da132c8f94 3.10.3 release 2024-01-19 21:09:47 +00:00
.github Merge pull request #680 from github/enterprise-3.10-backport-679-timreimherr/build-and-release-edit 2023-10-23 14:09:59 +00:00
bin Merge branch 'enterprise-3.10-release' into enterprise-3.10-backport-569-check-datadir-is-nfs 2023-10-03 20:20:45 +02:00
debian no need to update changelog 2023-11-29 11:41:40 -08:00
docs Merge branch 'enterprise-3.10-release' into enterprise-3.10-backport-569-check-datadir-is-nfs 2023-10-03 20:20:45 +02:00
release-notes Create 3.10.2 release notes 2023-11-29 11:41:40 -08:00
script Merge pull request #568 from github/543-workflow-build-release-part-2 2023-09-27 08:50:53 -04:00
share/github-backup-utils Update version file to 3.10.2 2023-11-29 11:41:40 -08:00
test Merge pull request #459 from github/ddivad195/container-prefix-fix 2023-10-12 09:01:46 +00: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 3.10.0 RC Release 2023-08-08 21:18:25 +00:00
.releaseignore Merge pull request #568 from github/543-workflow-build-release-part-2 2023-09-27 08:50:53 -04: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 add bc 2023-06-29 15:23:20 +02: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 only run lint on pr workflow (#386) 2023-07-06 12:46:02 +02:00
README.md Fix minor README linter warnings 2022-10-13 11:16:59 -07:00
STYLEGUIDE.md spelling: variables 2022-05-25 20:56:15 -04:00
backup.config-example fix backup.config typo (#587) 2023-09-15 16:36:27 +00: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.