-
Notifications
You must be signed in to change notification settings - Fork 13
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
base: main
Are you sure you want to change the base?
docs: add identity providers (admin) & remove identity providers (install) #157
Conversation
Signed-off-by: stefanicjuraj <[email protected]>
There was a problem hiding this 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.
@stefanicjuraj Also, the redirect URI field has been added to the IDP form. |
Signed-off-by: stefanicjuraj <[email protected]>
There was a problem hiding this 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
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
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:
|
Yes so we should delete the section under INSTALLATION then? |
src/content/docs/index.mdx
Outdated
@@ -44,9 +44,9 @@ import DocumentListItem from "@components/DocumentListItem.astro"; | |||
href="about/getting-started" | |||
/> | |||
<DocumentListItem |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove this list item
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
@stefanicjuraj ping me when review needed |
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
|
||
1. Click the bin icon next to the Identity Provider to remove it. | ||
2. Click **`Delete`** to confirm the deletion. | ||
|
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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. | ||
|
There was a problem hiding this comment.
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. | ||
|
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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)
Signed-off-by: stefanicjuraj <[email protected]>
Signed-off-by: stefanicjuraj <[email protected]>
Fixes #123
Fixes #177
Fixes #178