Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add identity providers (admin) & remove identity providers (install) #157

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
13 changes: 10 additions & 3 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,10 @@ export default defineConfig({
icon: 'cluster.svg'
},
}, {
"label": "IDPs",
"link": "/installation/idps/",
"label": "Identity Providers",
"link": "/installation/identity-providers/",
attrs: {
icon: 'shield.svg'
icon: 'globe.svg'
},
}]
},
Expand Down Expand Up @@ -128,6 +128,13 @@ export default defineConfig({
icon: 'workspace-classes.svg'
},
},
{
"label": "Identity Providers",
"link": "/administration/identity-providers/",
attrs: {
icon: 'globe.svg'
},
},
{
"label": "License",
"link": "/administration/license/",
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/about/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ The installation process may vary depending on your environment. Refer to the gu
/>
<DocumentListItem
title="Identity Providers Installation"
href="/installation/idps"
href="/installation/identity-providers"
/>
</DocumentList>

Expand Down
267 changes: 267 additions & 0 deletions src/content/docs/administration/identity-providers.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,267 @@
---
title: Identity Providers
description: Learn how to configure and manage Identity Providers in Daytona.
---

Identity Providers (IdPs) are services that manage user authentication and authorization. Daytona supports the integration of external Identity Providers, enabling users to authorize with Daytona using their existing credentials.

## Add an Identity Provider

Daytona provides the option to add multiple Identity Providers.

1. Click the **`New +`** button to add an Identity Provider.
2. Select the Identity Provider from the dropdown list.

- [**`Azure DevOps`**](#azure-devops)
- [**`Bitbucket`**](#bitbucket)
- [**`Bitbucket Server`**](#bitbucket-server)
- [**`GitHub`**](#github)
- [**`GitHub Enterprise Server`**](#github-enterprise-server)
- [**`GitLab`**](#gitlab)
- [**`GitLab Self-Managed`**](#gitlab-self-managed)
- [`Google`](#google)
- [**`Microsoft`**](#microsoft)

3. Enter the details of the selected Identity Provider.
4. Click **`Save`** to add the Identity Provider.

## Edit an Identity Provider

Daytona provides the option to edit the details of an existing Identity Provider.

1. Click the pencil icon **`✎`** next to the Identity Provider to edit it.
2. Modify the details of the Identity Provider.
3. Click **`Save`** to update the Identity Provider.

## Remove an Identity Provider

Daytona provides the option to remove an Identity Provider.

1. Click the bin icon next to the Identity Provider to remove it.
2. Click **`Remove`** to confirm the deletion.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need a disclaimer here. See #178

## Azure DevOps

Daytona provides the option to add Azure DevOps as an Identity Provider.

1. Click the **`New +`** button to add an Identity Provider.
2. Select **`Azure DevOps`** as the Identity Provider from the dropdown list.
3. Enter the details of the **`Azure DevOps`** Identity Provider.

- **Client ID**

Enter the client identifier registered with the Identity Provider.

- **Client Secret**

Enter the client secret registered with the Identity Provider.

- **Account Linking Only**

Toggle to enable the Identity Provider for logging in to existing accounts only.

- **Tenant ID**

If specified, `single-tenant` auth endpoints are used, otherwise `common` multi-tenant endpoints are used.

4. Click **`Save`** to add **`Azure DevOps`** as the Identity Provider.

## Bitbucket

Daytona provides the option to add Bitbucket as an Identity Provider.

1. Click the **`New +`** button to add an Identity Provider.
2. Select **`Bitbucket`** as the Identity Provider from the dropdown list.
3. Enter the details of the **`Bitbucket`** Identity Provider.

- **Client ID**

Enter the client identifier registered with the Identity Provider.

- **Client Secret**

Enter the client secret registered with the Identity Provider.

- **Account Linking Only**

Toggle to enable the Identity Provider for logging in to existing accounts only.

4. Click **`Save`** to add **`Bitbucket`** as the Identity Provider.

## Bitbucket Server

Daytona provides the option to add Bitbucket Server as an Identity Provider.

1. Click the **`New +`** button to add an Identity Provider.
2. Select **`Bitbucket Server`** as the Identity Provider from the dropdown list.
3. Enter the details of the **`Bitbucket Server`** Identity Provider.

- **Client ID**

Enter the client identifier registered with the Identity Provider.

- **Client Secret**

Enter the client secret registered with the Identity Provider.

- **Account Linking Only**

Toggle to enable the Identity Provider for logging in to existing accounts only.

- **Base URL**

Enter the base URL of the Identity Provider.

4. Click **`Save`** to add **`Bitbucket Server`** as the Identity Provider.

## GitHub

Daytona provides the option to add GitHub as an Identity Provider.

1. Click the **`New +`** button to add an Identity Provider.
2. Select **`GitHub`** as the Identity Provider from the dropdown list.
3. Enter the details of the **`GitHub`** Identity Provider.

- **Client ID**

Enter the client identifier registered with the Identity Provider.

- **Client Secret**

Enter the client secret registered with the Identity Provider.

- **Account Linking Only**

Toggle to enable the Identity Provider for logging in to existing accounts only.

4. Click **`Save`** to add **`GitHub`** as the Identity Provider.

fabjanvucina marked this conversation as resolved.
Show resolved Hide resolved
## GitHub Enterprise Server

Daytona provides the option to add GitHub Enterprise Server as an Identity Provider.

1. Click the **`New +`** button to add an Identity Provider.
2. Select **`GitHub Enterprise Server`** as the Identity Provider from the dropdown list.
3. Enter the details of the **`GitHub Enterprise Server`** Identity Provider.

- **Client ID**

Enter the client identifier registered with the Identity Provider.

- **Client Secret**

Enter the client secret registered with the Identity Provider.

- **Account Linking Only**

Toggle to enable the Identity Provider for logging in to existing accounts only.

- **Base URL**

Enter the base URL of the Identity Provider.

- **API URL**

Override the default API URL for this Identity Provider.

4. Click **`Save`** to add **`GitHub Enterprise Server`** as the Identity Provider.

## GitLab

Daytona provides the option to add GitLab as an Identity Provider.

1. Click the **`New +`** button to add an Identity Provider.
2. Select **`GitLab`** as the Identity Provider from the dropdown list.
3. Enter the details of the **`GitLab`** Identity Provider.

- **Client ID**

Enter the client identifier registered with the Identity Provider.

- **Client Secret**

Enter the client secret registered with the Identity Provider.

- **Account Linking Only**

Toggle to enable the Identity Provider for logging in to existing accounts only.

4. Click **`Save`** to add **`GitLab`** as the Identity Provider.

## GitLab Self-Managed

Daytona provides the option to add GitLab Self-Managed as an Identity Provider.

1. Click the **`New +`** button to add an Identity Provider.
2. Select **`GitLab Self-Managed`** as the Identity Provider from the dropdown list.
3. Enter the details of the **`GitLab Self-Managed`** Identity Provider.

- **Client ID**

Enter the client identifier registered with the Identity Provider.

- **Client Secret**

Enter the client secret registered with the Identity Provider.

- **Account Linking Only**

Toggle to enable the Identity Provider for logging in to existing accounts only.

- **Base URL**

Enter the base URL of the Identity Provider.

4. Click **`Save`** to add **`GitLab Self-Managed`** as the Identity Provider.

## Google

Daytona provides the option to add Google as an Identity Provider.

1. Click the **`New +`** button to add an Identity Provider.
2. Select **`Google`** as the Identity Provider from the dropdown list.
3. Enter the details of the **`Google`** Identity Provider.

- **Client ID**

Enter the client identifier registered with the Identity Provider.

- **Client Secret**

Enter the client secret registered with the Identity Provider.

- **Account Linking Only**

Toggle to enable the Identity Provider for logging in to existing accounts only.

- **Hosted Domain**

If specified, it will be validated that the returned identity token has a claim for this domain

4. Click **`Save`** to add **`Google`** as the Identity Provider.

## Microsoft

Daytona provides the option to add Microsoft as an Identity Provider.

1. Click the **`New +`** button to add an Identity Provider.
2. Select **`Microsoft`** as the Identity Provider from the dropdown list.
3. Enter the details of the **`Microsoft`** Identity Provider.

- **Client ID**

Enter the client identifier registered with the Identity Provider.

- **Client Secret**

Enter the client secret registered with the Identity Provider.

- **Account Linking Only**

Toggle to enable the Identity Provider for logging in to existing accounts only.

- **Tenant ID**

If specified, `single-tenant` auth endpoints are used, otherwise `common` multi-tenant endpoints are used.

4. Click **`Save`** to add **`Microsoft`** as the Identity Provider.
4 changes: 2 additions & 2 deletions src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ import DocumentListItem from "@components/DocumentListItem.astro";
href="about/getting-started"
/>
<DocumentListItem
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this list item

title="Identity Providers (IDPs) Installation"
title="Identity Providers Installation"
subtitle="Learn how to install and configure Daytona with Identity Providers."
href="installation/installation"
href="installation/identity-providers"
/>
</DocumentList>

Expand Down
Loading