gitlab-org--gitlab-foss/doc/integration/github.md

Integrate your GitLab instance with GitHub

You can integrate your GitLab instance with GitHub.com as well as GitHub Enterprise to enable users to import projects from GitHub and/or to login to your GitLab instance with your GitHub account.

Enabling GitHub OAuth

To enable GitHub OmniAuth provider, you must use GitHub's credentials for your GitLab instance. To get the credentials (a pair of Client ID and Client Secret), you must register an application as an OAuth App on GitHub.

1. Sign in to GitHub.

2. Navigate to your individual user or organization settings, depending on how you want the application registered. It does not matter if the application is registered as an individual or an organization - that is entirely up to you.

   • For individual accounts, select Developer settings from the left menu, then select OAuth Apps.
   • For organization accounts, directly select OAuth Apps from the left menu.

3. Select Register an application (if you don't have any OAuth App) or New OAuth App (if you already have OAuth Apps).

4. Provide the required details.

   • Application name: This can be anything. Consider something like <Organization>'s GitLab or <Your Name>'s GitLab or something else descriptive.
   • Homepage URL: The URL of your GitLab installation. For example, https://gitlab.example.com.
   • Application description: Fill this in if you wish.
   • Authorization callback URL: http(s)://${YOUR_DOMAIN}/users/auth. Please make sure the port is included if your GitLab instance is not configured on default port.

   NOTE: Be sure to append /users/auth to the end of the callback URL to prevent a OAuth2 convert redirect vulnerability.

5. Select Register application.

6. You should now see a pair of Client ID and Client Secret near the top right of the page (see screenshot). Keep this page open as you continue configuration.

7. On your GitLab server, open the configuration file.

   For Omnibus package:

   sudo editor /etc/gitlab/gitlab.rb
   

   For installations from source:

   cd /home/git/gitlab
   
   sudo -u git -H editor config/gitlab.yml
   

8. See Initial OmniAuth Configuration for initial settings.

9. Add the provider configuration:

   For Omnibus package:

   For GitHub.com:

   gitlab_rails['omniauth_providers'] = [
     {
       "name" => "github",
       "app_id" => "YOUR_APP_ID",
       "app_secret" => "YOUR_APP_SECRET",
       "args" => { "scope" => "user:email" }
     }
   ]
   

   For GitHub Enterprise:

   gitlab_rails['omniauth_providers'] = [
     {
       "name" => "github",
       "app_id" => "YOUR_APP_ID",
       "app_secret" => "YOUR_APP_SECRET",
       "url" => "https://github.example.com/",
       "args" => { "scope" => "user:email" }
     }
   ]
   

   For installation from source:

   For GitHub.com:

   - { name: 'github', app_id: 'YOUR_APP_ID',
     app_secret: 'YOUR_APP_SECRET',
     args: { scope: 'user:email' } }
   

   For GitHub Enterprise:

   - { name: 'github', app_id: 'YOUR_APP_ID',
     app_secret: 'YOUR_APP_SECRET',
     url: "https://github.example.com/",
     args: { scope: 'user:email' } }
   

   Replace https://github.example.com/ with your GitHub URL.

10. Change YOUR_APP_ID to the Client ID from the GitHub application page from step 6.

11. Change YOUR_APP_SECRET to the Client Secret from the GitHub application page from step 6.

12. Save the configuration file.

13. Reconfigure GitLab or restart GitLab for the changes to take effect if you installed GitLab via Omnibus or from source respectively.

On the sign in page there should now be a GitHub icon below the regular sign in form. Click the icon to begin the authentication process. GitHub will ask the user to sign in and authorize the GitLab application. If everything goes well the user will be returned to GitLab and will be signed in.

GitHub Enterprise with self-signed Certificate

If you are attempting to import projects from GitHub Enterprise with a self-signed certificate and the imports are failing, you will need to disable SSL verification. It should be disabled by adding verify_ssl to false in the provider configuration and changing the global Git sslVerify option to false in the GitLab server.

For Omnibus package:

gitlab_rails['omniauth_providers'] = [
  {
    "name" => "github",
    "app_id" => "YOUR_APP_ID",
    "app_secret" => "YOUR_APP_SECRET",
    "url" => "https://github.example.com/",
    "verify_ssl" => false,
    "args" => { "scope" => "user:email" }
  }
]

You will also need to disable Git SSL verification on the server hosting GitLab.

omnibus_gitconfig['system'] = { "http" => ["sslVerify = false"] }

For installation from source:

- { name: 'github', app_id: 'YOUR_APP_ID',
  app_secret: 'YOUR_APP_SECRET',
  url: "https://github.example.com/",
  verify_ssl: false,
  args: { scope: 'user:email' } }

You will also need to disable Git SSL verification on the server hosting GitLab.

git config --global http.sslVerify false

For the changes to take effect, reconfigure GitLab if you installed via Omnibus, or restart GitLab if you installed from source.

Troubleshooting

Error 500 when trying to sign in to GitLab via GitHub Enterprise

Check the production.log on your GitLab server to obtain further details. If you are getting the error like Faraday::ConnectionFailed (execution expired) in the log, there may be a connectivity issue between your GitLab instance and GitHub Enterprise. To verify it, start the rails console and run the commands below replacing <github_url> with the URL of your GitHub Enterprise instance:

uri = URI.parse("https://<github_url>") # replace `GitHub-URL` with the real one here
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
http.verify_mode = 1
response = http.request(Net::HTTP::Get.new(uri.request_uri))

If you are getting a similar execution expired error, it confirms the theory about the network connectivity. In that case, make sure that the GitLab server is able to reach your GitHub enterprise instance.

Signing in using your GitHub account without a pre-existing GitLab account is not allowed

If you're getting the message Signing in using your GitHub account without a pre-existing GitLab account is not allowed. Create a GitLab account first, and then connect it to your GitHub account when signing in, in GitLab:

1. Go to your Profile > Account.
2. Under the "Social sign-in" section, click Connect near the GitHub icon.

After that, you should be able to sign in via GitHub successfully.