getting-started.md

Getting started

1. Download the latest release version and extract the repository using tar:

   tar -xzvf /path/to/github-backup-utils-vMAJOR.MINOR.PATCH.tar.gz

   or clone the repository using Git:

   git clone -b stable https://github.com/github/backup-utils.git

   Note: you will need to use Backup Utilities v2.11.x or the legacy branch to backup and restore GitHub Enterprise 2.10 and earlier.

2. Copy the backup.config-example file to backup.config and modify as necessary. The GHE_HOSTNAME value must be set to the GitHub Enterprise host name. Additional options are available and documented in the configuration file but none are required for basic backup functionality.

   • Backup Utilities will attempt to load the backup configuration from the following locations, in this order:

     $GHE_BACKUP_CONFIG (User configurable environment variable)
     $GHE_BACKUP_ROOT/backup.config (Root directory of backup-utils install)
     $HOME/.github-backup-utils/backup.config
     /etc/github-backup-utils/backup.config
     

   • In a clustering environment, the GHE_EXTRA_SSH_OPTS key must be configured with the -i <abs path to private key> SSH option.

3. Add the backup host's SSH key to the GitHub appliance as an Authorized SSH key. See Adding an SSH key for shell access for instructions.

4. Run bin/ghe-host-check to verify SSH connectivity with the GitHub appliance.

5. Run bin/ghe-backup to perform an initial full backup.