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

stage	group	info
Manage	Authentication and Authorization	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

Twitter OAuth 1.0a OmniAuth Provider (FREE SELF)

NOTE: Twitter OAuth 2.0 support is not supported.

To enable the Twitter OmniAuth provider you must register your application with Twitter. Twitter generates a client ID and secret key for you to use.

Create a new Twitter application

1. Sign in to Twitter Application Management.

2. Select Create new app.

3. Fill in the application details.

   • Name: This can be anything. Consider something like <Organization>'s GitLab, <Your Name>'s GitLab or something else descriptive.
   • Description: Create a description.
   • Website: The URL to your GitLab installation. For example, https://gitlab.example.com
   • Callback URL: https://gitlab.example.com/users/auth/twitter/callback
   • Developer Agreement: Select Yes, I agree.

   

4. Select Create your Twitter application.

Configure the application settings

1. Select the Settings tab.

2. Underneath the Callback URL, select the Allow this application to be used to Sign in with Twitter checkbox.

3. Select Update settings to save the changes.

4. Select the Keys and Access Tokens tab.

5. Find your API key and API secret. Keep this tab open as you continue configuration.

   

Configure your application on the GitLab server

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

2. See Configure initial settings for initial settings.

3. Add the provider configuration.

   For Omnibus package:

     gitlab_rails['omniauth_providers'] = [
       {
         name: "twitter",
         # label: "Provider name", # optional label for login button, defaults to "Twitter"
         app_id: "<your_api_key>",
         app_secret: "<your_api_secret>"
       }
     ]
   

   For installations from source:

   - { name: 'twitter',
       # label: 'Provider name', # optional label for login button, defaults to "Twitter"
       app_id: '<your_api_key>',
       app_secret: '<your_api_secret>' }
   

4. Change <your_api_key> to the API key from the Twitter Keys and Access Tokens tab.

5. Change <your_api_secret> to the API secret from the Twitter Keys and Access Tokens tab.

6. Save the configuration file.

7. For the changes to take effect, if you installed:

   • Using Omnibus, reconfigure GitLab.
   • From source, restart GitLab.

On the sign-in page, find the Twitter option below the regular sign-in form. Select the option to begin the authentication process. Twitter asks you to sign in and authorize the GitLab application. After authorization, you are returned to GitLab and signed in.