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. In the upper-right corner of any page, click the Account Settings icon. Account Settings icon

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

  4. In the left sidebar, click Applications. Sidebar organization applications

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

  6. Under 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. Register new application button

  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. Click Register application. Register application button

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

Step 2: Configure OAuth

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

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

  3. In the left sidebar, click Authentication. Authentication tab

  4. Under Authentication, select GitHub OAuth. GitHub OAuth option

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

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

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

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

  9. Wait for the configuration run to complete. Configuring your instance