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

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

Integrate your server with GitLab.com

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. On the upper right corner, click on your avatar and go to your Settings.

3. Select Applications in the left menu.

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

5. Select Save application.

6. You should now see an Application ID and Secret. 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:

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

   For installations from source:

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

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

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

12. Save the configuration file.

13. Reconfigure 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 GitLab.com icon below the regular sign in form. Click 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.