debian-mirror-gitlab/doc/integration/twitter.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

104 lines
3.4 KiB
Markdown
Raw Normal View History

2021-01-29 00:20:46 +05:30
---
2022-07-16 23:28:13 +05:30
stage: Manage
group: Authentication and Authorization
2022-11-25 23:54:43 +05:30
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
2021-01-29 00:20:46 +05:30
---
2022-08-13 15:12:31 +05:30
# Twitter OAuth 1.0a OmniAuth Provider **(FREE SELF)**
NOTE:
2022-11-25 23:54:43 +05:30
Twitter OAuth 2.0 support is [not supported](https://gitlab.com/gitlab-org/gitlab/-/issues/366213).
2014-09-02 18:07:02 +05:30
2021-11-11 11:23:49 +05:30
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.
2014-09-02 18:07:02 +05:30
2022-11-25 23:54:43 +05:30
## Create a new Twitter application
2022-08-27 11:52:29 +05:30
1. Sign in to [Twitter Application Management](https://developer.twitter.com/apps).
2014-09-02 18:07:02 +05:30
2022-11-25 23:54:43 +05:30
1. Select **Create new app**.
2014-09-02 18:07:02 +05:30
2019-09-30 21:07:59 +05:30
1. Fill in the application details.
2022-11-25 23:54:43 +05:30
- **Name**: This can be anything. Consider something like `<Organization>'s GitLab`, `<Your Name>'s GitLab` or
2019-09-30 21:07:59 +05:30
something else descriptive.
2022-11-25 23:54:43 +05:30
- **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**.
2014-09-02 18:07:02 +05:30
2019-09-30 21:07:59 +05:30
![Twitter App Details](img/twitter_app_details.png)
2014-09-02 18:07:02 +05:30
2022-11-25 23:54:43 +05:30
1. Select **Create your Twitter application**.
## Configure the application settings
2014-09-02 18:07:02 +05:30
2022-11-25 23:54:43 +05:30
1. Select the **Settings** tab.
2014-09-02 18:07:02 +05:30
2022-11-25 23:54:43 +05:30
1. Underneath the **Callback URL**, select the **Allow this application to be used to Sign in with Twitter** checkbox.
2014-09-02 18:07:02 +05:30
2022-11-25 23:54:43 +05:30
1. Select **Update settings** to save the changes.
2014-09-02 18:07:02 +05:30
2022-11-25 23:54:43 +05:30
1. Select the **Keys and Access Tokens** tab.
2014-09-02 18:07:02 +05:30
2022-11-25 23:54:43 +05:30
1. Find your **API key** and **API secret**. Keep this tab open as you continue configuration.
2014-09-02 18:07:02 +05:30
2019-09-30 21:07:59 +05:30
![Twitter app](img/twitter_app_api_keys.png)
2014-09-02 18:07:02 +05:30
2022-11-25 23:54:43 +05:30
## Configure your application on the GitLab server
2019-09-30 21:07:59 +05:30
1. On your GitLab server, open the configuration file.
2015-04-26 12:48:37 +05:30
2019-12-04 20:38:33 +05:30
For Omnibus package:
2015-04-26 12:48:37 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-09-30 21:07:59 +05:30
sudo editor /etc/gitlab/gitlab.rb
```
2015-04-26 12:48:37 +05:30
2019-09-30 21:07:59 +05:30
For installations from source:
2014-09-02 18:07:02 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-09-30 21:07:59 +05:30
cd /home/git/gitlab
2014-09-02 18:07:02 +05:30
2019-09-30 21:07:59 +05:30
sudo -u git -H editor config/gitlab.yml
```
2015-04-26 12:48:37 +05:30
2021-12-11 22:18:48 +05:30
1. See [Configure initial settings](omniauth.md#configure-initial-settings) for initial settings.
2015-04-26 12:48:37 +05:30
2022-11-25 23:54:43 +05:30
1. Add the provider configuration.
2015-04-26 12:48:37 +05:30
2019-12-04 20:38:33 +05:30
For Omnibus package:
2014-09-02 18:07:02 +05:30
2019-09-30 21:07:59 +05:30
```ruby
gitlab_rails['omniauth_providers'] = [
{
2022-01-26 12:08:38 +05:30
name: "twitter",
# label: "Provider name", # optional label for login button, defaults to "Twitter"
2022-11-25 23:54:43 +05:30
app_id: "<your_api_key>",
app_secret: "<your_api_secret>"
2019-09-30 21:07:59 +05:30
}
]
```
2014-09-02 18:07:02 +05:30
2019-09-30 21:07:59 +05:30
For installations from source:
2014-09-02 18:07:02 +05:30
2020-04-08 14:13:33 +05:30
```yaml
2021-01-03 14:25:43 +05:30
- { name: 'twitter',
2022-01-26 12:08:38 +05:30
# label: 'Provider name', # optional label for login button, defaults to "Twitter"
2022-11-25 23:54:43 +05:30
app_id: '<your_api_key>',
app_secret: '<your_api_secret>' }
2019-09-30 21:07:59 +05:30
```
2014-09-02 18:07:02 +05:30
2022-11-25 23:54:43 +05:30
1. Change `<your_api_key>` to the API key from the Twitter **Keys and Access Tokens** tab.
2014-09-02 18:07:02 +05:30
2022-11-25 23:54:43 +05:30
1. Change `<your_api_secret>` to the API secret from the Twitter **Keys and Access Tokens** tab.
2014-09-02 18:07:02 +05:30
2019-09-30 21:07:59 +05:30
1. Save the configuration file.
2022-11-25 23:54:43 +05:30
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).
2014-09-02 18:07:02 +05:30
2022-11-25 23:54:43 +05:30
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.