Skip to content

Commit 43020ae

Browse files
Added details on how to skip disk and software preflight checks
1 parent 8186e71 commit 43020ae

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

docs/usage.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,13 +73,18 @@ appliance at IP "5.5.5.5":
7373
Restore of 5.5.5.5:122 from snapshot 20180326T020444 finished.
7474
To complete the restore process, please visit https://5.5.5.5/setup/settings to review and save the appliance configuration.
7575

76-
A different backup snapshot may be selected by passing the `-s` argument and the
77-
datestamp-named directory from the backup location.
76+
A different backup snapshot may be selected by passing the `-s` argument to `ghe-restore` and specifcying the
77+
datestamp-named directory from the backup location as the value.
7878

7979
The `ghe-backup` and `ghe-restore` commands also have a verbose output mode
8080
(`-v`) that lists files as they're being transferred. It's often useful to
8181
enable when output is logged to a file.
8282

83+
Every time you execute `ghe-backup` we verify the storage and software setup of the host
84+
you [installed][1] Backup Utilities on, to make sure our [requirements][2] for the host are
85+
met. You can disable this check using the `--skip-checks` argument or by
86+
adding `GHE_SKIP_CHECKS=true` to your configuration file.
87+
8388
### Restoring settings, TLS certificate, and license
8489

8590
When restoring to a new GitHub Enterprise Server instance, settings, certificate, and
@@ -107,3 +112,4 @@ GitHub Actions enabled, the following steps are required:
107112
Please refer to [GHES Documentation](https://docs.github.com/en/enterprise-server/admin/github-actions/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled) for more details.
108113

109114
[1]: https://github.com/github/backup-utils/blob/master/docs/getting-started.md
115+
[2]: requirements.md

0 commit comments

Comments
 (0)