From 67a70e0132b89fb04fd607ba80e834dad6ff82a4 Mon Sep 17 00:00:00 2001 From: Pierre Wizla Date: Wed, 15 Jan 2025 10:46:50 +0100 Subject: [PATCH] Add the SSO badge for the new, paid add-on (#2341) * Fix enterprise badge color * Add SSO badge --- docusaurus/docs/dev-docs/configurations.md | 2 +- .../docs/dev-docs/configurations/admin-panel.md | 4 ++-- docusaurus/docs/dev-docs/configurations/sso.md | 4 ++-- .../getting-started/setting-up-admin-panel.md | 2 +- docusaurus/docs/user-docs/settings/single-sign-on.md | 2 +- .../configuring-administrator-roles.md | 2 +- docusaurus/src/components/Badge.js | 12 ++++++++++++ docusaurus/src/scss/_tokens.scss | 3 +++ docusaurus/src/scss/badge.scss | 12 ++++++++++++ docusaurus/src/theme/MDXComponents.js | 3 ++- 10 files changed, 37 insertions(+), 9 deletions(-) diff --git a/docusaurus/docs/dev-docs/configurations.md b/docusaurus/docs/dev-docs/configurations.md index 6405dd6bf3..c4f325c307 100644 --- a/docusaurus/docs/dev-docs/configurations.md +++ b/docusaurus/docs/dev-docs/configurations.md @@ -45,7 +45,7 @@ Some specific features require additional configuration: | [Lifecycle functions](/dev-docs/configurations/functions) | In the `/src/index` file | Optionally used to perform various actions that happen during the server lifecycle. Includes the `register`, `bootstrap`, and `destroy` functions. | | [Cron jobs](/dev-docs/configurations/cron) | | Required to setup CRON jobs for the server. | | [Environment variables](/dev-docs/configurations/environment) | In dedicated files and folders for the environment (e.g., `config/env/production/server`) | Optionally used to define different environments and their variables. | -| [Single Sign-On (SSO)](/dev-docs/configurations/sso) | In the `config/admin` file | Required to use the Entreprise-only SSO feature if enabled on your project. | +| [Single Sign-On (SSO)](/dev-docs/configurations/sso) | In the `config/admin` file | Required to use the SSO feature if enabled on your project. | | [Feature flags](/dev-docs/configurations/features) | In the `config/features` file | Optional for a typical, stable Strapi application.
Only required to enable [future flags](/dev-docs/configurations/features).| ## Guides diff --git a/docusaurus/docs/dev-docs/configurations/admin-panel.md b/docusaurus/docs/dev-docs/configurations/admin-panel.md index 9a7e2b8b3a..60e96a5383 100644 --- a/docusaurus/docs/dev-docs/configurations/admin-panel.md +++ b/docusaurus/docs/dev-docs/configurations/admin-panel.md @@ -28,8 +28,8 @@ The `./config/admin.js` file can include the following parameters: | `auditLogs.retentionDays` | How long [Audit Logs](/user-docs/settings/audit-logs) are kept, in days.

_The behavior differs for self-hosted vs. Strapi Cloud customers, see the note under the table._ | integer | 90 | | `auth` | Authentication configuration | object | - | | `auth.secret` | Secret used to encode JWT tokens | string | `undefined` | -| `auth.domain` | Domain used within the cookie for SSO authentication (Enterprise only) | string | `undefined` | -| `auth.providers` | List of authentication providers used for SSO (Enterprise only, see [SSO](/dev-docs/configurations/sso)) | array(object) | - | +| `auth.domain` | Domain used within the cookie for SSO authentication | string | `undefined` | +| `auth.providers` | List of authentication providers used for SSO (see [SSO](/dev-docs/configurations/sso)) | array(object) | - | | `auth.options` | Options object passed to [jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken) | object | - | | `auth.options.expiresIn` | JWT expire time used in [jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken) | object | `30d` | | `auth.events` | Record of all the events subscribers registered for the authentication | object | `{}` | diff --git a/docusaurus/docs/dev-docs/configurations/sso.md b/docusaurus/docs/dev-docs/configurations/sso.md index 454392a362..bbead579d6 100644 --- a/docusaurus/docs/dev-docs/configurations/sso.md +++ b/docusaurus/docs/dev-docs/configurations/sso.md @@ -13,14 +13,14 @@ tags: --- # Single Sign-On - + Single Sign-On on Strapi allows you to configure additional sign-in and sign-up methods for your administration panel. :::prerequisites - A Strapi application running on version 3.5.0 or higher is required. -- To configure SSO on your application, you will need an plan. +- To configure SSO on your application, you will need an plan or the add-on. - Make sure the SSO feature is [enabled in the admin panel](/user-docs/settings/single-sign-on). - Make sure Strapi is part of the applications you can access with your provider. For example, with Microsoft (Azure) Active Directory, you must first ask someone with the right permissions to add Strapi to the list of allowed applications. Please refer to your provider(s) documentation to learn more about that. ::: diff --git a/docusaurus/docs/user-docs/getting-started/setting-up-admin-panel.md b/docusaurus/docs/user-docs/getting-started/setting-up-admin-panel.md index ae67a2c7ce..80206c7c49 100644 --- a/docusaurus/docs/user-docs/getting-started/setting-up-admin-panel.md +++ b/docusaurus/docs/user-docs/getting-started/setting-up-admin-panel.md @@ -34,7 +34,7 @@ To access the admin panel: 3. Click on the **Login** button. You should be redirected to the homepage of the admin panel. ### Using SSO for authentication - + If your Strapi application was configured to allow authentication through SSO (see [Configuring Single Sign-On](/user-docs/settings/single-sign-on)), you can access the admin panel using a specific provider instead of logging in with a regular Strapi administrator account. diff --git a/docusaurus/docs/user-docs/settings/single-sign-on.md b/docusaurus/docs/user-docs/settings/single-sign-on.md index f335a21920..941f327bfd 100644 --- a/docusaurus/docs/user-docs/settings/single-sign-on.md +++ b/docusaurus/docs/user-docs/settings/single-sign-on.md @@ -8,7 +8,7 @@ tags: --- # Configuring Single Sign-On (SSO) - + Single Sign-On (SSO) can be made available on a Strapi application to allow administrators to authenticate through an identity provider (e.g. Microsoft Azure Active Directory). SSO configurations can be done from ![Settings icon](/img/assets/icons/v5/Cog.svg) *Settings > Global settings > Single Sign-On*. diff --git a/docusaurus/docs/user-docs/users-roles-permissions/configuring-administrator-roles.md b/docusaurus/docs/user-docs/users-roles-permissions/configuring-administrator-roles.md index 9d3531f713..b191ba65d9 100644 --- a/docusaurus/docs/user-docs/users-roles-permissions/configuring-administrator-roles.md +++ b/docusaurus/docs/user-docs/users-roles-permissions/configuring-administrator-roles.md @@ -137,7 +137,7 @@ Settings permissions can be configured for all settings accessible from *General | Media Library |
  • General
    • "Access the Media Library settings page" - gives access to Media Library settings
Path reminder to Media Library settings:
*General > Settings > Global Settings - Media Library* | | Internationalization |
  • Locales
    • "Create" - allows to create new locales
    • "Read" - allows to see available locales
    • "Update" - allows to edit available locales
    • "Delete" - allows to delete locales
Path reminder to the Internationalization settings:
*General > Settings > Global Settings - Internationalization* | | Review Workflows |
  • "Create" - allows to create workflows
  • "Read" - allows to see created workflows
  • "Update" - allows to edit workflows
  • "Delete" - allows to delete workflows
Path reminder to Review workflows settings:
*General > Settings > Global Settings - Review workflows* | -| Single sign on |
  • Options
    • "Read" - allows to access the SSO settings
    • "Update" - allows to edit the SSO settings
Path reminder to the SSO settings:
*General > Settings > Global Settings - Single Sign-On* | +| Single sign on |
  • Options
    • "Read" - allows to access the SSO settings
    • "Update" - allows to edit the SSO settings
Path reminder to the SSO settings:
*General > Settings > Global Settings - Single Sign-On* | | Audit Logs |
  • Options
    • "Read" - allows to access the Audit Logs settings
Path reminder to the Audit Logs settings:
*General > Settings > Admin Panel - Audit Logs* | | Plugins and Marketplace |
  • Marketplace
    • "Access the Marketplace" - gives access to the Marketplace
| | Webhooks |
  • General
    • "Create" - allows to create webhooks
    • "Read" - allows to see created webhooks
    • "Update" - allows to edit webhooks
    • "Delete" - allows to delete webhooks
Path reminder to Webhook settings:
*General > Settings > Global Settings - Webhook* | diff --git a/docusaurus/src/components/Badge.js b/docusaurus/src/components/Badge.js index 54aab67372..f11479d4a7 100644 --- a/docusaurus/src/components/Badge.js +++ b/docusaurus/src/components/Badge.js @@ -108,6 +108,18 @@ export function GrowthBadge(props) { ); } +export function SsoBadge(props) { + return ( + + ); +} + export function CloudProBadge(props) { return (