Commit e407b0fc authored by Suzanne Selhorn's avatar Suzanne Selhorn

Merge branch 'kpaizee-omniauth-ctrt-part-1' into 'master'

OmniAuth CTRT edits part 1

See merge request gitlab-org/gitlab!73870
parents 4372e59b a32e84e1
...@@ -41,7 +41,7 @@ To enable the Atlassian OmniAuth provider for passwordless authentication you mu ...@@ -41,7 +41,7 @@ To enable the Atlassian OmniAuth provider for passwordless authentication you mu
sudo -u git -H editor /home/git/gitlab/config/gitlab.yml sudo -u git -H editor /home/git/gitlab/config/gitlab.yml
``` ```
1. See [Initial OmniAuth Configuration](../../integration/omniauth.md#initial-omniauth-configuration) for initial settings to enable single sign-on and add `atlassian_oauth2` as an OAuth provider. 1. See [Configure initial settings](../../integration/omniauth.md#configure-initial-settings) for initial settings to enable single sign-on and add `atlassian_oauth2` as an OAuth provider.
1. Add the provider configuration for Atlassian: 1. Add the provider configuration for Atlassian:
For Omnibus GitLab installations: For Omnibus GitLab installations:
......
...@@ -27,7 +27,7 @@ Authentiq generates a Client ID and the accompanying Client Secret for you to us ...@@ -27,7 +27,7 @@ Authentiq generates a Client ID and the accompanying Client Secret for you to us
sudo -u git -H editor /home/git/gitlab/config/gitlab.yml sudo -u git -H editor /home/git/gitlab/config/gitlab.yml
``` ```
1. See [Initial OmniAuth Configuration](../../integration/omniauth.md#initial-omniauth-configuration) for initial settings to enable single sign-on and add Authentiq as an OAuth provider. 1. See [Configure initial settings](../../integration/omniauth.md#configure-initial-settings) for initial settings to enable single sign-on and add Authentiq as an OAuth provider.
1. Add the provider configuration for Authentiq: 1. Add the provider configuration for Authentiq:
......
...@@ -40,7 +40,7 @@ The following steps enable AWS Cognito as an authentication provider: ...@@ -40,7 +40,7 @@ The following steps enable AWS Cognito as an authentication provider:
## Configure GitLab ## Configure GitLab
1. See [Initial OmniAuth Configuration](../../integration/omniauth.md#initial-omniauth-configuration) for initial settings. 1. See [Configure initial settings](../../integration/omniauth.md#configure-initial-settings) for initial settings.
1. On your GitLab server, open the configuration file. 1. On your GitLab server, open the configuration file.
**For Omnibus installations** **For Omnibus installations**
...@@ -88,4 +88,4 @@ Your sign-in page should now display a Cognito button below the regular sign-in ...@@ -88,4 +88,4 @@ Your sign-in page should now display a Cognito button below the regular sign-in
To begin the authentication process, click the icon, and AWS Cognito asks the user to sign in and authorize the GitLab application. To begin the authentication process, click the icon, and AWS Cognito asks the user to sign in and authorize the GitLab application.
If successful, the user is redirected and signed in to your GitLab instance. If successful, the user is redirected and signed in to your GitLab instance.
For more information, see the [Initial OmniAuth Configuration](../../integration/omniauth.md#initial-omniauth-configuration). For more information, see [Configure initial settings](../../integration/omniauth.md#configure-initial-settings).
...@@ -36,7 +36,7 @@ this provider also allows Crowd authentication for Git-over-https requests. ...@@ -36,7 +36,7 @@ this provider also allows Crowd authentication for Git-over-https requests.
sudo -u git -H editor config/gitlab.yml sudo -u git -H editor config/gitlab.yml
``` ```
1. See [Initial OmniAuth Configuration](../../integration/omniauth.md#initial-omniauth-configuration) 1. See [Configure initial settings](../../integration/omniauth.md#configure-initial-settings)
for initial settings. for initial settings.
1. Add the provider configuration: 1. Add the provider configuration:
......
...@@ -25,7 +25,7 @@ JWT will provide you with a secret key for you to use. ...@@ -25,7 +25,7 @@ JWT will provide you with a secret key for you to use.
sudo -u git -H editor config/gitlab.yml sudo -u git -H editor config/gitlab.yml
``` ```
1. See [Initial OmniAuth Configuration](../../integration/omniauth.md#initial-omniauth-configuration) for initial settings. 1. See [Configure initial settings](../../integration/omniauth.md#configure-initial-settings) for initial settings.
1. Add the provider configuration. 1. Add the provider configuration.
For Omnibus GitLab: For Omnibus GitLab:
......
...@@ -27,7 +27,7 @@ The OpenID Connect provides you with a client's details and secret for you to us ...@@ -27,7 +27,7 @@ The OpenID Connect provides you with a client's details and secret for you to us
sudo -u git -H editor config/gitlab.yml sudo -u git -H editor config/gitlab.yml
``` ```
See [Initial OmniAuth Configuration](../../integration/omniauth.md#initial-omniauth-configuration) for initial settings. See [Configure initial settings](../../integration/omniauth.md#configure-initial-settings) for initial settings.
1. Add the provider configuration. 1. Add the provider configuration.
...@@ -228,7 +228,7 @@ Azure B2C [offers two ways of defining the business logic for logging in a user] ...@@ -228,7 +228,7 @@ Azure B2C [offers two ways of defining the business logic for logging in a user]
While cumbersome to configure, custom policies are required because While cumbersome to configure, custom policies are required because
standard Azure B2C user flows [do not send the OpenID `email` claim](https://github.com/MicrosoftDocs/azure-docs/issues/16566). In standard Azure B2C user flows [do not send the OpenID `email` claim](https://github.com/MicrosoftDocs/azure-docs/issues/16566). In
other words, they do not work with the [`allow_single_sign_on` or `auto_link_user` parameters](../../integration/omniauth.md#initial-omniauth-configuration). other words, they do not work with the [`allow_single_sign_on` or `auto_link_user` parameters](../../integration/omniauth.md#configure-initial-settings).
With a standard Azure B2C policy, GitLab cannot create a new account or With a standard Azure B2C policy, GitLab cannot create a new account or
link to an existing one with an email address. link to an existing one with an email address.
......
...@@ -48,7 +48,7 @@ application. ...@@ -48,7 +48,7 @@ application.
sudo -u git -H editor config/gitlab.yml sudo -u git -H editor config/gitlab.yml
``` ```
1. Read [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration) 1. Read [Configure initial settings](omniauth.md#configure-initial-settings)
for initial settings. for initial settings.
1. Add the provider configuration: 1. Add the provider configuration:
......
...@@ -48,7 +48,7 @@ As you go through the Microsoft procedure, keep the following in mind: ...@@ -48,7 +48,7 @@ As you go through the Microsoft procedure, keep the following in mind:
sudo -u git -H editor config/gitlab.yml sudo -u git -H editor config/gitlab.yml
``` ```
1. Refer to [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration) 1. Refer to [Configure initial settings](omniauth.md#configure-initial-settings)
for initial settings. for initial settings.
1. Add the provider configuration: 1. Add the provider configuration:
...@@ -154,7 +154,7 @@ After you have created an application, follow the [Microsoft Quickstart document ...@@ -154,7 +154,7 @@ After you have created an application, follow the [Microsoft Quickstart document
sudo -u git -H editor config/gitlab.yml sudo -u git -H editor config/gitlab.yml
``` ```
1. Refer to [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration) 1. Refer to [Configure initial settings](omniauth.md#configure-initial-settings)
for initial settings. for initial settings.
1. Add the provider configuration: 1. Add the provider configuration:
......
...@@ -28,7 +28,7 @@ configure CAS for back-channel logout. ...@@ -28,7 +28,7 @@ configure CAS for back-channel logout.
sudo -u git -H editor config/gitlab.yml sudo -u git -H editor config/gitlab.yml
``` ```
1. See [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration) for initial settings. 1. See [Configure initial settings](omniauth.md#configure-initial-settings) for initial settings.
1. Add the provider configuration: 1. Add the provider configuration:
......
...@@ -72,7 +72,7 @@ Facebook. Facebook generates an app ID and secret key for you to use. ...@@ -72,7 +72,7 @@ Facebook. Facebook generates an app ID and secret key for you to use.
sudo -u git -H editor config/gitlab.yml sudo -u git -H editor config/gitlab.yml
``` ```
1. See [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration) for initial settings. 1. See [Configure initial settings](omniauth.md#configure-initial-settings) for initial settings.
1. Add the provider configuration: 1. Add the provider configuration:
......
...@@ -29,7 +29,7 @@ When you create an OAuth 2 app in GitHub, you need the following information: ...@@ -29,7 +29,7 @@ When you create an OAuth 2 app in GitHub, you need the following information:
- The URL of your GitLab instance, such as `https://gitlab.example.com`. - The URL of your GitLab instance, such as `https://gitlab.example.com`.
- The authorization callback URL; in this case, `https://gitlab.example.com/users/auth`. Include the port number if your GitLab instance uses a non-default port. - The authorization callback URL; in this case, `https://gitlab.example.com/users/auth`. Include the port number if your GitLab instance uses a non-default port.
See [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration) for initial settings. See [Configure initial settings](omniauth.md#configure-initial-settings) for initial settings.
After you have configured the GitHub provider, you need the following information. You must substitute that information in the GitLab configuration file in these next steps. After you have configured the GitHub provider, you need the following information. You must substitute that information in the GitLab configuration file in these next steps.
......
...@@ -45,7 +45,7 @@ GitLab.com generates an application ID and secret key for you to use. ...@@ -45,7 +45,7 @@ GitLab.com generates an application ID and secret key for you to use.
sudo -u git -H editor config/gitlab.yml sudo -u git -H editor config/gitlab.yml
``` ```
1. See [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration) for initial settings. 1. See [Configure initial settings](omniauth.md#configure-initial-settings) for initial settings.
1. Add the provider configuration: 1. Add the provider configuration:
For Omnibus installations authenticating against **GitLab.com**: For Omnibus installations authenticating against **GitLab.com**:
......
...@@ -71,7 +71,7 @@ On your GitLab server: ...@@ -71,7 +71,7 @@ On your GitLab server:
sudo -u git -H editor config/gitlab.yml sudo -u git -H editor config/gitlab.yml
``` ```
1. See [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration) for initial settings. 1. See [Configure initial settings](omniauth.md#configure-initial-settings) for initial settings.
1. Add the provider configuration: 1. Add the provider configuration:
For Omnibus GitLab: For Omnibus GitLab:
......
...@@ -100,7 +100,7 @@ to authenticate with Kerberos tokens. ...@@ -100,7 +100,7 @@ to authenticate with Kerberos tokens.
#### Enable single sign-on #### Enable single sign-on
See [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration) See [Configure initial settings](omniauth.md#configure-initial-settings)
for initial settings to enable single sign-on and add Kerberos servers for initial settings to enable single sign-on and add Kerberos servers
as an identity provider. as an identity provider.
...@@ -137,7 +137,7 @@ with your Kerberos credentials. ...@@ -137,7 +137,7 @@ with your Kerberos credentials.
The first time users sign in to GitLab with their Kerberos accounts, The first time users sign in to GitLab with their Kerberos accounts,
GitLab creates a matching account. GitLab creates a matching account.
Before you continue, review the [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration) options in Omnibus and GitLab source. You must also include `kerberos`. Before you continue, review the [Configure initial settings](omniauth.md#configure-initial-settings) options in Omnibus and GitLab source. You must also include `kerberos`.
With that information at hand: With that information at hand:
......
...@@ -55,7 +55,7 @@ This strategy is designed to allow configuration of the simple OmniAuth SSO proc ...@@ -55,7 +55,7 @@ This strategy is designed to allow configuration of the simple OmniAuth SSO proc
sudo -u git -H editor config/gitlab.yml sudo -u git -H editor config/gitlab.yml
``` ```
1. See [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration) for initial settings 1. See [Configure initial settings](omniauth.md#configure-initial-settings) for initial settings
1. Add the provider-specific configuration for your provider, as [described in the gem's README](https://gitlab.com/satorix/omniauth-oauth2-generic#gitlab-config-example) 1. Add the provider-specific configuration for your provider, as [described in the gem's README](https://gitlab.com/satorix/omniauth-oauth2-generic#gitlab-config-example)
......
This diff is collapsed.
...@@ -48,7 +48,7 @@ To get the credentials (a pair of Client ID and Client Secret), you must [create ...@@ -48,7 +48,7 @@ To get the credentials (a pair of Client ID and Client Secret), you must [create
sudo -u git -H editor config/gitlab.yml sudo -u git -H editor config/gitlab.yml
``` ```
1. See [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration) for initial settings. 1. See [Configure initial settings](omniauth.md#configure-initial-settings) for initial settings.
1. Add the provider configuration: 1. Add the provider configuration:
......
...@@ -53,7 +53,7 @@ in your SAML IdP: ...@@ -53,7 +53,7 @@ in your SAML IdP:
sudo -u git -H editor config/gitlab.yml sudo -u git -H editor config/gitlab.yml
``` ```
1. See [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration) for initial settings. 1. See [Configure initial settings](omniauth.md#configure-initial-settings) for initial settings.
1. To allow your users to use SAML to sign up without having to manually create 1. To allow your users to use SAML to sign up without having to manually create
an account first, add the following values to your configuration: an account first, add the following values to your configuration:
......
...@@ -53,7 +53,7 @@ Twitter. Twitter generates a client ID and secret key for you to use. ...@@ -53,7 +53,7 @@ Twitter. Twitter generates a client ID and secret key for you to use.
sudo -u git -H editor config/gitlab.yml sudo -u git -H editor config/gitlab.yml
``` ```
1. See [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration) for initial settings. 1. See [Configure initial settings](omniauth.md#configure-initial-settings) for initial settings.
1. Add the provider configuration: 1. Add the provider configuration:
......
...@@ -108,7 +108,7 @@ GitLab has several features which can help you manage the number of users: ...@@ -108,7 +108,7 @@ GitLab has several features which can help you manage the number of users:
- Enable the [**Require administrator approval for new sign ups**](../../user/admin_area/settings/sign_up_restrictions.md#require-administrator-approval-for-new-sign-ups) - Enable the [**Require administrator approval for new sign ups**](../../user/admin_area/settings/sign_up_restrictions.md#require-administrator-approval-for-new-sign-ups)
option. option.
- Enable `block_auto_created_users` for new sign-ups via [LDAP](../../administration/auth/ldap/index.md#basic-configuration-settings) or [OmniAuth](../../integration/omniauth.md#initial-omniauth-configuration). - Enable `block_auto_created_users` for new sign-ups via [LDAP](../../administration/auth/ldap/index.md#basic-configuration-settings) or [OmniAuth](../../integration/omniauth.md#configure-initial-settings).
- Enable the [User cap](../../user/admin_area/settings/sign_up_restrictions.md#user-cap) - Enable the [User cap](../../user/admin_area/settings/sign_up_restrictions.md#user-cap)
option. **Available in GitLab 13.7 and later**. option. **Available in GitLab 13.7 and later**.
- [Disable new sign-ups](../../user/admin_area/settings/sign_up_restrictions.md), and instead manage new - [Disable new sign-ups](../../user/admin_area/settings/sign_up_restrictions.md), and instead manage new
......
...@@ -17,7 +17,7 @@ pending approval state because an administrator has enabled any of the following ...@@ -17,7 +17,7 @@ pending approval state because an administrator has enabled any of the following
- [Require admin approval for new sign-ups](settings/sign_up_restrictions.md#require-administrator-approval-for-new-sign-ups) setting. - [Require admin approval for new sign-ups](settings/sign_up_restrictions.md#require-administrator-approval-for-new-sign-ups) setting.
- [User cap](settings/sign_up_restrictions.md#user-cap). - [User cap](settings/sign_up_restrictions.md#user-cap).
- [Block auto-created users (OmniAuth)](../../integration/omniauth.md#initial-omniauth-configuration) - [Block auto-created users (OmniAuth)](../../integration/omniauth.md#configure-initial-settings)
- [Block auto-created users (LDAP)](../../administration/auth/ldap/index.md#basic-configuration-settings) - [Block auto-created users (LDAP)](../../administration/auth/ldap/index.md#basic-configuration-settings)
When a user registers for an account while this setting is enabled: When a user registers for an account while this setting is enabled:
......
...@@ -48,7 +48,7 @@ automatically approved in a background job. ...@@ -48,7 +48,7 @@ automatically approved in a background job.
NOTE: NOTE:
This setting doesn't apply to LDAP or OmniAuth users. To enforce approvals for new users This setting doesn't apply to LDAP or OmniAuth users. To enforce approvals for new users
signing up using OmniAuth or LDAP, set `block_auto_created_users` to `true` in the signing up using OmniAuth or LDAP, set `block_auto_created_users` to `true` in the
[OmniAuth configuration](../../../integration/omniauth.md#initial-omniauth-configuration) or [OmniAuth configuration](../../../integration/omniauth.md#configure-initial-settings) or
[LDAP configuration](../../../administration/auth/ldap/index.md#basic-configuration-settings). [LDAP configuration](../../../administration/auth/ldap/index.md#basic-configuration-settings).
## Require email confirmation ## Require email confirmation
......
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