website/docs: add . in https://netbird.company* #12166

Marcus1Pierce · 2024-11-23T10:48:15Z

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 <72237814+Marcus1Pierce@users.noreply.github.com>

netlify · 2024-11-23T10:48:31Z

✅ Deploy Preview for authentik-docs ready!

Name	Link
🔨 Latest commit	`d984fa3`
🔍 Latest deploy log	https://app.netlify.com/sites/authentik-docs/deploys/6751e6d5bb824400089313b0
😎 Deploy Preview	https://deploy-preview-12166--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 · 2024-11-23T10:48:32Z

✅ Deploy Preview for authentik-storybook ready!

Name	Link
🔨 Latest commit	`d984fa3`
🔍 Latest deploy log	https://app.netlify.com/sites/authentik-storybook/deploys/6751e6d56fe02e0008e8b075
😎 Deploy Preview	https://deploy-preview-12166--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.

tanberry · 2024-11-26T21:26:26Z

Thanks for this PR @Marcus1Pierce ! So both the period (.) and the asterisk (*) needed to be added, for the Redirect URI, right?

tanberry · 2024-11-26T21:28:14Z

Thanks for this PR @Marcus1Pierce ! So both the period (.) and the asterisk (*) needed to be added, for the Redirect URI, right?

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!

codecov · 2024-11-26T21:30:28Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.70%. Comparing base (695de45) to head (d984fa3).
Report is 11 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #12166      +/-   ##
==========================================
+ Coverage   92.62%   92.70%   +0.07%     
==========================================
  Files         762      762              
  Lines       38152    38152              
==========================================
+ Hits        35338    35368      +30     
+ Misses       2814     2784      -30

Flag	Coverage Δ
e2e	`49.10% <ø> (+0.11%)`	⬆️
integration	`24.76% <ø> (ø)`
unit	`90.22% <ø> (ø)`

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.

BeryJu · 2024-11-26T21:50:07Z

website/integrations/services/netbird/index.md

    ```
    https://netbird.company
-    https://netbird.company*
+    https://netbird.company.*
    http://localhost:53000
    ```


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

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.

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:

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

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

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

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

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.

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

Thanks @Marcus1Pierce , we're getting there. Can you please run make website again, and re-push? Our dependabot bumped the version of the linter we use, and this PR is failing on that check. NOTE: you might need to first run make website-install in order to update the build tools locally, then run make website. Then push to the PR again.

Let us know if any problems.

@tanberry Sorry for the late update. I have tried running make website-install and then make website, but the following error occurred:

[ERROR] Error: Unable to build website for locale en. at tryToBuildLocale (/mnt/d/Visual Studio/GitHub/Marcus1Pierce/authentik/website/node_modules/@docusaurus/core/lib/commands/build/build.js:78:15) at async /mnt/d/Visual Studio/GitHub/Marcus1Pierce/authentik/website/node_modules/@docusaurus/core/lib/commands/build/build.js:34:9 ... 4 lines matching cause stack trace ... at async file:///mnt/d/Visual%20Studio/GitHub/Marcus1Pierce/authentik/website/node_modules/@docusaurus/core/bin/docusaurus.mjs:44:3 { [cause]: Error: Docusaurus found broken links! Please check the pages of your site in the list below, and make sure you don't reference any path that does not exist. Note: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration, and let the build pass. Exhaustive list of all broken links found: - Broken link on source page path = /docs/add-secure-apps/flows-stages/flow/examples/flows: -> linking to /blueprints/example/flows-enrollment-2-stage.yaml -> linking to /blueprints/example/flows-enrollment-email-verification.yaml -> linking to /blueprints/example/flows-login-2fa.yaml -> linking to /blueprints/example/flows-login-conditional-captcha.yaml -> linking to /blueprints/example/flows-recovery-email-verification.yaml -> linking to /blueprints/example/flows-unenrollment.yaml - Broken link on source page path = /docs/users-sources/user/invitations: -> linking to /blueprints/example/flows-enrollment-2-stage.yaml at throwError (/mnt/d/Visual Studio/GitHub/Marcus1Pierce/authentik/website/node_modules/@docusaurus/logger/lib/logger.js:80:11) at reportBrokenLinks (/mnt/d/Visual Studio/GitHub/Marcus1Pierce/authentik/website/node_modules/@docusaurus/core/lib/server/brokenLinks.js:250:47) at handleBrokenLinks (/mnt/d/Visual Studio/GitHub/Marcus1Pierce/authentik/website/node_modules/@docusaurus/core/lib/server/brokenLinks.js:282:5) at executeBrokenLinksCheck (/mnt/d/Visual Studio/GitHub/Marcus1Pierce/authentik/website/node_modules/@docusaurus/core/lib/commands/build/buildLocale.js:91:47) at /mnt/d/Visual Studio/GitHub/Marcus1Pierce/authentik/website/node_modules/@docusaurus/core/lib/commands/build/buildLocale.js:70:67 at Object.async (/mnt/d/Visual Studio/GitHub/Marcus1Pierce/authentik/website/node_modules/@docusaurus/logger/lib/perfLogger.js:42:47) at buildLocale (/mnt/d/Visual Studio/GitHub/Marcus1Pierce/authentik/website/node_modules/@docusaurus/core/lib/commands/build/buildLocale.js:70:31) at async runBuildLocaleTask (/mnt/d/Visual Studio/GitHub/Marcus1Pierce/authentik/website/node_modules/@docusaurus/core/lib/commands/build/build.js:93:5) at async /mnt/d/Visual Studio/GitHub/Marcus1Pierce/authentik/website/node_modules/@docusaurus/core/lib/commands/build/build.js:74:13 at async tryToBuildLocale (/mnt/d/Visual Studio/GitHub/Marcus1Pierce/authentik/website/node_modules/@docusaurus/core/lib/commands/build/build.js:70:9) at async /mnt/d/Visual Studio/GitHub/Marcus1Pierce/authentik/website/node_modules/@docusaurus/core/lib/commands/build/build.js:34:9 at async mapAsyncSequential (/mnt/d/Visual Studio/GitHub/Marcus1Pierce/authentik/website/node_modules/@docusaurus/utils/lib/jsUtils.js:21:24) at async Command.build (/mnt/d/Visual Studio/GitHub/Marcus1Pierce/authentik/website/node_modules/@docusaurus/core/lib/commands/build/build.js:33:5) at async Promise.all (index 0) at async runCLI (/mnt/d/Visual Studio/GitHub/Marcus1Pierce/authentik/website/node_modules/@docusaurus/core/lib/commands/cli.js:56:5) at async file:///mnt/d/Visual%20Studio/GitHub/Marcus1Pierce/authentik/website/node_modules/@docusaurus/core/bin/docusaurus.mjs:44:3 } [INFO] Docusaurus version: 3.6.2 Node version: v18.19.1 make: *** [Makefile:250: website-build] Error 1

tanberry

Thanks!~

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

Change https://netbird.company* to https://netbird.company/.* Signed-off-by: Marcus1Pierce <72237814+Marcus1Pierce@users.noreply.github.com>

tanberry

Thanks again @Marcus1Pierce sorry for the build drama. ;-)

.gitignore

Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>

Marcus1Pierce · 2024-12-06T14:07:05Z

@rissson @tanberry Sorry, it seems I made a mistake. In the regex, it should be https://netbird.company/.* instead of https://netbird.company/.\*. Could you please help to change it? Once again, I apologize for not checking it thoroughly. In the future, I will open issues instead of pull requests to prevent this from happening again. I'm really sorry. I am currently unable to open the editor to fix it.

rissson · 2024-12-06T14:39:58Z

No worries @Marcus1Pierce, mistakes happen. I just opened #12284 to fix this. Feel free to keep making PRs, they are always welcomed!

tanberry · 2024-12-06T15:48:30Z

Yes, thank you again @Marcus1Pierce, we really appreciate the PRs, and I apologize for my messy handling of this one! As @rissson says, PRs are always welcome! Thanks again.

Marcus1Pierce · 2024-12-08T12:53:35Z

Thank you @tanberry @rissson

[Merge note: The two strings that were manually updated translate to, according to Google Translate: "Evaluate the policies once the stage is presented to the user." (note the past tense) "Evaluate the policies when the level is visible to the user." (note the ambiguous tense) * main: (226 commits) website/docs: add page about the Cobalt pentest (#12249) core: bump aws-cdk-lib from 2.171.1 to 2.172.0 (#12296) website: bump aws-cdk from 2.171.1 to 2.172.0 in /website (#12295) core: bump sentry-sdk from 2.19.1 to 2.19.2 (#12297) core: bump coverage from 7.6.8 to 7.6.9 (#12299) core, web: update translations (#12290) root: fix override locale only if it is not empty (#12283) translate: Updates for file web/xliff/en.xlf in fr (#12276) core: bump twilio from 9.3.7 to 9.3.8 (#12282) website: bump path-to-regexp and express in /website (#12279) core: bump sentry-sdk from 2.19.0 to 2.19.1 (#12280) core: bump ruff from 0.8.1 to 0.8.2 (#12281) website/docs: fix lint (#12287) website/integrations: netbird: fix redirect URI regex (#12284) web: simplify `?inline` handler for Storybook (#12246) website/docs: Update Traefik middleware example to reflect latest version of Traefik (#12267) website/docs: add . in https://netbird.company* (#12166) core: bump goauthentik.io/api/v3 from 3.2024104.1 to 3.2024104.2 (#12263) core: bump pydantic from 2.10.2 to 2.10.3 (#12262) core: bump github.com/getsentry/sentry-go from 0.29.1 to 0.30.0 (#12264) ...

* main: web: simplify `?inline` handler for Storybook (#12246) website/docs: Update Traefik middleware example to reflect latest version of Traefik (#12267) website/docs: add . in https://netbird.company* (#12166) core: bump goauthentik.io/api/v3 from 3.2024104.1 to 3.2024104.2 (#12263) core: bump pydantic from 2.10.2 to 2.10.3 (#12262) core: bump github.com/getsentry/sentry-go from 0.29.1 to 0.30.0 (#12264) core, web: update translations (#12268) website: bump @types/react from 18.3.12 to 18.3.13 in /website (#12269) website: bump prettier from 3.4.1 to 3.4.2 in /website (#12270) ci: bump actions/attest-build-provenance from 1 to 2 (#12271) core: bump golang.org/x/sync from 0.9.0 to 0.10.0 (#12272) core: bump django from 5.0.9 to 5.0.10 (#12273) core: bump webauthn from 2.3.0 to 2.4.0 (#12274) website/integrations: add The Lounge (#11971) core: bump python-kadmin-rs from 0.3.0 to 0.4.0 (#12257) root: fix health status code (#12255) ci: fix should_push always being false (#12252) web: bump API Client version (#12251) providers/oauth2: Add provider federation between OAuth2 Providers (#12083) website/integrations: mastodon: set correct uid field (#11945)

Marcus1Pierce requested a review from a team as a code owner November 23, 2024 10:48

BeryJu reviewed Nov 26, 2024

View reviewed changes

tanberry approved these changes Nov 26, 2024

View reviewed changes

Marcus1Pierce and others added 6 commits November 28, 2024 07:50

Merge branch 'goauthentik:main' into patch-1

8148109

Update index.md

6078ab2

Change https://netbird.company* to https://netbird.company/.* Signed-off-by: Marcus1Pierce <72237814+Marcus1Pierce@users.noreply.github.com>

Merge branch 'goauthentik:main' into patch-1

3b85690

Merge branch 'goauthentik:main' into patch-1

2273d2d

Add . in https://netbird.company*

a754626

Add . in https://netbird.company*

29c358d

Marcus1Pierce requested review from a team as code owners December 5, 2024 05:03

tanberry approved these changes Dec 5, 2024

View reviewed changes

rissson reviewed Dec 5, 2024

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

Update .gitignore

d984fa3

Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>

rissson removed request for a team December 5, 2024 17:46

rissson enabled auto-merge (squash) December 5, 2024 17:50

rissson merged commit 672ba72 into goauthentik:main Dec 5, 2024
65 of 66 checks passed

rissson mentioned this pull request Dec 6, 2024

website/integrations: netbird: fix redirect URI regex #12284

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

website/docs: add . in https://netbird.company* #12166

website/docs: add . in https://netbird.company* #12166

Marcus1Pierce commented Nov 23, 2024

netlify bot commented Nov 23, 2024 •

edited

Loading

netlify bot commented Nov 23, 2024 •

edited

Loading

tanberry commented Nov 26, 2024

tanberry commented Nov 26, 2024 •

edited

Loading

codecov bot commented Nov 26, 2024 •

edited

Loading

BeryJu Nov 26, 2024

Marcus1Pierce Nov 26, 2024

tanberry Nov 26, 2024

Marcus1Pierce Nov 26, 2024

BeryJu Nov 27, 2024

tanberry Nov 27, 2024

Marcus1Pierce Nov 28, 2024

tanberry Dec 2, 2024

Marcus1Pierce Dec 4, 2024

tanberry left a comment •

edited

Loading

tanberry left a comment

Marcus1Pierce commented Dec 6, 2024

rissson commented Dec 6, 2024

tanberry commented Dec 6, 2024

Marcus1Pierce commented Dec 8, 2024

website/docs: add . in https://netbird.company* #12166

website/docs: add . in https://netbird.company* #12166

Conversation

Marcus1Pierce commented Nov 23, 2024

Details

Checklist

netlify bot commented Nov 23, 2024 • edited Loading

✅ Deploy Preview for authentik-docs ready!

netlify bot commented Nov 23, 2024 • edited Loading

✅ Deploy Preview for authentik-storybook ready!

tanberry commented Nov 26, 2024

tanberry commented Nov 26, 2024 • edited Loading

codecov bot commented Nov 26, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tanberry left a comment • edited Loading

Choose a reason for hiding this comment

tanberry left a comment

Choose a reason for hiding this comment

Marcus1Pierce commented Dec 6, 2024

rissson commented Dec 6, 2024

tanberry commented Dec 6, 2024

Marcus1Pierce commented Dec 8, 2024

netlify bot commented Nov 23, 2024 •

edited

Loading

netlify bot commented Nov 23, 2024 •

edited

Loading

tanberry commented Nov 26, 2024 •

edited

Loading

codecov bot commented Nov 26, 2024 •

edited

Loading

tanberry left a comment •

edited

Loading