From c83199db895f345c49eefd0ef52f5b006eefe4df Mon Sep 17 00:00:00 2001 From: Melinda Fekete Date: Thu, 28 Nov 2024 14:08:09 +0100 Subject: [PATCH] Remove admonitions from Proxy docs (#8860) --- .../component/admin/auth/OidcAuth/OidcAuth.tsx | 4 ++-- .../component/admin/auth/SamlAuth/SamlAuth.tsx | 3 ++- .../component/admin/auth/SsoGroupSettings.tsx | 3 +-- website/docs/reference/sso.md | 17 ++++++----------- website/remote-content/edge-proxy.js | 9 +-------- 5 files changed, 12 insertions(+), 24 deletions(-) diff --git a/frontend/src/component/admin/auth/OidcAuth/OidcAuth.tsx b/frontend/src/component/admin/auth/OidcAuth/OidcAuth.tsx index 53f602332bcb..b73bbf122355 100644 --- a/frontend/src/component/admin/auth/OidcAuth/OidcAuth.tsx +++ b/frontend/src/component/admin/auth/OidcAuth/OidcAuth.tsx @@ -136,8 +136,8 @@ export const OidcAuth = () => { > documentation {' '} - to learn how to integrate with specific Open Id Connect - providers (Okta, Keycloak, Google, etc).
+ to learn how to integrate with specific OpenID Connect + providers (such as Okta and Keycloak).
Callback URL:{' '} {uiConfig.unleashUrl}/auth/oidc/callback diff --git a/frontend/src/component/admin/auth/SamlAuth/SamlAuth.tsx b/frontend/src/component/admin/auth/SamlAuth/SamlAuth.tsx index e97d63921776..5b43164b8d85 100644 --- a/frontend/src/component/admin/auth/SamlAuth/SamlAuth.tsx +++ b/frontend/src/component/admin/auth/SamlAuth/SamlAuth.tsx @@ -128,7 +128,8 @@ export const SamlAuth = () => { documentation {' '} to learn how to integrate with specific SAML 2.0 - providers (Okta, Keycloak, etc).
+ providers (such as Okta, Keycloak, and Microsoft Entra + ID).
Callback URL:{' '} {uiConfig.unleashUrl}/auth/saml/callback diff --git a/frontend/src/component/admin/auth/SsoGroupSettings.tsx b/frontend/src/component/admin/auth/SsoGroupSettings.tsx index 140ee0fe41ea..991325485e51 100644 --- a/frontend/src/component/admin/auth/SsoGroupSettings.tsx +++ b/frontend/src/component/admin/auth/SsoGroupSettings.tsx @@ -43,8 +43,7 @@ export const SsoGroupSettings = ({ Enable Group Syncing

Enables automatically syncing of users from the{' '} - {ssoType} - provider when a user logs in. + {ssoType} provider when a user logs in.

diff --git a/website/docs/reference/sso.md b/website/docs/reference/sso.md index 7dc8cc2a4991..0e7b0c7faa10 100644 --- a/website/docs/reference/sso.md +++ b/website/docs/reference/sso.md @@ -2,27 +2,22 @@ title: Single Sign-On --- + :::note Availability **Plan**: [Enterprise](https://www.getunleash.io/pricing) ::: -Unleash Enterprise supports SAML 2.0, OpenID Connect and Google Authentication. In addition, Unleash supports username/password authentication out of the box. - -### Before you start - -In order to configure Single-Sign-On you will need to log in to the Unleash instance with a user that have "Admin" role. If you are self-hosting Unleash then a default user will be automatically created the first time you start unleash: - -- username: `admin` -- password: `unleash4all` _(or `admin` if you started with Unleash v3)._ +## Overview -## Guides +Unleash provides single sign-on (SSO) support through SAML 2.0, OpenID Connect, and username/password authentication. -Unleash enterprise supports multiple authentication providers. +To configure SSO, navigate to **Admin > Single sign-on** in the Unleash Admin UI. Admin access is required. +For step-by-step configuration instructions, refer to the following guides: - [OpenID Connect with Okta](../how-to/how-to-add-sso-open-id-connect) - [SAML 2.0 with Okta](../how-to/how-to-add-sso-saml) - [SAML 2.0 with Keycloak](../how-to/how-to-add-sso-saml-keycloak) - [SAML 2.0 with Microsoft Entra ID](../how-to/how-to-add-sso-azure-saml) -- [Google Authentication](../how-to/how-to-add-sso-google) (deprecated) +- [Google Authentication](../how-to/how-to-add-sso-google) (deprecated) diff --git a/website/remote-content/edge-proxy.js b/website/remote-content/edge-proxy.js index 4e1d6423764c..a62b5fc4b5df 100644 --- a/website/remote-content/edge-proxy.js +++ b/website/remote-content/edge-proxy.js @@ -28,14 +28,7 @@ const DOCS = mapObject(enrich)({ }); const getAdmonitions = (data) => { - const admonitions = { - 'unleash-proxy': `:::tip - -Looking for how to run the Unleash proxy? Check out the [_how to run the Unleash proxy_ guide](../how-to/how-to-run-the-unleash-proxy.mdx)! - -:::`, - 'unleash-edge': ``, - }; + const admonitions = {}; return [admonitions[data.slugName]]; };