Skip to content

Commit

Permalink
Merge pull request #1184 from github/fix-config-example-link
Browse files Browse the repository at this point in the history
Remove link to 404 on backup.config-example in getting-started.md
  • Loading branch information
dctucker authored Jan 16, 2025
2 parents 782b06c + 91ed562 commit 8d0d11d
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
**Note**: you will need to use [Backup Utilities v2.11.x][2] or the `legacy` branch to
backup and restore GitHub Enterprise Server 2.10 and earlier.

2. Copy the [`backup.config-example`][3] file to `backup.config` and modify as
2. Copy the `backup.config-example` file to `backup.config` and modify as
necessary. The `GHE_HOSTNAME` value must be set to the primary GitHub Enterprise Server
hostname. Additional options are available and documented in the
configuration file but none are required for basic backup functionality.
Expand All @@ -28,7 +28,7 @@
with the `-i <abs path to private key>` SSH option.

3. Add the backup host's SSH public key to the GitHub Enterprise Server appliance, in order to grant it administrative shell access.
See [Accessing the GitHub Enterprise Server administrative shell (SSH)][4] for instructions.
See [Accessing the GitHub Enterprise Server administrative shell (SSH)][3] for instructions.
4. Run `bin/ghe-host-check` to verify SSH connectivity with the GitHub
appliance.
Expand All @@ -37,5 +37,4 @@
[1]: https://github.com/github/backup-utils/releases
[2]: https://github.com/github/backup-utils/releases/tag/v2.11.4
[3]: https://github.com/github/enterprise-backup-site/blob/master/backup.config-example
[4]: https://docs.github.com/enterprise-server/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh
[3]: https://docs.github.com/enterprise-server/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh

0 comments on commit 8d0d11d

Please sign in to comment.