diff options
Diffstat (limited to 'doc/integration/twitter.md')
| -rw-r--r-- | doc/integration/twitter.md | 58 |
1 files changed, 33 insertions, 25 deletions
diff --git a/doc/integration/twitter.md b/doc/integration/twitter.md index aa9014adc49..90fb63ff40a 100644 --- a/doc/integration/twitter.md +++ b/doc/integration/twitter.md @@ -1,45 +1,51 @@ --- stage: Manage group: Authentication and Authorization -info: 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 +info: 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 yet supported](https://gitlab.com/gitlab-org/gitlab/-/issues/366213). +Twitter OAuth 2.0 support is [not supported](https://gitlab.com/gitlab-org/gitlab/-/issues/366213). 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](https://developer.twitter.com/apps). -1. Select "Create new app". +1. Select **Create new app**. 1. Fill in the application details. - - Name: This can be anything. Consider something like `<Organization>'s GitLab` or `<Your Name>'s GitLab` or + - **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. `https://gitlab.example.com` - - Callback URL: `https://gitlab.example.com/users/auth/twitter/callback` - - Agree to the "Developer Agreement". + - **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**.  -1. Select "Create your Twitter application." +1. Select **Create your Twitter application**. + +## Configure the application settings -1. Select the "Settings" tab. +1. Select the **Settings** tab. -1. Underneath the Callback URL check the box next to "Allow this application to be used to Sign in with Twitter." +1. Underneath the **Callback URL**, select the **Allow this application to be used to Sign in with Twitter** checkbox. -1. Select "Update settings" at the bottom to save changes. +1. Select **Update settings** to save the changes. -1. Select the "Keys and Access Tokens" tab. +1. Select the **Keys and Access Tokens** tab. -1. You should now see an API key and API secret (see screenshot). Keep this page open as you continue configuration. +1. 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: @@ -58,7 +64,7 @@ Twitter. Twitter generates a client ID and secret key for you to use. 1. See [Configure initial settings](omniauth.md#configure-initial-settings) for initial settings. -1. Add the provider configuration: +1. Add the provider configuration. For Omnibus package: @@ -67,8 +73,8 @@ Twitter. Twitter generates a client ID and secret key for you to use. { name: "twitter", # label: "Provider name", # optional label for login button, defaults to "Twitter" - app_id: "YOUR_APP_ID", - app_secret: "YOUR_APP_SECRET" + app_id: "<your_api_key>", + app_secret: "<your_api_secret>" } ] ``` @@ -78,18 +84,20 @@ Twitter. Twitter generates a client ID and secret key for you to use. ```yaml - { name: 'twitter', # label: 'Provider name', # optional label for login button, defaults to "Twitter" - app_id: 'YOUR_APP_ID', - app_secret: 'YOUR_APP_SECRET' } + app_id: '<your_api_key>', + app_secret: '<your_api_secret>' } ``` -1. Change 'YOUR_APP_ID' to the API key from Twitter page in step 11. +1. Change `<your_api_key>` to the API key from the Twitter **Keys and Access Tokens** tab. -1. Change 'YOUR_APP_SECRET' to the API secret from the Twitter page in step 11. +1. Change `<your_api_secret>` to the API secret from the Twitter **Keys and Access Tokens** tab. 1. Save the configuration file. -1. For the changes to take effect: - - If you installed via Omnibus, [reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure). - - If you installed from source, [restart GitLab](../administration/restart_gitlab.md#installations-from-source). +1. For the changes to take effect, if you installed: + + - Using Omnibus, [reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure). + - From source, [restart GitLab](../administration/restart_gitlab.md#installations-from-source). -On the sign in page there should now be a Twitter icon below the regular sign in form. Select the icon to begin the authentication process. Twitter asks the user to sign in and authorize the GitLab application. If everything goes well the user is returned to GitLab and signed in. +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. |