diff options
| author | Drew Blessing <drew.blessing@me.com> | 2014-04-02 22:11:25 -0500 |
|---|---|---|
| committer | Drew Blessing <drew.blessing@me.com> | 2014-04-10 07:31:54 -0500 |
| commit | 728b05cab7f4bc87cbdc9d1ecb3d54f96ff24ce2 (patch) | |
| tree | 2f36d1c0a8aeec4c39fb130b4bf81a7affc63de9 /doc/integration/twitter.md | |
| parent | 03472b4fc02a256c90c0285765e7da82c56e93a2 (diff) | |
| download | gitlab-ce-728b05cab7f4bc87cbdc9d1ecb3d54f96ff24ce2.tar.gz | |
Add OmniAuth Documentation
Add GitHub OmniAuth docs
Google instructions
Google instructions
Merge master
Clean things up
Clean things up
Clean things up
Clean things up
Clean things up
Clean things up
Clean things up
Add Google and Twitter docs
Add screenshot
Add screenshot
Clean things up
Clean things up
Clean things up
Clean things up
Clean things up
Clean things up
Clean things up
Finalize current docs
Finalize current docs
Add existing user information
Add twitter
Add twitter
Add Twitter disclaimer
Add Twitter disclaimer
remove old doc
Remove unnecessary link
Revert omniauth provider format
Add OmniAuth Documentation
Add GitHub OmniAuth docs
Google instructions
Google instructions
Merge master
Clean things up
Clean things up
Clean things up
Clean things up
Clean things up
Clean things up
Clean things up
Add Google and Twitter docs
Add screenshot
Add screenshot
Clean things up
Clean things up
Clean things up
Clean things up
Clean things up
Clean things up
Clean things up
Finalize current docs
Finalize current docs
Add existing user information
Add twitter
Add twitter
Add Twitter disclaimer
Add Twitter disclaimer
remove old doc
Remove unnecessary link
Revert omniauth provider format
Use omniauth again
Remove notice
Restore whitespace
Slight changes
Diffstat (limited to 'doc/integration/twitter.md')
| -rw-r--r-- | doc/integration/twitter.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/integration/twitter.md b/doc/integration/twitter.md new file mode 100644 index 00000000000..0440e2f21f3 --- /dev/null +++ b/doc/integration/twitter.md @@ -0,0 +1,47 @@ +# Twitter OAuth2 OmniAuth Provider + +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. + +1. Sign in to [Twitter Developers](https://dev.twitter.com/) area. +2. Hover over the avatar in the top right corner and select "My applications." +3. Select "Create new app" +4. Fill in the application details. + * Name: This can be anything. Consider something like "\<Organization\>'s GitLab" or "\<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/github/callback' + * Agree to the "Rules of the Road." +  +6. Select "Create your Twitter application." +7. Select the "Settings" tab. +8. Underneath the Callback URL check the box next to "Allow this application to be used to Sign in the Twitter." +9. Select "Update settings" at the bottom to save changes. +10. Select the "API Keys" tab. +11. You should now see an API key and API secret (see screenshot). Keep this page open as you continue configuration. + +12. On your GitLab server, open the configuration file. + + ```sh + cd /home/git/gitlab + + sudo -u git -H editor config/gitlab.yml + ``` + +13. Find the section dealing with OmniAuth. See [Initial OmniAuth Configuration](README.md#initial-omniauth-configuration) +for more details. +14. Under `providers:` uncomment (or add) lines that look like the following: + + ``` + - { name: 'twitter', app_id: 'YOUR APP ID', + app_secret: 'YOUR APP SECRET' } + ``` + +15. Change 'YOUR APP ID' to the API key from Twitter page in step 11. +16. Change 'YOUR APP SECRET' to the API secret from the Twitter page in step 11. +17. Save the configuration file. +18. Restart GitLab for the changes to take effect. + +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. |