twitter.md 2.76 KB
Newer Older
Drew Blessing's avatar
Drew Blessing committed
1 2
# Twitter OAuth2 OmniAuth Provider

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

5
1.  Sign in to [Twitter Application Management](https://apps.twitter.com/).
6 7 8 9

1.  Select "Create new app"

1.  Fill in the application details.
10
    - Name: This can be anything. Consider something like `<Organization>'s GitLab` or `<Your Name>'s GitLab` or
Drew Blessing's avatar
Drew Blessing committed
11
    something else descriptive.
12
    - Description: Create a description.
13 14
    - Website: The URL to your GitLab installation. `https://gitlab.example.com`
    - Callback URL: `https://gitlab.example.com/users/auth/twitter/callback`
15
    - Agree to the "Developer Agreement".
16

17
    ![Twitter App Details](img/twitter_app_details.png)
18 19 20 21
1.  Select "Create your Twitter application."

1.  Select the "Settings" tab.

22
1.  Underneath the Callback URL check the box next to "Allow this application to be used to Sign in with Twitter."
23 24 25

1.  Select "Update settings" at the bottom to save changes.

26
1.  Select the "Keys and Access Tokens" tab.
27 28 29

1.  You should now see an API key and API secret (see screenshot). Keep this page open as you continue configuration.

30
    ![Twitter app](img/twitter_app_api_keys.png)
31 32

1.  On your GitLab server, open the configuration file.
Drew Blessing's avatar
Drew Blessing committed
33

34 35 36 37 38 39
    For omnibus package:

    ```sh
      sudo editor /etc/gitlab/gitlab.rb
    ```

40
    For installations from source:
41

Drew Blessing's avatar
Drew Blessing committed
42
    ```sh
43
      cd /home/git/gitlab
Drew Blessing's avatar
Drew Blessing committed
44

45
      sudo -u git -H editor config/gitlab.yml
Drew Blessing's avatar
Drew Blessing committed
46 47
    ```

Douwe Maan's avatar
Douwe Maan committed
48
1.  See [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration) for initial settings.
49 50 51 52 53 54 55 56 57

1.  Add the provider configuration:

    For omnibus package:

    ```ruby
      gitlab_rails['omniauth_providers'] = [
        {
          "name" => "twitter",
Douwe Maan's avatar
Douwe Maan committed
58 59
          "app_id" => "YOUR_APP_ID",
          "app_secret" => "YOUR_APP_SECRET"
60 61 62
        }
      ]
    ```
63

64
    For installations from source:
Drew Blessing's avatar
Drew Blessing committed
65 66

    ```
Douwe Maan's avatar
Douwe Maan committed
67 68
      - { name: 'twitter', app_id: 'YOUR_APP_ID',
        app_secret: 'YOUR_APP_SECRET' }
Drew Blessing's avatar
Drew Blessing committed
69 70
    ```

Douwe Maan's avatar
Douwe Maan committed
71
1.  Change 'YOUR_APP_ID' to the API key from Twitter page in step 11.
72

Douwe Maan's avatar
Douwe Maan committed
73
1.  Change 'YOUR_APP_SECRET' to the API secret from the Twitter page in step 11.
74 75 76

1.  Save the configuration file.

77 78
1.  [Reconfigure][] or [restart GitLab][] for the changes to take effect if you
    installed GitLab via Omnibus or from source respectively.
Drew Blessing's avatar
Drew Blessing committed
79

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

[reconfigure]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure
83
[restart GitLab]: ../administration/restart_gitlab.md#installations-from-source