You can configure GitHub Enterprise to use GitHub.com as an OAuth service.

For more details on how GitHub OAuth works, see "About GitHub OAuth."

Step 1: Register a new OAuth application

  1. On GitHub.com, sign into any account that is on the Owners team of your company's organization.

  2. Account Settings iconIn the upper-right corner of any page, click the Account Settings icon.

  3. Sidebar organization nameIn the left sidebar, click the name of your organization.

  4. Sidebar organization applicationsIn the left sidebar, click Applications.

  5. Register new application buttonAt the top of the page, under Organization applications, click Register new application.

  6. Register new application buttonUnder Application name, type the name that you would like to appear (e.g. your company's name or "GitHub Enterprise") when users authorize your GitHub Enterprise appliance to access their GitHub.com account information.

  7. Under Homepage URL, type the URL of your GitHub Enterprise appliance.

    http(s)://hostname
    
  8. Under Authorization callback URL, type the URL of your appliance followed by /auth/github_oauth/callback.

    http(s)://hostname/auth/github_oauth/callback
    
  9. Register application buttonClick Register application.

  10. Client ID and Client SecretNote the "Client ID" and "Client Secret" values that appear (you will need them later).

Step 2: Configure OAuth

  1. On your GitHub Enterprise appliance, access the Management Console.

  2. Settings tabAt the top of the page, click the Settings tab.

  3. Authentication tabIn the left sidebar, click Authentication.

  4. GitHub OAuth optionUnder Authentication, select GitHub OAuth.

  5. OAuth Client ID text fieldUnder OAuth Client ID, type the "Client ID" value for the OAuth application that you created above.

  6. OAuth Client Secret text fieldUnder OAuth Client Secret, type the "Client Secret" value for the OAuth application that you created above.

  7. Organization name text fieldUnder Organization name, type the name of your company's organization on GitHub.com.

  8. Save settingsAt the bottom of the page, click Save settings.

  9. Configuring your instanceWait for the configuration run to complete.