Skip to content

Commit 5d3c1d0

Browse files
committed
Merge pull request #81 from github/readme-2.0-notes
Light README updates for GitHub Enterprise v2.0
2 parents c025e0e + 881e221 commit 5d3c1d0

1 file changed

Lines changed: 21 additions & 7 deletions

File tree

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ This repository includes backup and recovery utilities for [GitHub Enterprise][1
99
- **[Storage requirements](#storage-requirements)**
1010
- **[GitHub Enterprise version requirements](#github-enterprise-version-requirements)**
1111
- **[Getting started](#getting-started)**
12+
- **[Migrating from GitHub Enterprise v11.10.34x to v2.0](#migrating-from-github-enterprise-v111034x-to-v20)**
1213
- **[Using the backup and restore commands](#using-the-backup-and-restore-commands)**
1314
- **[Scheduling backups](#scheduling-backups)**
1415
- **[Backup snapshot file structure](#backup-snapshot-file-structure)**
@@ -57,8 +58,12 @@ and growth over time.
5758

5859
##### GitHub Enterprise version requirements
5960

60-
For online and incremental backup support, the GitHub Enterprise instance must
61-
be running version 11.10.342 or above.
61+
The backup utilities are fully supported under GitHub Enterprise 2.0 or
62+
greater.
63+
64+
The previous release series (11.10.34x) is also supported but must meet minimum
65+
version requirements. For online and incremental backup support, the GitHub
66+
Enterprise instance must be running version 11.10.342 or above.
6267

6368
Earlier versions are supported, but online and incremental backups are not
6469
supported. We strongly recommend upgrading to the latest release if you're
@@ -87,15 +92,22 @@ download the most recent GitHub Enterprise version.
8792

8893
[release]: https://github.com/github/backup-utils/releases
8994

95+
### Migrating from GitHub Enterprise v11.10.34x to v2.0
96+
97+
If you are migrating from GitHub Enterprise version 11.10.34x to 2.0 or greater,
98+
please see the [Migrating from GitHub Enterprise v11.10.34x][10] documentation
99+
in the [GitHub Enterprise System Administrator's Guide][11]. It includes
100+
important information on using the backup utilities to migrate data from your
101+
v11.10.34x instance to v2.0.
102+
90103
### Using the backup and restore commands
91104

92105
After the initial backup, use the following commands:
93106

94107
- The `ghe-backup` command creates incremental snapshots of repository data,
95108
along with full snapshots of all other pertinent data stores.
96109
- The `ghe-restore` command restores snapshots to the same or separate GitHub
97-
Enterprise appliance. If you are restoring to a separate appliance, follow
98-
the steps in [Migrating GitHub Enterprise][10].
110+
Enterprise appliance.
99111

100112
##### Example backup and restore usage
101113

@@ -133,8 +145,9 @@ appliance at IP "5.5.5.5":
133145
Restoring SSH host keys ...
134146
Completed restore of 5.5.5.5 from snapshot 20140817T174152
135147
Visit https://5.5.5.5/setup/settings to configure the recovered appliance.
136-
137-
Any backup can be applied using the `-s` argument and the datestamp-named directory from the backup location.
148+
149+
A different backup snapshot may be selected by passing the `-s` argument and the
150+
datestamp-named directory from the backup location.
138151

139152
The `ghe-backup` and `ghe-restore` commands also have a verbose output mode
140153
(`-v`) that lists files as they're being transferred. It's often useful to
@@ -229,4 +242,5 @@ site setup or recovery, please contact our [Enterprise support team][7] instead.
229242
[7]: https://enterprise.github.com/support/
230243
[8]: https://enterprise.github.com/help/articles/backing-up-enterprise-data
231244
[9]: https://enterprise.github.com/help/articles/restoring-enterprise-data
232-
[10]: https://enterprise.github.com/help/articles/migrating-github-enterprise
245+
[10]: https://help.github.com/enterprise/2.0/admin-guide/migrating/
246+
[11]: https://help.github.com/enterprise/2.0/admin-guide/

0 commit comments

Comments
 (0)