GitHub Enterprise Backup Utilities
Перейти к файлу
Andrew Mildahl bec5f58042
Fix ghe-host-check unsupported version test for unreleased feature versions
2023-11-28 16:57:44 -06:00
.github Bump actions/checkout from 3 to 4 2023-11-03 16:44:28 +00:00
bin Update versions 2023-11-28 15:54:38 -06:00
debian Bump version: 3.8.0 [ci skip] 2023-02-07 21:48:52 +00:00
docs Update requirements.md 2023-11-07 15:14:02 -08:00
script clean up 2023-09-26 15:47:11 +00:00
share/github-backup-utils Update versions 2023-11-28 15:54:38 -06:00
test Fix ghe-host-check unsupported version test for unreleased feature versions 2023-11-28 16:57:44 -06: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 Incremental MySQL Backups and Restores (#366) 2023-08-01 18:37:03 -04:00
.releaseignore implement .releaseignore 2023-09-19 13:41:14 -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 remove dead code (#586) 2023-09-20 13:08:24 +00:00
README.md add link to release documentation 2023-09-27 18:10:06 +00:00
STYLEGUIDE.md spelling: variables 2022-05-25 20:56:15 -04:00
backup.config-example Update backup.config-example 2023-11-06 15:13:51 -05:00
ownership.yaml Update service ownership data (#519) 2023-08-22 10:30:02 -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.