diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-05 21:08:13 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-05 21:08:13 +0000 |
commit | d3c29eae5c389e36d4751539fad0462053fb2b20 (patch) | |
tree | cc3ae497193f9334d0bc6ee4224637102f6e0d4e /doc/administration/auth/oidc.md | |
parent | ad4dbe36445360521fc73a57df13bc8f12eeaa92 (diff) | |
download | gitlab-ce-d3c29eae5c389e36d4751539fad0462053fb2b20.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/administration/auth/oidc.md')
-rw-r--r-- | doc/administration/auth/oidc.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/administration/auth/oidc.md b/doc/administration/auth/oidc.md index 0160db1b388..728be699772 100644 --- a/doc/administration/auth/oidc.md +++ b/doc/administration/auth/oidc.md @@ -34,6 +34,7 @@ The OpenID Connect will provide you with a client details and secret for you to gitlab_rails['omniauth_providers'] = [ { 'name' => 'openid_connect', 'label' => '<your_oidc_label>', + 'icon' => '<custom_provider_icon>', 'args' => { 'name' => 'openid_connect', 'scope' => ['openid','profile'], @@ -58,6 +59,7 @@ The OpenID Connect will provide you with a client details and secret for you to ```yaml - { name: 'openid_connect', label: '<your_oidc_label>', + icon: '<custom_provider_icon>', args: { name: 'openid_connect', scope: ['openid','profile'], @@ -82,6 +84,8 @@ The OpenID Connect will provide you with a client details and secret for you to 1. For the configuration above, change the values for the provider to match your OpenID Connect client setup. Use the following as a guide: - `<your_oidc_label>` is the label that will be displayed on the login page. + - `<custom_provider_icon>` (optional) is the icon that will be displayed on the login page. Icons for the major social login platforms are built-in into GitLab, + but can be overridden by specifying this parameter. Both local paths and absolute URLs are accepted. - `<your_oidc_url>` (optional) is the URL that points to the OpenID Connect provider. For example, `https://example.com/auth/realms/your-realm`. If this value is not provided, the URL is constructed from the `client_options` in the following format: `<client_options.scheme>://<client_options.host>:<client_options.port>`. - If `discovery` is set to `true`, the OpenID Connect provider will try to auto discover the client options using `<your_oidc_url>/.well-known/openid-configuration`. Defaults to `false`. |