website/integrations: Pocketbase #12906

nicedevil007 · 2025-01-31T21:37:41Z

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

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)

Signed-off-by: NiceDevil <[email protected]>

netlify · 2025-01-31T21:38:01Z

✅ Deploy Preview for authentik-docs ready!

Name	Link
🔨 Latest commit	`dc43e81`
🔍 Latest deploy log	https://app.netlify.com/sites/authentik-docs/deploys/67aa1ebb60a1850008b741ef
😎 Deploy Preview	https://deploy-preview-12906--authentik-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

netlify · 2025-01-31T21:38:02Z

✅ Deploy Preview for authentik-storybook ready!

Name	Link
🔨 Latest commit	`dc43e81`
🔍 Latest deploy log	https://app.netlify.com/sites/authentik-storybook/deploys/67aa1ebb65045000089cb4cd
😎 Deploy Preview	https://deploy-preview-12906--authentik-storybook.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

codecov · 2025-01-31T21:43:12Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.74%. Comparing base (7c944b9) to head (dc43e81).
Report is 28 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #12906      +/-   ##
==========================================
- Coverage   92.75%   92.74%   -0.01%     
==========================================
  Files         769      785      +16     
  Lines       38929    39580     +651     
==========================================
+ Hits        36109    36710     +601     
- Misses       2820     2870      +50

Flag	Coverage Δ
e2e	`48.50% <ø> (-0.07%)`	⬇️
integration	`24.54% <ø> (-0.07%)`	⬇️
unit	`90.42% <ø> (+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.

dominic-r

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.

dominic-r · 2025-02-01T18:30:50Z

website/integrations/services/pocketbase/index.mdx

+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


Note to tana: This should be left as-is for now and I'll update format /button names later on.

dominic-r · 2025-02-01T18:32:07Z

website/integrations/services/pocketbase/index.mdx

+
+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`


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.

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.

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.

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

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.

Maybe I copy Pasted wrong line and it was Late at Night. Will get to it tomorrow. But I guess you are right :)

So I always wrote it like the menu entry is in authentik:

"Redirect URIs/Origins (RegEx)" is the setting we have to set. But it doesn't mean that we should choose RegEx on the dropdown, so how should I do it now?

Hey, @nicedevil007, you make a good point about possible confusion. However, I'd say that RegEx is the overarching category (so it is good to have it on the label), andstrict is a form of Regex. So the field label makes sense to say Regex... then you have to specify whether you want to use regular regex or a strict expression. Does that make sense?

website/integrations/services/pocketbase/index.mdx

Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>

website/integrations/services/pocketbase/index.mdx

Co-authored-by: Dominic R <[email protected]> Signed-off-by: NiceDevil <[email protected]>

dominic-r

Hi, thanks for taking the time to write this documentation. Here are a few things I noticed. Please do LMK if you have any questions

website/integrations/services/pocketbase/index.mdx

dominic-r · 2025-02-03T20:37:29Z

website/integrations/services/pocketbase/index.mdx

+    - Set **Display name** to `authentik`.
+    - Set **Auth URL** to <kbd>https://<em>authentik.company</em>/application/o/authorize/</kbd>.
+    - Set **Token URL** to <kbd>https://<em>authentik.company</em>/application/o/token/</kbd>.
+    - Make sure **Fetch user info from** is set to `User info URL`, then set **User info URL** to <kbd>https://<em>authentik.company</em>/application/o/userinfo/</kbd>


Would it be possible to add a Configuration validation section as outlined in the template?

I had one for Test the login, and you told me that it is not possible to test the login like this because PB is only the backend and users are always redirected to the application.

#12906 (comment)

So I removed the part as you adviced and now I should add it back again?

Maybe I missunderstood your old comment on Beszel: #12905 (comment)

I would go the route to do the "backend stuff" here in this guide and if there is a part where the user can verify that he did everything correct, then this should be part of the guide of the frontend application like Beszel, what do you think?

website/integrations/services/pocketbase/index.mdx

dominic-r

LGTM. Thanks for your contribution to authentik!

nicedevil007 and others added 5 commits January 31, 2025 22:17

initial release

511de48

Ready for PR

2b31de3

rollback to default package.json

f133646

Signed-off-by: NiceDevil <[email protected]>

rollback to default again

a995ff9

Signed-off-by: NiceDevil <[email protected]>

last one I missed...

cb52a38

Signed-off-by: NiceDevil <[email protected]>

nicedevil007 requested a review from a team as a code owner January 31, 2025 21:37

dominic-r suggested changes Feb 1, 2025

View reviewed changes

nicedevil007 and others added 11 commits February 1, 2025 22:38

index.mdx aktualisieren

6d07e9f

Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>

index.mdx aktualisieren

34fdcd3

Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>

index.mdx aktualisieren

8446153

Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>

index.mdx aktualisieren

125037d

Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>

index.mdx aktualisieren

4989918

Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>

index.mdx aktualisieren

3b7b181

Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>

index.mdx aktualisieren

37e6e5b

Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>

index.mdx aktualisieren

590520e

Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>

index.mdx aktualisieren

8e3bdcf

Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>

index.mdx aktualisieren

340a946

Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>

index.mdx aktualisieren

4ef4c14

Co-authored-by: dominic-r <[email protected]> Signed-off-by: NiceDevil <[email protected]>

dominic-r reviewed Feb 1, 2025

View reviewed changes

website/integrations/services/pocketbase/index.mdx Outdated Show resolved Hide resolved

nicedevil007 and others added 4 commits February 1, 2025 22:50

index.mdx aktualisieren

1508e49

Co-authored-by: Dominic R <[email protected]> Signed-off-by: NiceDevil <[email protected]>

index.mdx aktualisieren

9a983b3

Co-authored-by: Dominic R <[email protected]> Signed-off-by: NiceDevil <[email protected]>

Update because Fonts & Fonts styling guide

f56b962

same format as other PRs from 1-2weeks ago

458720b

dominic-r suggested changes Feb 3, 2025

View reviewed changes

changes from comments

dc43e81

dominic-r approved these changes Feb 24, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

website/integrations: Pocketbase #12906

website/integrations: Pocketbase #12906

nicedevil007 commented Jan 31, 2025

netlify bot commented Jan 31, 2025 •

edited

Loading

netlify bot commented Jan 31, 2025 •

edited

Loading

codecov bot commented Jan 31, 2025 •

edited

Loading

dominic-r left a comment

dominic-r Feb 1, 2025

dominic-r Feb 1, 2025

nicedevil007 Feb 1, 2025

dominic-r Feb 1, 2025

nicedevil007 Feb 1, 2025 •

edited

Loading

dominic-r Feb 1, 2025 •

edited

Loading

nicedevil007 Feb 1, 2025

nicedevil007 Feb 2, 2025

tanberry Feb 25, 2025 •

edited

Loading

dominic-r left a comment

dominic-r Feb 3, 2025

nicedevil007 Feb 10, 2025 •

edited

Loading

dominic-r left a comment


		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`

website/integrations: Pocketbase #12906

Are you sure you want to change the base?

website/integrations: Pocketbase #12906

Conversation

nicedevil007 commented Jan 31, 2025

Checklist

netlify bot commented Jan 31, 2025 • edited Loading

✅ Deploy Preview for authentik-docs ready!

netlify bot commented Jan 31, 2025 • edited Loading

✅ Deploy Preview for authentik-storybook ready!

codecov bot commented Jan 31, 2025 • edited Loading

Codecov Report

dominic-r left a comment

Choose a reason for hiding this comment

dominic-r Feb 1, 2025

Choose a reason for hiding this comment

dominic-r Feb 1, 2025

Choose a reason for hiding this comment

nicedevil007 Feb 1, 2025

Choose a reason for hiding this comment

dominic-r Feb 1, 2025

Choose a reason for hiding this comment

nicedevil007 Feb 1, 2025 • edited Loading

Choose a reason for hiding this comment

dominic-r Feb 1, 2025 • edited Loading

Choose a reason for hiding this comment

nicedevil007 Feb 1, 2025

Choose a reason for hiding this comment

nicedevil007 Feb 2, 2025

Choose a reason for hiding this comment

tanberry Feb 25, 2025 • edited Loading

Choose a reason for hiding this comment

dominic-r left a comment

Choose a reason for hiding this comment

dominic-r Feb 3, 2025

Choose a reason for hiding this comment

nicedevil007 Feb 10, 2025 • edited Loading

Choose a reason for hiding this comment

dominic-r left a comment

Choose a reason for hiding this comment

netlify bot commented Jan 31, 2025 •

edited

Loading

netlify bot commented Jan 31, 2025 •

edited

Loading

codecov bot commented Jan 31, 2025 •

edited

Loading

nicedevil007 Feb 1, 2025 •

edited

Loading

dominic-r Feb 1, 2025 •

edited

Loading

tanberry Feb 25, 2025 •

edited

Loading

nicedevil007 Feb 10, 2025 •

edited

Loading