-
-
Notifications
You must be signed in to change notification settings - Fork 993
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: Pocketbase #12906
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: NiceDevil <[email protected]>
Signed-off-by: NiceDevil <[email protected]>
Signed-off-by: NiceDevil <[email protected]>
✅ Deploy Preview for authentik-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for authentik-storybook canceled.
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #12906 +/- ##
==========================================
- Coverage 92.75% 92.67% -0.09%
==========================================
Files 769 770 +1
Lines 38929 38945 +16
==========================================
- Hits 36109 36092 -17
- Misses 2820 2853 +33
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @nicedevil007, thanks for your contibution. It is greatly appreciated. Here are a few things I noticed. Please do let me know if you have any questions.
This documentation lists only the settings that you need to change from their default values. Be aware that any changes other than those explicitly mentioned in this guide could cause issues accessing your application. | ||
::: | ||
|
||
## authentik configuration |
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.
Note to tana: This should be left as-is for now and I'll update format /button names later on.
|
||
Take note of the Client ID and Client Secret, you'll need to give them to PocketBase later. | ||
|
||
- Redirect URIs/Origins (RegEx): `https://_pocketbase.company_/api/oauth2-redirect` |
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.
I don't see anything in this redirect URI that would warrant it to be set to "regex" instead of "strict". It's best to set it to "strict" unless absolutely needed.
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.
Hi and thank you for your Review. Maybe it my wrong understanding of the Wiki about contribution but I used all "placeholder variables" in italic Font. I switched between different Write options now through my last PRs and Never know what is wanted and what Not.
Can someone clear this up?
- bold stuff for things on the SP side that can be found on the gui f.e.
- itatlic for placeholders
That is what I understood so far. Now it seems to be yet another new formatation here. I get more and more confused.
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.
The Fonts & Fonts styling section of our style guide gives an overview of what's expected. What do you mean by "new formatation here"?
Italic is to be used for variables, yes. Bold for stuff found in the GUI, yes. URLs should be in a codeblock and variables in them should be italicized and the easiest way to do that is the suggestion I gave.
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.
I mean this Part of the Guide
Use italic font for variables or placeholders to make it clear they need to be replaced. Choose placeholder names that highlight their purpose, ensuring users understand what to update.
Thank you for making this clear now :) So I can Go oder my last PRs to Match this Styling :) Will take a Bit of time, but I Like have it "the same" on everything
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.
Could you also address the original review comment? Thanks
I don't see anything in this redirect URI that would warrant it to be set to "regex" instead of "strict". It's best to set it to "strict" unless absolutely needed.
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.
Maybe I copy Pasted wrong line and it was Late at Night. Will get to it tomorrow. But I guess you are right :)
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.
Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: Dominic R <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: Dominic R <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Heya @4d62,
here is my try on getting the "regular" PocketBase Documentation done.
This was suggested as better usecase for authentik vs. PocketBase in general than just creating the same documenation for all Pocketbase applications over and over again.
With this guide we can reference all those applications to this one here :)
This was done prior to this guide where the idea came up: #12905
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
)