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

stage	group	info
Ecosystem	Integrations	To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments

Integrate your server with GitLab.com (FREE SELF)

Import projects from GitLab.com and login to your GitLab instance with your GitLab.com account.

To enable the GitLab.com OmniAuth provider you must register your application with GitLab.com. GitLab.com generates an application ID and secret key for you to use.

1. Sign in to GitLab.com.

2. In the top-right corner, select your avatar.

3. Select Edit profile.

4. On the left sidebar, select Applications.

5. Provide the required details for Add new application.

   • Name: This can be anything. Consider something like <Organization>'s GitLab or <Your Name>'s GitLab or something else descriptive.
   • Redirect URI:

   http://your-gitlab.example.com/import/gitlab/callback
   http://your-gitlab.example.com/users/auth/gitlab/callback
   

   The first link is required for the importer and second for the authorization.

6. Select Save application.

7. You should now see an Application ID and Secret. Keep this page open as you continue configuration.

8. 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
   

9. See Configure initial settings for initial settings.

10. Add the provider configuration:

    For Omnibus installations authenticating against GitLab.com:

    gitlab_rails['omniauth_providers'] = [
      {
        "name" => "gitlab",
        "app_id" => "YOUR_APP_ID",
        "app_secret" => "YOUR_APP_SECRET",
        "args" => { "scope" => "api" }
      }
    ]
    

    Or, for Omnibus installations authenticating against a different GitLab instance:

    gitlab_rails['omniauth_providers'] = [
      {
        "name" => "gitlab",
        "app_id" => "YOUR_APP_ID",
        "app_secret" => "YOUR_APP_SECRET",
        "args" => { "scope" => "api", "client_options" => { "site" => "https://gitlab.example.com/api/v4" } }
      }
    ]
    

    For installations from source authenticating against GitLab.com:

    - { name: 'gitlab',
        app_id: 'YOUR_APP_ID',
        app_secret: 'YOUR_APP_SECRET',
        args: { scope: 'api' } }
    

    Or, for installations from source to authenticate against a different GitLab instance:

    - { name: 'gitlab',
        app_id: 'YOUR_APP_ID',
        app_secret: 'YOUR_APP_SECRET',
        args: { scope: 'api', "client_options": { "site": 'https://gitlab.example.com/api/v4' } }
    

11. Change 'YOUR_APP_ID' to the Application ID from the GitLab.com application page.

12. Change 'YOUR_APP_SECRET' to the secret from the GitLab.com application page.

13. Save the configuration file.

14. Based on how GitLab was installed, implement these changes by using the appropriate method:

    • Omnibus GitLab: reconfigure GitLab.
    • Source: restart GitLab.

On the sign-in page, there should now be a GitLab.com icon following the regular sign-in form. Select the icon to begin the authentication process. GitLab.com asks the user to sign in and authorize the GitLab application. If everything goes well, the user is returned to your GitLab instance and is signed in.