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

website/integrations: Beszel #12905

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

nicedevil007
Copy link
Contributor

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

  • Local tests pass (ak test authentik/)
  • The code has been formatted (make lint-fix)

If an API change has been made

  • The API schema has been updated (make gen-build)

If changes to the frontend have been made

  • The code has been formatted (make web)

If applicable

  • The documentation has been updated
  • The documentation has been formatted (make website)

@nicedevil007 nicedevil007 requested review from a team as code owners January 31, 2025 20:17
Copy link

netlify bot commented Jan 31, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit d24553e
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/679f298406d5dc0008718a0a

Copy link

netlify bot commented Jan 31, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit d24553e
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/679f2984de045a0008bf38b9
😎 Deploy Preview https://deploy-preview-12905--authentik-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@nicedevil007 nicedevil007 changed the title Beszel website/integrations: Beszel Jan 31, 2025
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]>
Copy link

codecov bot commented Jan 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.66%. Comparing base (7c944b9) to head (d24553e).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #12905      +/-   ##
==========================================
- Coverage   92.75%   92.66%   -0.09%     
==========================================
  Files         769      770       +1     
  Lines       38929    38945      +16     
==========================================
- Hits        36109    36090      -19     
- Misses       2820     2855      +35     
Flag Coverage Δ
e2e 48.46% <ø> (-0.12%) ⬇️
integration 24.59% <ø> (-0.02%) ⬇️
unit 90.37% <ø> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@dominic-r dominic-r left a comment

Choose a reason for hiding this comment

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

This service utilizes Pocketbase as its backend. I believe it would be more beneficial to focus this PR on configuring authentik alongside Pocketbase, as it would support more use cases.

@dominic-r
Copy link
Contributor

dominic-r commented Jan 31, 2025

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

@nicedevil007
Copy link
Contributor Author

This service utilizes Pocketbase as its backend. I believe it would be more beneficial to focus this PR on configuring authentik alongside Pocketbase, as it would support more use cases.

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 there is a pocketbase guide anytime in the future we could change the one from Beszel?

@dominic-r
Copy link
Contributor

This service utilizes Pocketbase as its backend. I believe it would be more beneficial to focus this PR on configuring authentik alongside Pocketbase, as it would support more use cases.

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 there is a pocketbase guide anytime in the future we could change the one from Beszel?

If that's what you prefer, sure. Tho, the UI the user is visiting (/_/#/collections?collection=pb_users_auth) is PB with the default auth table. There's not much to test that hasn't been tested with the configuration from the service.

@nicedevil007
Copy link
Contributor Author

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?

@dominic-r
Copy link
Contributor

I'll review the PR as-is for the moment. Thanks for yet another contribution to authentik. It is greatly appreciated.

@dominic-r
Copy link
Contributor

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?

If that works best for you

@nicedevil007
Copy link
Contributor Author

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 :)

@dominic-r
Copy link
Contributor

Yea, that's perfect

@nicedevil007
Copy link
Contributor Author

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?

@dominic-r
Copy link
Contributor

Last I checked, under api rules of the user table you configure the creation rules.
IMG_1263

@nicedevil007
Copy link
Contributor Author

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 ;)

@nicedevil007
Copy link
Contributor Author

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?

Copy link
Contributor

@dominic-r dominic-r left a comment

Choose a reason for hiding this comment

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

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

2 participants