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

Conversation

stefanicjuraj
Copy link
Contributor

@stefanicjuraj stefanicjuraj commented Oct 4, 2024

Fixes #123
Fixes #177
Fixes #178

Copy link
Member

@fabjanvucina fabjanvucina left a comment

Choose a reason for hiding this comment

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

@ivan-burazin We no longer need instructions on how to use Keycloak for managing identity providers. The admin dashboard in Daytona now fully supports management of these providers.

@stefanicjuraj You should transfer over instructions on how to create oauth applications for each IDP from the /installation/identity-providers page. After that, you can remove that page from the docs.

@fabjanvucina
Copy link
Member

@stefanicjuraj Also, the redirect URI field has been added to the IDP form.

image

Copy link
Member

@ivan-burazin ivan-burazin left a comment

Choose a reason for hiding this comment

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

@stefanicjuraj what is the diff with INSTALLATION IDPs and ADMIN IDPs

@stefanicjuraj
Copy link
Contributor Author

@stefanicjuraj what is the diff with INSTALLATION IDPs and ADMIN IDPs

There will only be administration identity providers for admins to be able to enable certain identity providers, and the users can refer to using them by navigating to the git providers section. I think that's the main gist provided by Fabijan's thoughts:

@stefanicjuraj You should transfer over instructions on how to create oauth applications for each IDP from the /installation/identity-providers page. After that, you can remove that page from the docs.

@stefanicjuraj stefanicjuraj changed the title docs: add identity providers (admin) & modify identity providers (install) docs: add identity providers (admin) & remove identity providers (install) Oct 7, 2024
@ivan-burazin
Copy link
Member

Yes so we should delete the section under INSTALLATION then?

@@ -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

@ivan-burazin
Copy link
Member

@stefanicjuraj ping me when review needed


1. Click the bin icon next to the Identity Provider to remove it.
2. Click **`Delete`** 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


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

Upon adding GitHub as an Identity Provider, you can configure GitHub OAuth to enable users to authenticate with Daytona using their GitHub account.
Copy link
Member

Choose a reason for hiding this comment

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

Before adding GitHub as an Identity Provider, you need to register an OAuth client to enable users to authenticate to Daytona using their GitHub account.

make this change in all of the providers


Upon adding GitHub as an Identity Provider, you can configure GitHub OAuth to enable users to authenticate with Daytona using their GitHub account.

### GitHub OAuth
Copy link
Member

Choose a reason for hiding this comment

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

GitHub OAuth Client


- `Homepage URL` must be set to the URL of your Daytona installation.

- `Authorization callback URL` must be set to the `Redirect URI` used when connecting GitHub as an Identity Provider.
Copy link
Member

Choose a reason for hiding this comment

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

must be set to the Redirect URI value found in the form when adding GitHub as an Identity Provider.

- `Authorization callback URL` must be set to the `Redirect URI` used when connecting GitHub as an Identity Provider.

4. Click **`Register application`** to create the GitHub OAuth App.

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 an another item here that says that the user should copy over the client id and the client secret values to finalize adding GitHub as an IdP.

Please make sure that these "GitHub" changes are reflected accordingly in other IdPs as well

- `Visibility` must be set to `Private` or `Public`.

6. Click **`Create`** to create the project.

Copy link
Member

Choose a reason for hiding this comment

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

There needs to be info where to find client_id, client_secret and tenant_id and that they need to be copied over to the form for adding the IdP

Copy link
Member

Choose a reason for hiding this comment

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

This logic applies for other IdP-s as well. Also, keep in mind that some IdP-s have specific config properties (for example tenant_id for Azure)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Disclaimer for deleting IdP Generic OpenID Connect IdP Identity providers management
3 participants