website/integrations: Open WebUI #12939
Conversation
✅ Deploy Preview for authentik-storybook canceled.
|
✅ Deploy Preview for authentik-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #12939 +/- ##
==========================================
+ Coverage 92.66% 92.69% +0.02%
==========================================
Files 770 785 +15
Lines 38945 39580 +635
==========================================
+ Hits 36090 36689 +599
- Misses 2855 2891 +36
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Hi @nicedevil007 , thank you for yet another another another contribution recently! Here are a few things I noticed that would make this doc page better. Please do let me know if you have any questions!
Co-authored-by: Dominic R <dominic@sdko.org> Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com>
Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com>
Co-authored-by: Dominic R <dominic@sdko.org> Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com>
|
Thanks @nicedevil007 for this PR! Can you rerun the |
Oh sry missed this. Will do later, maybe 4-5hours when I'm back home :) |
|
hope now it is correct :) |
There was a problem hiding this comment.
Looks great to me, thanks again @nicedevil007! @dominic-r did you have any outstanding edits you saw?
|
Hmmm nope Tana. looks good here |
| :::note | ||
| Users are automatically created, but an administrator must update their role to at least **User** via the WebGUI. | ||
| To do so, log in as an administrator and access the **Admin Panel** (URL: <kbd>https://openwebui.company</kbd>/admin/users). | ||
| Click on the user whose role should be increased from **Pending** to at least **User**. | ||
| More details on how to administer Open WebUI can be found here <kbd>https://docs.openwebui.com/</kbd>. | ||
| ::: |
There was a problem hiding this comment.
From the docs, this can be managed by providing a custom claim with proper roles. It would be a better user experience to indicate that in the docs instead of manually requiring the admin to change the role every time a user is created.
There was a problem hiding this comment.
Heya, this is absolutely true but I thought the aim of the docs on authentik should only get anyone to the point to be able to login and any additional configuration should be done by yourself. Otherwise we have to do an analysis for each service provider and write the same docs here as it is pointed out in each of the service providers' documentation.
I mean I can do it but I guess this going against the note that is in each guide right now. (Guide includes only settings that should be changed from default values....)
@tanberry @dominic-r should I do it or leave this version as it is right now?
There was a problem hiding this comment.
There are a bunch of places where we do provide that information, for instance the Grafana docs. IMO this should've made it in. At the very least, there should've been a pointer to that specific version in the upstream docs. If you're up for it, I'd love a follow up PRs with instructions for this
There was a problem hiding this comment.
Yes, while true that we can try to keep these integration instructions as generic as possible (to your point @nicedevil007 ), it's more important to provide docs that follow "best practices"... so if a best practice is to use a custom claim with proper roles, we should document that. At very least, mention it.
Would this work:
Users are automatically created, but an administrator must update their role to at least **User** via the WebGUI. Alternatively, you can use [OAuth role management](https://docs.openwebui.com/features/sso/#oauth-role-management) to configure the provider to return roles in the access token.
Apologies I merged this without seeing your comment @rissson.
Details
And another one from me :) Hope this fits best from all my PRs now :)
Checklist
ak test authentik/)make lint-fix)If an API change has been made
make gen-build)If changes to the frontend have been made
make web)If applicable
make website)