debian-mirror-gitlab/doc/integration/github.md

179 lines
6.4 KiB
Markdown
Raw Normal View History

2019-02-15 15:39:39 +05:30
# Integrate your GitLab instance with GitHub
2014-09-02 18:07:02 +05:30
2019-02-15 15:39:39 +05:30
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.
2015-04-26 12:48:37 +05:30
2019-02-15 15:39:39 +05:30
## Enabling GitHub OAuth
2014-09-02 18:07:02 +05:30
2020-03-13 15:44:24 +05:30
To enable the GitHub OmniAuth provider, you'll need an OAuth 2 Client ID and Client Secret from GitHub. To get these credentials, sign into GitHub and follow their procedure for [Creating an OAuth App](https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/).
2014-09-02 18:07:02 +05:30
2020-03-13 15:44:24 +05:30
When you create an OAuth 2 app in GitHub, you'll need the following information:
2019-01-03 12:48:30 +05:30
2020-03-13 15:44:24 +05:30
- The URL of your GitLab instance, such as `https://gitlab.example.com`.
- The authorization callback URL; in this case, `https://gitlab.example.com/users/auth`. Include the port number if your GitLab instance uses a non-default port.
2016-06-02 11:05:42 +05:30
2020-03-13 15:44:24 +05:30
NOTE: **Note:**
To prevent an [OAuth2 covert redirect](http://tetraph.com/covert_redirect/) vulnerability, append `/users/auth` to the end of the GitHub authorization callback URL.
2014-09-02 18:07:02 +05:30
2020-03-13 15:44:24 +05:30
See [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration) for initial settings.
2014-09-02 18:07:02 +05:30
2020-03-13 15:44:24 +05:30
Once you have configured the GitHub provider, you'll need the following information, which you'll need to substitute in the GitLab configuration file, in the steps shown next.
2014-09-02 18:07:02 +05:30
2020-03-13 15:44:24 +05:30
| Setting from GitHub | Substitute in the GitLab configuration file | Description |
|:---------------------|:-----------------------------------------------|:------------|
| Client ID | `YOUR_APP_ID` | OAuth 2 Client ID |
| Client Secret | `YOUR_APP_SECRET` | OAuth 2 Client Secret |
| URL | `https://github.example.com/` | GitHub Deployment URL |
2019-02-02 18:00:53 +05:30
2020-03-13 15:44:24 +05:30
Follow these steps to incorporate the GitHub OAuth 2 app in your GitLab server:
2019-02-02 18:00:53 +05:30
2020-03-13 15:44:24 +05:30
**For Omnibus installations**
2014-09-02 18:07:02 +05:30
2020-03-13 15:44:24 +05:30
1. Edit `/etc/gitlab/gitlab.rb`:
2015-04-26 12:48:37 +05:30
2019-09-30 21:07:59 +05:30
For GitHub.com:
2017-08-17 22:00:37 +05:30
2019-09-30 21:07:59 +05:30
```ruby
gitlab_rails['omniauth_providers'] = [
{
"name" => "github",
"app_id" => "YOUR_APP_ID",
"app_secret" => "YOUR_APP_SECRET",
"args" => { "scope" => "user:email" }
}
]
```
2017-08-17 22:00:37 +05:30
2019-09-30 21:07:59 +05:30
For GitHub Enterprise:
2017-08-17 22:00:37 +05:30
2019-09-30 21:07:59 +05:30
```ruby
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" }
}
]
```
2014-09-02 18:07:02 +05:30
2020-03-13 15:44:24 +05:30
**Replace `https://github.example.com/` with your GitHub URL.**
1. Save the file and [reconfigure](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) GitLab for the changes to take effect.
---
**For installations from source**
1. Navigate to your repository and edit `config/gitlab.yml`:
2014-09-02 18:07:02 +05:30
2019-09-30 21:07:59 +05:30
For GitHub.com:
2016-06-02 11:05:42 +05:30
2019-09-30 21:07:59 +05:30
```
- { name: 'github', app_id: 'YOUR_APP_ID',
app_secret: 'YOUR_APP_SECRET',
args: { scope: 'user:email' } }
```
2014-09-02 18:07:02 +05:30
2019-09-30 21:07:59 +05:30
For GitHub Enterprise:
2016-06-02 11:05:42 +05:30
2019-09-30 21:07:59 +05:30
```
- { name: 'github', app_id: 'YOUR_APP_ID',
app_secret: 'YOUR_APP_SECRET',
url: "https://github.example.com/",
args: { scope: 'user:email' } }
```
2016-06-02 11:05:42 +05:30
2020-03-13 15:44:24 +05:30
**Replace `https://github.example.com/` with your GitHub URL.**
2014-09-02 18:07:02 +05:30
2020-03-13 15:44:24 +05:30
1. Save the file and [restart](../administration/restart_gitlab.md#installations-from-source) GitLab for the changes to take effect.
2014-09-02 18:07:02 +05:30
2020-03-13 15:44:24 +05:30
---
2014-09-02 18:07:02 +05:30
2020-03-13 15:44:24 +05:30
1. Refresh the GitLab sign in page. You should now see a GitHub icon below the regular sign in form.
2014-09-02 18:07:02 +05:30
2020-03-13 15:44:24 +05:30
1. Click the icon to begin the authentication process. GitHub will ask the user to sign in and authorize the GitLab application.
2017-08-17 22:00:37 +05:30
2018-11-08 19:23:39 +05:30
## GitHub Enterprise with self-signed Certificate
2017-09-10 17:25:29 +05:30
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.
2019-12-04 20:38:33 +05:30
For Omnibus package:
2017-09-10 17:25:29 +05:30
```ruby
2019-09-30 21:07:59 +05:30
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" }
}
]
2017-09-10 17:25:29 +05:30
```
You will also need to disable Git SSL verification on the server hosting GitLab.
```ruby
omnibus_gitconfig['system'] = { "http" => ["sslVerify = false"] }
```
For installation from source:
```
2019-09-30 21:07:59 +05:30
- { name: 'github', app_id: 'YOUR_APP_ID',
app_secret: 'YOUR_APP_SECRET',
url: "https://github.example.com/",
verify_ssl: false,
args: { scope: 'user:email' } }
2017-09-10 17:25:29 +05:30
```
You will also need to disable Git SSL verification on the server hosting GitLab.
```
2019-12-04 20:38:33 +05:30
git config --global http.sslVerify false
2017-09-10 17:25:29 +05:30
```
2018-12-05 23:21:45 +05:30
For the changes to take effect, [reconfigure GitLab] if you installed
2017-09-10 17:25:29 +05:30
via Omnibus, or [restart GitLab] if you installed from source.
[reconfigure GitLab]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure
2017-08-17 22:00:37 +05:30
[restart GitLab]: ../administration/restart_gitlab.md#installations-from-source
2020-01-01 13:55:28 +05:30
## Troubleshooting
### Error 500 when trying to sign in to GitLab via GitHub Enterprise
Check the [`production.log`](../administration/logs.md#productionlog)
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](https://docs.gitlab.com/omnibus/maintenance/#starting-a-rails-console-session)
and run the commands below replacing `<github_url>` with the URL of your GitHub Enterprise instance:
```ruby
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**.
1. Under the "Social sign-in" section, click **Connect** near the GitHub icon.
After that, you should be able to sign in via GitHub successfully.