diff options
Diffstat (limited to 'doc/integration/github.md')
| -rw-r--r-- | doc/integration/github.md | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/integration/github.md b/doc/integration/github.md index 1f7b4f26476..df9a0db961b 100644 --- a/doc/integration/github.md +++ b/doc/integration/github.md @@ -4,7 +4,7 @@ group: Authentication and Authorization info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Use GitHub as an authentication provider **(FREE SELF)** +# Use GitHub as an OAuth 2.0 authentication provider **(FREE SELF)** You can integrate your GitLab instance with GitHub.com and GitHub Enterprise. You can import projects from GitHub, or sign in to GitLab @@ -47,7 +47,7 @@ your website could enable the covert redirect attack. | Client secret | `YOUR_APP_SECRET` | OAuth 2.0 client secret | | URL | `https://github.example.com/` | GitHub deployment URL | - - **For Omnibus installations** + - For Linux package installations: 1. Open the `/etc/gitlab/gitlab.rb` file. @@ -84,7 +84,7 @@ your website could enable the covert redirect attack. 1. Save the file and [reconfigure](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) GitLab. - - **For installations from source** + - For self-compiled installations: 1. Open the `config/gitlab.yml` file. @@ -110,7 +110,7 @@ your website could enable the covert redirect attack. args: { scope: 'user:email' } } ``` - 1. Save the file and [restart](../administration/restart_gitlab.md#installations-from-source) + 1. Save the file and [restart](../administration/restart_gitlab.md#self-compiled-installations) GitLab. 1. Refresh the GitLab sign-in page. A GitHub icon should display below the @@ -129,7 +129,7 @@ To fix this issue, you must disable SSL verification: 1. Set `verify_ssl` to `false` in the configuration file. - - **For Omnibus installations** + - For Linux package installations: ```ruby gitlab_rails['omniauth_providers'] = [ @@ -145,7 +145,7 @@ To fix this issue, you must disable SSL verification: ] ``` - - **For installations from source** + - For self-compiled installations: ```yaml - { name: 'github', @@ -159,7 +159,7 @@ To fix this issue, you must disable SSL verification: 1. Change the global Git `sslVerify` option to `false` on the GitLab server. - - **For Omnibus installations in [GitLab 15.3](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/6800) and later**: + - For Linux package installations running [GitLab 15.3](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/6800) and later: ```ruby gitaly['gitconfig'] = [ @@ -167,13 +167,13 @@ To fix this issue, you must disable SSL verification: ] ``` - - **For Omnibus installations in GitLab 15.2 and earlier (legacy method)**: + - For Linux package installations running GitLab 15.2 and earlier (legacy method): ```ruby omnibus_gitconfig['system'] = { "http" => ["sslVerify = false"] } ``` - - **For installations from source in [GitLab 15.3](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/6800) and later**, edit the Gitaly configuration (`gitaly.toml`): + - For self-compiled installations running [GitLab 15.3](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/6800) and later, edit the Gitaly configuration (`gitaly.toml`): ```toml [[git.config]] @@ -181,14 +181,14 @@ To fix this issue, you must disable SSL verification: value = "false" ``` - - **For installations from source in GitLab 15.2 and earlier (legacy method)**: + - For self-compiled installations running GitLab 15.2 and earlier (legacy method): ```shell git config --global http.sslVerify false ``` 1. [Reconfigure GitLab](../administration/restart_gitlab.md#reconfigure-a-linux-package-installation) - if you installed using the Linux package, or [restart GitLab](../administration/restart_gitlab.md#installations-from-source) + if you installed using the Linux package, or [restart GitLab](../administration/restart_gitlab.md#self-compiled-installations) if you self-compiled your installation. ### Signing in using GitHub Enterprise returns a 500 error |