diff options
author | Blair Lunceford <blunceford@gitlab.com> | 2019-09-08 23:41:54 +0000 |
---|---|---|
committer | Evan Read <eread@gitlab.com> | 2019-09-08 23:41:54 +0000 |
commit | b2ae3fdb8570591b218f3c27d7bdfc18a3ed9ace (patch) | |
tree | 11f6cfc21d560abd7c5654cc1692f89b1e1c1781 | |
parent | 2c413522565bf323383211478ece390f84786420 (diff) | |
download | gitlab-ce-b2ae3fdb8570591b218f3c27d7bdfc18a3ed9ace.tar.gz |
Add auto_sign_in_with_provider info to OmniAuth doc
-rw-r--r-- | doc/integration/omniauth.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/integration/omniauth.md b/doc/integration/omniauth.md index ef319f7f0ce..f1456146032 100644 --- a/doc/integration/omniauth.md +++ b/doc/integration/omniauth.md @@ -298,3 +298,33 @@ gitlab_rails['omniauth_allow_bypass_two_factor'] = ['twitter', 'google_oauth2'] omniauth: allow_bypass_two_factor: ['twitter', 'google_oauth2'] ``` + +## Automatically sign in with provider + +You can add the `auto_sign_in_with_provider` setting to your +GitLab configuration to automatically redirect login requests +to your OmniAuth provider for authentication, thus removing the need to click a button +before actually signing in. + +For example, when using the Azure integration, you would set the following +to enable auto sign in. + +For Omnibus package: + +```ruby +gitlab_rails['omniauth_auto_sign_in_with_provider'] = 'azure_oauth2' +``` + +For installations from source: + +```yaml +omniauth: + auto_sign_in_with_provider: azure_oauth2 +``` + +Please keep in mind that every sign in attempt will be redirected to the OmniAuth provider, +so you will not be able to sign in using local credentials. Make sure that at least one +of the OmniAuth users has admin permissions. + +You may also bypass the auto signin feature by browsing to +`https://gitlab.example.com/users/sign_in?auto_sign_in=false`. |