From 6d756b2b6a8cf470b3ba646048d3969889e55c94 Mon Sep 17 00:00:00 2001 From: Joe Marty Date: Fri, 10 Feb 2017 10:11:12 -0600 Subject: [PATCH] Fix spelling errors in docs and changelog --- .../26744-add-omniauth-oauth2-generic-strategy.yml | 2 +- doc/integration/oauth2_generic.md | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/changelogs/unreleased/26744-add-omniauth-oauth2-generic-strategy.yml b/changelogs/unreleased/26744-add-omniauth-oauth2-generic-strategy.yml index abf6c3b02c2..15da43b8091 100644 --- a/changelogs/unreleased/26744-add-omniauth-oauth2-generic-strategy.yml +++ b/changelogs/unreleased/26744-add-omniauth-oauth2-generic-strategy.yml @@ -1,3 +1,3 @@ -title: Add the omniaut-oauth2-generic OmniAuth strategy +title: Add the oauth2_generic OmniAuth strategy merge_request: 9048 author: Joe Marty \ No newline at end of file diff --git a/doc/integration/oauth2_generic.md b/doc/integration/oauth2_generic.md index 5ff63a56c3e..0661bc62d2d 100644 --- a/doc/integration/oauth2_generic.md +++ b/doc/integration/oauth2_generic.md @@ -1,22 +1,22 @@ -# Sign into Gitlab with (almost) any OAuth2 provider +# Sign into GitLab with (almost) any OAuth2 provider -The `omniauth-oauth2-generic` gem allows Single Sign On between Gitlab and your own OAuth2 provider +The `omniauth-oauth2-generic` gem allows Single Sign On between GitLab and your own OAuth2 provider (or any OAuth2 provider compatible with this gem) This strategy is designed to allow configuration of the simple OmniAuth SSO process outlined below: 1. Strategy directs client to your authorization URL (**configurable**), with specified ID and key 1. OAuth provider handles authentication of request, user, and (optionally) authorization to access user's profile -1. OAuth provider directs client back to Gitlab where Strategy handles retrieval of access token +1. OAuth provider directs client back to GitLab where Strategy handles retrieval of access token 1. Strategy requests user information from a **configurable** "user profile" URL (using the access token) 1. Strategy parses user information from the response, using a **configurable** format -1. Gitlab finds or creates the returned user and logs them in +1. GitLab finds or creates the returned user and logs them in ### Limitations of this Strategy: - It can only be used for Single Sign on, and will not provide any other access granted by any OAuth provider (importing projects or users, etc) -- It only supports the Authorization Grant flow (most common for client-server applications, like Gitlab) +- It only supports the Authorization Grant flow (most common for client-server applications, like GitLab) - It is not able to fetch user information from more than one URL - It has not been tested with user information formats other than JSON @@ -35,7 +35,7 @@ This strategy is designed to allow configuration of the simple OmniAuth SSO proc 1. On your GitLab server, open the configuration file. - For omnibus package: + For Omnibus package: ```sh sudo editor /etc/gitlab/gitlab.rb