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

Google OAuth2 OmniAuth Provider

To enable the Google OAuth2 OmniAuth provider you must register your application with Google. Google will generate a client ID and secret key for you to use.

1. Sign in to the Google Developers Console with the Google account you want to use to register GitLab.

2. Select "Create Project".

3. Provide the project information

   • Project name: 'GitLab' works just fine here.
   • Project ID: Must be unique to all Google Developer registered applications. Google provides a randomly generated Project ID by default. You can use the randomly generated ID or choose a new one.

4. Refresh the page. You should now see your new project in the list. Click on the project.

5. Select "APIs & auth" in the left menu.

6. Select "Credentials" in the submenu.

7. Select "Create New Client ID".

8. Fill in the required information

   • Application type: "Web Application"
   • Authorized JavaScript origins: This isn't really used by GitLab but go ahead and put 'https://gitlab.example.com' here.
   • Authorized redirect URI: 'https://gitlab.example.com/users/auth/google_oauth2/callback'

9. Under the heading "Client ID for web application" you should see a Client ID and Client secret (see screenshot). Keep this page open as you continue configuration.

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

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

11. Find the section dealing with OmniAuth. See Initial OmniAuth Configuration for more details.

12. Under providers: uncomment (or add) lines that look like the following:

           - { name: 'google_oauth2', app_id: 'YOUR APP ID',
             app_secret: 'YOUR APP SECRET',
             args: { access_type: 'offline', approval_prompt: '' } }
    

13. Change 'YOUR APP ID' to the client ID from the GitHub application page from step 7.

14. Change 'YOUR APP SECRET' to the client secret from the GitHub application page from step 7.

15. Save the configuration file.

16. Restart GitLab for the changes to take effect.

On the sign in page there should now be a Google icon below the regular sign in form. Click the icon to begin the authentication process. Google 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.

Further Configuration

This further configuration is not required for Google authentication to function but it is strongly recommended. Taking these steps will increase usability for users by providing a little more recognition and branding.

At this point, when users first try to authenticate to your GitLab installation with Google they will see a generic application name on the prompt screen. The prompt informs the user that "Project Default Service Account" would like to access their account. "Project Default Service Account" isn't very recognizable and may confuse or cause users to be concerned. This is easily changeable.

1. Select 'Consent screen' in the left menu. (See steps 1, 4 and 5 above for instructions on how to get here if you closed your window).
2. Scroll down until you find "Product Name". Change the product name to something more descriptive.
3. Add any additional information as you wish - homepage, logo, privacy policy, etc. None of this is required, but it may help your users.