Skip to content

Commit

Permalink
docs: add administration doc on SSO config (#1940)
Browse files Browse the repository at this point in the history
* docs: add administration doc on SSO config

* update

* update

* update
  • Loading branch information
wsxiaoys authored Apr 23, 2024
1 parent c162ffc commit a8c4fb7
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 0 deletions.
28 changes: 28 additions & 0 deletions website/docs/administration/sso/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import SSOCreateUrl from "./sso_create.png";
import SSOSigninUrl from "./sso_signin.png";

# Single Sign-On

:::subscription
This feature is available in the **Enterprise** plans.
:::

Single Sign-On (SSO) is an authentication method that enables users to securely authenticate with multiple applications using just one set of credentials.

## Create an Identity Provider

1. Navigate to the **Integrations > SSO** page.

![Integrations > SSO](./integrations_sso.png)

2. Click **Create** to begin the process of creating an identity provider. (Currently, as of version 0.10, only GitHub OAuth and Google OAuth are supported. More options are forthcoming.)

<img src={SSOCreateUrl} width={600} alt="Create SSO"/>

3. Complete all the required fields and submit the form with **Create** button.

## Sign in with SSO

After a valid identity provider has been established, users can select the provider to sign in with.

<img src={SSOSigninUrl} width={600} alt="Sign in with SSO"/>
3 changes: 3 additions & 0 deletions website/docs/administration/sso/integrations_sso.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions website/docs/administration/sso/sso_create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions website/docs/administration/sso/sso_signin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a8c4fb7

Please sign in to comment.