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/docs: add . in https://netbird.company* #12166

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

Conversation

Marcus1Pierce
Copy link

Details

From the documentation https://docs.netbird.io/selfhosted/identity-providers#authentik, the domain must have a . in https://netbird.company.* or you will experience a redirect error.


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)

From the documentation https://docs.netbird.io/selfhosted/identity-providers#authentik, the domain must have a . in https://netbird.company.* or you will experience a redirect error.

Signed-off-by: Marcus1Pierce <[email protected]>
@Marcus1Pierce Marcus1Pierce requested a review from a team as a code owner November 23, 2024 10:48
Copy link

netlify bot commented Nov 23, 2024

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 6078ab2
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/6747bf95e6f22100083aea25
😎 Deploy Preview https://deploy-preview-12166--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.

Copy link

netlify bot commented Nov 23, 2024

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 6078ab2
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/6747bf959fa78d00082b11ad

@tanberry
Copy link
Contributor

Thanks for this PR @Marcus1Pierce ! So both the period (.) and the asterisk (*) needed to be added, for the Redirect URI, right?
Screenshot 2024-11-26 at 3 24 57 PM

@tanberry
Copy link
Contributor

tanberry commented Nov 26, 2024

Thanks for this PR @Marcus1Pierce ! So both the period (.) and the asterisk (*) needed to be added, for the Redirect URI, right? Screenshot 2024-11-26 at 3 24 57 PM

oh, wait, I see... it's the second line you corrected, the asterisk was already there, you added the period. Got it. Thanks so much!

Copy link

codecov bot commented Nov 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.61%. Comparing base (f9e8138) to head (6078ab2).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #12166      +/-   ##
==========================================
- Coverage   92.69%   92.61%   -0.08%     
==========================================
  Files         761      761              
  Lines       38050    38050              
==========================================
- Hits        35270    35241      -29     
- Misses       2780     2809      +29     
Flag Coverage Δ
e2e 49.12% <ø> (-0.12%) ⬇️
integration 24.83% <ø> (ø)
unit 90.20% <ø> (ø)

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.

Comment on lines 32 to 36
```
https://netbird.company
https://netbird.company*
https://netbird.company.*
http://localhost:53000
```
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
```
https://netbird.company
https://netbird.company*
https://netbird.company.*
http://localhost:53000
```
- Strict; https://netbird.company
- Regex; https://netbird.company/.*
- Strict; http://localhost:53000

I'm not sure about the 2nd entry in the list, but just having .* at the end would be an insecure configuration

Copy link
Author

Choose a reason for hiding this comment

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

I tried with https://netbird.company/.* or https://netbird.company.* and it seems there are no issues. But if I don't add .* to the regex (ex. https://netbird.company/* or https://netbird.company*), for some reason, the Redirect URI Error always appears as shown in the image.

image

Copy link
Contributor

Choose a reason for hiding this comment

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

OK, thanks @Marcus1Pierce for your patience. In the last release, we updated the Redirect URI fields such that you can select Strict or Regex format. So exactly as @BeryJu 's suggested change shows, we want users to indicate that it is Regex if they use the https://netbird.company/.* format.

Here's what that field looks like now:
Screenshot 2024-11-26 at 5 13 35 PM

Copy link
Author

Choose a reason for hiding this comment

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

@tanberry I tried as suggested by @BeryJu and everything works fine.

image

Or as suggested on the website https://docs.netbird.io/selfhosted/identity-providers#authentik (all using regex) as below also works fine.

image

I don't know which is the best, but from what I tried, everything works fine.

Copy link
Member

Choose a reason for hiding this comment

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

Using all regex is insecure without escaping (which is why we added the configuration options for the comparison mode)

Copy link
Contributor

Choose a reason for hiding this comment

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

Hi again @Marcus1Pierce good to hear this works. Please make the change to the file with @BeryJu 's suggestion, run the linters again (make website), and push again, and then we can merge.

Copy link
Author

Choose a reason for hiding this comment

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

@tanberry I have edited it again according to the suggestion by @BeryJu.

Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

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

Thanks!~

Oh. Oops, I just saw @BeryJu 's comment. Sorry, we will get back to this one...

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.

3 participants