diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-05-20 17:34:42 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-05-20 17:34:42 +0300 |
commit | 9f46488805e86b1bc341ea1620b866016c2ce5ed (patch) | |
tree | f9748c7e287041e37d6da49e0a29c9511dc34768 /doc/administration/auth | |
parent | dfc92d081ea0332d69c8aca2f0e745cb48ae5e6d (diff) |
Add latest changes from gitlab-org/gitlab@13-0-stable-ee
Diffstat (limited to 'doc/administration/auth')
-rw-r--r-- | doc/administration/auth/crowd.md | 5 | ||||
-rw-r--r-- | doc/administration/auth/google_secure_ldap.md | 7 | ||||
-rw-r--r-- | doc/administration/auth/how_to_configure_ldap_gitlab_ce/index.md | 5 | ||||
-rw-r--r-- | doc/administration/auth/how_to_configure_ldap_gitlab_ee/index.md | 6 | ||||
-rw-r--r-- | doc/administration/auth/jwt.md | 5 | ||||
-rw-r--r-- | doc/administration/auth/ldap-ee.md | 3 | ||||
-rw-r--r-- | doc/administration/auth/ldap-troubleshooting.md | 4 | ||||
-rw-r--r-- | doc/administration/auth/oidc.md | 2 | ||||
-rw-r--r-- | doc/administration/auth/smartcard.md | 4 |
9 files changed, 16 insertions, 25 deletions
diff --git a/doc/administration/auth/crowd.md b/doc/administration/auth/crowd.md index 6c2e4edac31..71938d4fd2b 100644 --- a/doc/administration/auth/crowd.md +++ b/doc/administration/auth/crowd.md @@ -66,14 +66,11 @@ Authenticate to GitLab using the Atlassian Crowd OmniAuth provider. 1. Change `YOUR_APP_NAME` to the application name from Crowd applications page. 1. Change `YOUR_APP_PASSWORD` to the application password you've set. 1. Save the configuration file. -1. [Reconfigure][] or [restart][] for the changes to take effect if you +1. [Reconfigure](../restart_gitlab.md#omnibus-gitlab-reconfigure) or [restart](../restart_gitlab.md#installations-from-source) for the changes to take effect if you installed GitLab via Omnibus or from source respectively. On the sign in page there should now be a Crowd tab in the sign in form. -[reconfigure]: ../restart_gitlab.md#omnibus-gitlab-reconfigure -[restart]: ../restart_gitlab.md#installations-from-source - ## Troubleshooting If you see an error message like the one below when you sign in after Crowd authentication is configured, you may want to consult the Crowd administrator for the Crowd log file to know the exact cause: diff --git a/doc/administration/auth/google_secure_ldap.md b/doc/administration/auth/google_secure_ldap.md index cb7901ea5b4..b643dd2f7b9 100644 --- a/doc/administration/auth/google_secure_ldap.md +++ b/doc/administration/auth/google_secure_ldap.md @@ -133,7 +133,7 @@ values obtained during the LDAP client configuration earlier: EOS ``` -1. Save the file and [reconfigure] GitLab for the changes to take effect. +1. Save the file and [reconfigure](../restart_gitlab.md#omnibus-gitlab-reconfigure) GitLab for the changes to take effect. --- @@ -204,10 +204,7 @@ values obtained during the LDAP client configuration earlier: -----END PRIVATE KEY----- ``` -1. Save the file and [restart] GitLab for the changes to take effect. - -[reconfigure]: ../restart_gitlab.md#omnibus-gitlab-reconfigure -[restart]: ../restart_gitlab.md#installations-from-source +1. Save the file and [restart](../restart_gitlab.md#installations-from-source) GitLab for the changes to take effect. <!-- ## Troubleshooting diff --git a/doc/administration/auth/how_to_configure_ldap_gitlab_ce/index.md b/doc/administration/auth/how_to_configure_ldap_gitlab_ce/index.md index 49bf786061e..01da4528eab 100644 --- a/doc/administration/auth/how_to_configure_ldap_gitlab_ce/index.md +++ b/doc/administration/auth/how_to_configure_ldap_gitlab_ce/index.md @@ -45,10 +45,7 @@ Configuring organizational units (**OU**s) is an important part of setting up Ac | GitLab **OU** Design | GitLab AD Structure | | :----------------------------: | :------------------------------: | -| ![GitLab OU Design][gitlab_ou] | ![GitLab AD Structure][ldap_ou] | - -[gitlab_ou]: img/gitlab_ou.png -[ldap_ou]: img/ldap_ou.gif +| ![GitLab OU Design](img/gitlab_ou.png) | ![GitLab AD Structure](img/ldap_ou.gif) | Using PowerShell you can output the **OU** structure as a table (_all names are examples only_): diff --git a/doc/administration/auth/how_to_configure_ldap_gitlab_ee/index.md b/doc/administration/auth/how_to_configure_ldap_gitlab_ee/index.md index 46bc079971d..d7b32c8a92a 100644 --- a/doc/administration/auth/how_to_configure_ldap_gitlab_ee/index.md +++ b/doc/administration/auth/how_to_configure_ldap_gitlab_ee/index.md @@ -8,7 +8,7 @@ This article expands on [How to Configure LDAP with GitLab CE](../how_to_configu ## GitLab Enterprise Edition - LDAP features -[GitLab Enterprise Edition (EE)](https://about.gitlab.com/pricing/) has a number of advantages when it comes to integrating with Active Directory (LDAP): +[GitLab Enterprise Edition (EE)](https://about.gitlab.com/pricing/) has several advantages when it comes to integrating with Active Directory (LDAP): - [Administrator Sync](../ldap-ee.md#administrator-sync): As an extension of group sync, you can automatically manage your global GitLab administrators. Specify a group CN for `admin_group` and all members of the LDAP group will be given administrator privileges. - [Group Sync](#group-sync): This allows GitLab group membership to be automatically updated based on LDAP group members. @@ -16,7 +16,7 @@ This article expands on [How to Configure LDAP with GitLab CE](../how_to_configu - Daily user synchronization: Once a day, GitLab will run a synchronization to check and update GitLab users against LDAP. This process updates all user details automatically. -On the following section, you'll find a description for each of these features. Read through [LDAP GitLab EE docs](../ldap-ee.md) for complementary information. +In the following section, you'll find a description of each of these features. Read through [LDAP GitLab EE docs](../ldap-ee.md) for complementary information. ![GitLab OU Structure](img/admin_group.png) @@ -28,7 +28,7 @@ Group syncing allows AD (LDAP) groups to be mapped to GitLab groups. This provid #### Creating group links - example -As an example, let's suppose we have a "UKGov" GitLab group, which deals with confidential government information. Therefore, it is important that users of this group are given the correct permissions to projects contained within the group. Granular group permissions can be applied based on the AD group. +As an example, let's suppose we have a "UKGov" GitLab group, which deals with confidential government information. Therefore, users of this group must be given the correct permissions to projects contained within the group. Granular group permissions can be applied based on the AD group. **UK Developers** of our "UKGov" group are given **"developer"** permissions. diff --git a/doc/administration/auth/jwt.md b/doc/administration/auth/jwt.md index 15eee50c771..5a773485842 100644 --- a/doc/administration/auth/jwt.md +++ b/doc/administration/auth/jwt.md @@ -64,7 +64,7 @@ JWT will provide you with a secret key for you to use. 1. Change `YOUR_APP_SECRET` to the client secret and set `auth_url` to your redirect URL. 1. Save the configuration file. -1. [Reconfigure][] or [restart GitLab][] for the changes to take effect if you +1. [Reconfigure](../restart_gitlab.md#omnibus-gitlab-reconfigure) or [restart GitLab](../restart_gitlab.md#installations-from-source) for the changes to take effect if you installed GitLab via Omnibus or from source respectively. On the sign in page there should now be a JWT icon below the regular sign in form. @@ -72,9 +72,6 @@ Click the icon to begin the authentication process. JWT will ask the user to sign in and authorize the GitLab application. If everything goes well, the user will be redirected to GitLab and will be signed in. -[reconfigure]: ../restart_gitlab.md#omnibus-gitlab-reconfigure -[restart GitLab]: ../restart_gitlab.md#installations-from-source - <!-- ## Troubleshooting Include any troubleshooting steps that you can foresee. If you know beforehand what issues diff --git a/doc/administration/auth/ldap-ee.md b/doc/administration/auth/ldap-ee.md index 3bc30c4c01c..9e193dba08c 100644 --- a/doc/administration/auth/ldap-ee.md +++ b/doc/administration/auth/ldap-ee.md @@ -119,6 +119,9 @@ following. To take advantage of group sync, group owners or maintainers will need to [create one or more LDAP group links](#adding-group-links). +NOTE: **Note:** +If an LDAP user is a group member when LDAP Synchronization is added, and they are not part of the LDAP group, they will be removed from the group. + ### Adding group links Once [group sync has been configured](#group-sync) on the instance, one or more LDAP diff --git a/doc/administration/auth/ldap-troubleshooting.md b/doc/administration/auth/ldap-troubleshooting.md index 612f782e841..77c9c30d140 100644 --- a/doc/administration/auth/ldap-troubleshooting.md +++ b/doc/administration/auth/ldap-troubleshooting.md @@ -312,7 +312,7 @@ things to check to debug the situation. interval](ldap-ee.md#adjusting-ldap-group-sync-schedule) for the group to sync. To speed up the process, either go to the GitLab group **Settings -> Members** and press **Sync now** (sync one group) or [run the group sync Rake - task](../raketasks/ldap.md#run-a-group-sync) (sync all groups). + task](../raketasks/ldap.md#run-a-group-sync-starter-only) (sync all groups). If all of the above looks good, jump in to a little more advanced debugging in the rails console. @@ -352,7 +352,7 @@ GitLab syncs the `admin_group`. NOTE: **NOTE:** To sync all groups manually when debugging is unnecessary, [use the Rake -task](../raketasks/ldap.md#run-a-group-sync) instead. +task](../raketasks/ldap.md#run-a-group-sync-starter-only) instead. The output from a manual [group sync](ldap-ee.md#group-sync) can show you what happens when GitLab syncs its LDAP group memberships against LDAP. diff --git a/doc/administration/auth/oidc.md b/doc/administration/auth/oidc.md index 76e83c8e0ad..7a808636e94 100644 --- a/doc/administration/auth/oidc.md +++ b/doc/administration/auth/oidc.md @@ -94,7 +94,7 @@ The OpenID Connect will provide you with a client details and secret for you to - `basic` - HTTP Basic Authentication - `jwt_bearer` - JWT based authentication (private key and client secret signing) - `mtls` - Mutual TLS or X.509 certificate validation - - Any other value will POST the client id and secret in the request body + - Any other value will POST the client ID and secret in the request body - If not specified, defaults to `basic`. - `<uid_field>` (optional) is the field name from the `user_info` details that will be used as `uid` value. For example, `preferred_username`. If this value is not provided or the field with the configured value is missing from the `user_info` details, the `uid` will use the `sub` field. diff --git a/doc/administration/auth/smartcard.md b/doc/administration/auth/smartcard.md index 8986a9866e7..7131fd7571f 100644 --- a/doc/administration/auth/smartcard.md +++ b/doc/administration/auth/smartcard.md @@ -37,7 +37,7 @@ To use a smartcard with an X.509 certificate to authenticate against a local database with GitLab, `CN` and `emailAddress` must be defined in the certificate. For example: -```text +```plaintext Certificate: Data: Version: 1 (0x0) @@ -73,7 +73,7 @@ database with GitLab, in: For example: -```text +```plaintext Certificate: Data: Version: 1 (0x0) |