Commit ddcf0dd4 authored by Stan Hu's avatar Stan Hu Committed by Mike Jang

Document OmniAuth provider names in a table

parent 09940835
...@@ -22,40 +22,50 @@ of the configured mechanisms. ...@@ -22,40 +22,50 @@ of the configured mechanisms.
## Supported Providers ## Supported Providers
This is a list of the current supported OmniAuth providers. Before proceeding This is a list of the current supported OmniAuth providers. Before proceeding on each provider's documentation,
on each provider's documentation, make sure to first read this document as it make sure to first read this document as it contains some settings that are common for all providers.
contains some settings that are common for all providers.
|Provider documentation |OmniAuth provider name |
- [GitHub](github.md) |-----------------------------------------------------------------|--------------------------|
- [Bitbucket](bitbucket.md) |[Atlassian Crowd](../administration/auth/crowd.md) |`crowd` |
- [GitLab.com](gitlab.md) |[Atlassian](../administration/auth/atlassian.md) |`atlassian_oauth2` |
- [Google](google.md) |[Auth0](auth0.md) |`auth0` |
- [Facebook](facebook.md) |[Authentiq](../administration/auth/authentiq.md) |`authentiq` |
- [Twitter](twitter.md) |[AWS Cognito](../administration/auth/cognito.md) |`cognito` |
- [Shibboleth](shibboleth.md) |[Azure v2](azure.md#microsoft-azure-oauth2-omniauth-provider-v2) |`azure_activedirectory_v2`|
- [SAML](saml.md) |[Azure v1](azure.md) |`azure_oauth2` |
- [Crowd](../administration/auth/crowd.md) |[Bitbucket Cloud](bitbucket.md) |`bitbucket` |
- [Azure](azure.md) |[CAS](cas.md) |`cas3` |
- [Auth0](auth0.md) |[Facebook](facebook.md) |`facebook` |
- [Authentiq](../administration/auth/authentiq.md) |[Generic OAuth2](oauth2_generic.md) |`oauth2_generic` |
- [OAuth2Generic](oauth2_generic.md) |[GitHub](github.md) |`github` |
- [JWT](../administration/auth/jwt.md) |[GitLab.com](gitlab.md) |`gitlab` |
- [OpenID Connect](../administration/auth/oidc.md) |[Google](google.md) |`google_oauth2` |
- [Salesforce](salesforce.md) |[JWT](../administration/auth/jwt.md) |`jwt` |
- [AWS Cognito](../administration/auth/cognito.md) |[Kerberos](kerberos.md) |`kerberos` |
|[OpenID Connect](../administration/auth/oidc.md) |`openid_connect` |
|[Salesforce](salesforce.md) |`salesforce` |
|[SAML](saml.md) |`saml` |
|[Shibboleth](shibboleth.md) |`shibboleth` |
|[Twitter](twitter.md) |`twitter` |
## Initial OmniAuth Configuration ## Initial OmniAuth Configuration
Before configuring individual OmniAuth providers there are a few global settings The OmniAuth provider names from the table above are needed to configure a few global settings that are in common for all providers.
that are in common for all providers that we need to consider.
NOTE: NOTE:
Starting from GitLab 11.4, OmniAuth is enabled by default. If you're using an Starting from GitLab 11.4, OmniAuth is enabled by default. If you're using an
earlier version, you must explicitly enable it. earlier version, you must explicitly enable it.
- `allow_single_sign_on` allows you to specify the providers you want to allow to - `allow_single_sign_on` allows you to specify the providers that automatically
automatically create an account. It defaults to `false`. If `false` users must create a GitLab account. For example, if you wish to enable Azure (v2) and Google,
be created manually or they can't sign in by using OmniAuth. in Omnibus, specify a list of provider names:
```ruby
gitlab_rails['omniauth_allow_single_sign_on'] = ['azure_activedirectory_v2', 'google_oauth2']
```
The value defaults to `false`. If `false` users must be created manually, or they can't sign in by using OmniAuth.
- `auto_link_ldap_user` can be used if you have [LDAP / ActiveDirectory](../administration/auth/ldap/index.md) - `auto_link_ldap_user` can be used if you have [LDAP / ActiveDirectory](../administration/auth/ldap/index.md)
integration enabled. It defaults to `false`. When enabled, users automatically integration enabled. It defaults to `false`. When enabled, users automatically
created through an OmniAuth provider have their LDAP identity created in GitLab as well. created through an OmniAuth provider have their LDAP identity created in GitLab as well.
...@@ -325,20 +335,20 @@ You can add the `auto_sign_in_with_provider` setting to your GitLab ...@@ -325,20 +335,20 @@ You can add the `auto_sign_in_with_provider` setting to your GitLab
configuration to redirect login requests to your OmniAuth provider for configuration to redirect login requests to your OmniAuth provider for
authentication. This removes the need to click a button before actually signing in. authentication. This removes the need to click a button before actually signing in.
For example, when using the Azure integration, set the following to enable auto For example, when using the [Azure v2 integration](azure.md#microsoft-azure-oauth2-omniauth-provider-v2), set the following to enable auto
sign-in: sign-in:
For Omnibus package: For Omnibus package:
```ruby ```ruby
gitlab_rails['omniauth_auto_sign_in_with_provider'] = 'azure_oauth2' gitlab_rails['omniauth_auto_sign_in_with_provider'] = 'azure_activedirectory_v2'
``` ```
For installations from source: For installations from source:
```yaml ```yaml
omniauth: omniauth:
auto_sign_in_with_provider: azure_oauth2 auto_sign_in_with_provider: azure_activedirectory_v2
``` ```
Keep in mind that every sign-in attempt is redirected to the OmniAuth Keep in mind that every sign-in attempt is redirected to the OmniAuth
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment