website/integrations: Beszel #12905
website/integrations: Beszel #12905
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. |
Used these commands after fresh git pull: make lint-fix && npx prettier --write ./website/integrations/services/beszel/index.mdx && make website Signed-off-by: NiceDevil <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #12905 +/- ##
==========================================
- Coverage 92.75% 92.73% -0.03%
==========================================
Files 769 794 +25
Lines 38929 40425 +1496
==========================================
+ Hits 36109 37487 +1378
- Misses 2820 2938 +118
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
It would be more of a general purpose guide, then you could make a different page for Beszel, reference this guide, and add some service specific configuration. That's if you're up to it. Otherwise, I can review the PR as-is. Whatever works best for you. LMK what you prefer or if you have any questions/ideas. Just thinking long-term ATM |
I agree with you but I don't know how I can do that without the real tests beeing done. As you might know, I'm not that devguy that deploy own applications and use backends like pocketbase on developing ;) |
If that's what you prefer, sure. Tho, the UI the user is visiting ( |
|
ok, so I can do another PR for pocketbase, you take a look at it, if this is not going the right direction we stay to you "only" Beszel docs ok? |
|
I'll review the PR as-is for the moment. Thanks for yet another contribution to authentik. It is greatly appreciated. |
If that works best for you |
|
I can do it in parallel so maybe you will tell me "Nice...what are you trying to tell us with this guide..." and then this one is already close to be "merged" maybe :) |
|
Yea, that's perfect |
I ask here, because no new PR right now => do you have any information about the automatic/manual usercreation with pocketbase? Is this a feature Beszel added to it or is it always the same for this backend? |
|
Last I checked, under api rules of the user table you configure the creation rules. |
|
ok so I assume I can remove the part with the user creation from the guide at all, because we are using the docs in default state to get authentik up and running and not with user choosen details on each application ;) |
|
so... I guess I'm done with the code for PocketBase... do you have an example for an already existing integration that relies on any other service that I can use as a template for Beszel? |
There was a problem hiding this comment.
Hi @nicedevil007, Thanks for yet another conribution to authentik! Real quick, could you also apply the same suggestions from the Pocketbase PR? I'll review the remaining changes once that's done.
As @4d62 suggestet, here is the much simpler version as it uses 1:1 settings from PocketBase
|
is here something missing from my side to get this PR merged? |
Hi, as always, I am playing catchup, sorry! @dominic-r what else is needed, if anything, for this PR? |
|
|
||
| ## Preparation | ||
|
|
||
| Since Beszel uses PocketBase as its backend, you only need to replace the PocketBase placeholders with the placeholders found on this page. |
There was a problem hiding this comment.
I think we need to more clearly explain the dependencies between PB and Beszel. And, even though it is not great to have to duplicate content, I don't think we should ask readers to have to go read other docs (the PB docs). I'll make a pass at a compromise idea.. we can see how it looks.
Question: does a user have to also configure PB as part of this Beszel setup? Or if they already set up PB before, do they not need to do anything?
There was a problem hiding this comment.
You install Beszel and it already comes with Pocketbase installed as its backend, no need for separate setup steps to get Pocketbase Running.
First I did a Guide on only Beszel and the Suggestion was to create a seperate Pocketbase doc so wie can reference to this one because the setup will always be the same of Pocketbase is Süd as the backend.
So how to make it more easy for endusers... I Hope you have good idea 😁
There was a problem hiding this comment.
oh oh, so two possibilities:
-
IF they already have integrated PB, they still have to also do these steps for Beszel (basically the same steps as for PB but diff FQDNs of course),
-
if they have not yet installed PB, and they want to install Beszel, then they DO NOT have to also install PB also. It will come with the PB integration.
Is this correct @nicedevil007 ? Thank you for your bravery and patience... :-)
There was a problem hiding this comment.
this is correct, I followed the comment here to split those up,. If I have to revert back to the only Beszel Docs without pocketbase I have to say sorry, we close this then and I don't know who I can trust on advices here anymore :(
There was a problem hiding this comment.
Thanks as always @nicedevil007 for your contributions! This PR is a bit complex, because of the dependency with PocketBase. Take a look at my suggestions and let us know what you think.
Co-authored-by: Tana M Berry <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: Tana M Berry <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: Tana M Berry <[email protected]> Signed-off-by: NiceDevil <[email protected]>
|
Hi @nicedevil007 if it is ok with you I am going to pull in your PR and work on it locally, then push my changes as a PR into yours. ;-) This is a complex one, and I want to make it clear that users don't have to install PB unless they want to. |
|
Sure, no Problem at all. 👍 |
|
OK @nicedevil007 apologies for the complete reverse of earlier guidance from us, I went and added in all of the full steps for authentik configuration and Beszel configuration. It took me a bot to understand that Beszel and Pocketbook truly are independent enough that they need completely separate (even if 99% duplicated content) guides. Please review especially the setps for the Beszel configuration. I used the steps from PB... please review URLs, etc. I'm confident we will get this merged soon! Thank you again. |
|
@tanberry Took you a bot and me 🤣 anyways, nits (internal only): https://app.slack.com/archives/D08DJE7JYD7/p1741986741812229 |
Signed-off-by: Tana M Berry <[email protected]>
Signed-off-by: Tana M Berry <[email protected]>
| - **Choose a Provider type**: OAuth2/OpenID | ||
| - **Configure the Provider**: provide a name (or accept the auto-provided name), the authorization flow to use for this provider, and any required configurations. | ||
| - Note the **Client ID**, **Client Secret**, and **slug** values because they will be required later. | ||
| - Set a `Strict` redirect URI to `https://pgadmin.company/oauth2/authorize`. |
There was a problem hiding this comment.
| - Set a `Strict` redirect URI to `https://pgadmin.company/oauth2/authorize`. | |
| - Set a `Strict` redirect URI to `https://beszel.company/oauth2/authorize`. |
There was a problem hiding this comment.
make sure you got the right redir url too and kbd/em please. see slack for corrected ver
There was a problem hiding this comment.
| - Set a `Strict` redirect URI to `https://pgadmin.company/oauth2/authorize`. | |
| - Set a `Strict` redirect URI to <kbd>https://<em>beszel.company</em>/oauth2/authorize</kbd>. |
There was a problem hiding this comment.
correct one would be this https://beszel.company/api/oauth2-redirect
I hope my edit on the file was done correctly, never done a suggestion for edit of a file on github
Signed-off-by: NiceDevil <[email protected]>
Details
Found a new tool that I tested and is able to use authentik for awesome login ;) Here is my guide.
For reference if you want to correct my english or just don't know what I wanted to describe without screenshots.
Here is the "default guide" found on the beszel homepage without the parts for authentik.
https://beszel.dev/guide/oauth
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)