diff options
Diffstat (limited to 'doc/integration/omniauth.md')
| -rw-r--r-- | doc/integration/omniauth.md | 35 |
1 files changed, 17 insertions, 18 deletions
diff --git a/doc/integration/omniauth.md b/doc/integration/omniauth.md index af039c8a009..2dd8505b558 100644 --- a/doc/integration/omniauth.md +++ b/doc/integration/omniauth.md @@ -38,7 +38,7 @@ GitLab supports the following OmniAuth providers. | [SAML](saml.md) | `saml` | | [Twitter](twitter.md) | `twitter` | -## Configure initial settings +## Initial settings Before you configure the OmniAuth provider, configure the settings that are common for all providers. @@ -49,13 +49,15 @@ Omnibus, Docker, and source | Helm chart | Description | Default value `auto_link_ldap_user` | `autoLinkLdapUser` | Creates an LDAP identity in GitLab for users that are created through an OmniAuth provider. You can enable this setting if you have [LDAP integration](../administration/auth/ldap/index.md) enabled. Requires the `uid` of the user to be the same in both LDAP and the OmniAuth provider. | `false` `block_auto_created_users` | `blockAutoCreatedUsers` | Blocks users that are automatically created from signing in until they are approved by an administrator. | `true`. If you set the value to `false`, make sure you define providers that you can control, like SAML or Google. Otherwise, any user on the internet can sign in to GitLab without an administrator's approval. -To change these settings: +### Configure initial settings + +To change the OmniAuth settings: ::Tabs - :::TabTitle Omnibus + :::TabTitle Linux package (Omnibus) - 1. Edit `/etc/gitlab/gitlab.rb` and update the following section: + 1. Edit `/etc/gitlab/gitlab.rb`: ```ruby # CAUTION! @@ -67,13 +69,13 @@ To change these settings: gitlab_rails['omniauth_block_auto_created_users'] = true ``` - 1. Reconfigure GitLab: + 1. Save the file and reconfigure GitLab: ```shell sudo gitlab-ctl reconfigure ``` - :::TabTitle Helm chart + :::TabTitle Helm chart (Kubernetes) 1. Export the Helm values: @@ -96,22 +98,15 @@ To change these settings: For more details, see the [globals documentation](https://docs.gitlab.com/charts/charts/globals.html#omniauth). - 1. Apply the new values: + 1. Save the file and apply the new values: ```shell helm upgrade -f gitlab_values.yaml gitlab gitlab/gitlab ``` - :::TabTitle Source - - 1. Open the configuration file: - - ```shell - cd /home/git/gitlab - sudo -u git -H editor config/gitlab.yml - ``` + :::TabTitle Self-compiled (source) - 1. Update the following section: + 1. Edit `/home/git/gitlab/config/gitlab.yml`: ```yaml ## OmniAuth settings @@ -132,9 +127,13 @@ To change these settings: block_auto_created_users: true ``` - 1. Restart GitLab: + 1. Save the file and restart GitLab: ```shell + # For systems running systemd + sudo systemctl restart gitlab.target + + # For systems running SysV init sudo service gitlab restart ``` @@ -283,7 +282,7 @@ for the OpenID Connect provider and the Twitter OAuth provider. This method of enabling automatic linking works for all providers [except SAML](https://gitlab.com/gitlab-org/gitlab/-/issues/338293). -To enable automatic linking for SAML, see the [SAML setup instructions](saml.md#general-setup). +To enable automatic linking for SAML, see the [SAML setup instructions](saml.md#configure-saml-support-in-gitlab). ## Create an external providers list |