website/integrations: Update to Wizard and Styling Guide by nicedevil007 · Pull Request #12919 · goauthentik/authentik

nicedevil007 · 2025-02-02T09:22:13Z

Used new knowledge on how to better contribute to update my "old" OAuth Docs.
Ty @dominic-r

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)

netlify · 2025-02-02T09:22:32Z

✅ Deploy Preview for authentik-storybook canceled.

Name	Link
🔨 Latest commit	`826716c`
🔍 Latest deploy log	https://app.netlify.com/sites/authentik-storybook/deploys/679f9727f09d6600084bbace

netlify · 2025-02-02T09:22:34Z

✅ Deploy Preview for authentik-docs ready!

Name	Link
🔨 Latest commit	`826716c`
🔍 Latest deploy log	https://app.netlify.com/sites/authentik-docs/deploys/679f9727d8cfff000903a8fd
😎 Deploy Preview	https://deploy-preview-12919--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.

codecov · 2025-02-02T09:28:15Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.72%. Comparing base (7686d12) to head (826716c).
Report is 119 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #12919   +/-   ##
=======================================
  Coverage   92.72%   92.72%           
=======================================
  Files         770      770           
  Lines       38945    38945           
=======================================
  Hits        36113    36113           
  Misses       2832     2832

Flag	Coverage Δ
e2e	`48.54% <ø> (ø)`
integration	`24.59% <ø> (ø)`
unit	`90.37% <ø> (ø)`

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, thank you for your contribution! Unfortunately, some of the changes in this PR will have to be superseded by this PR due to the nature/quantity of the changes. #12716 and merging as-is would cause unnecessary merge conflicts.

Please do let me know when the duplicate part(s) are removed and i'd be happy to take a look at this

#12716 Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com>

nicedevil007 · 2025-02-02T16:05:40Z

Guess actual budget was the only one that was in the PR mentioned. So I took a look at the other changes on the PR you linked here. As I go over my old PRs files I found the setting:

Select implicit or explicit authorization flow as desired.

Should this not be in all PRs that reference the Wizard to create the SP/App.

And yes I know: Would be a story for an other day :) I guess the maingoal of all you nice guys here that are responsible for documentation want to change all guides to the Wizard at anytime.

dominic-r · 2025-02-02T17:36:16Z

Actually, it's not just changing all to use the wizard, naming all throughout the docs also needs to get updated as the word "wizard" will no longer appear in the UI. As for the setting you found, I do believe the following sentence from the new template includes this:
provide a name (or accept the auto-provided name), the authorization flow to use for this provider, and the following required configurations.

nicedevil007 · 2025-02-02T18:13:20Z

Actually, it's not just changing all to use the wizard, naming all throughout the docs also needs to get updated as the word "wizard" will no longer appear in the UI. As for the setting you found, I do believe the following sentence from the new template includes this: provide a name (or accept the auto-provided name), the authorization flow to use for this provider, and the following required configurations.

ok :) so this PR is there anything I should do right now?

dominic-r

Hi. Thanks for this! Just a few things I noticed. Other than that, it looks quite good and I appreciate the time you took to update your previous contributions. Once this PR is accepted by @tanberry as well as myself, I'll merge relevant changes to my working branch to add the React component/new authentik configuration format. Nevertheless, it is greatly appreciated 🙏

dominic-r · 2025-02-03T20:26:38Z

website/integrations/services/engomo/index.mdx

@@ -0,0 +1,87 @@
+---


Why is the engomo documentation renamed to use a mdx file? No React components are being used. It doesn't really matter that much as it shows up in the UI the same, I'm just curious. I'll be sure to outline this in the style guide!

Thought this is the right format nowadays, so I used the update to get to this file extension as well. Was the one I took on most of my other PRs as well. Just to be honest, I never thought about it what is the right or wrong one. Just wanted to make everything similar 🙈

Makese sense 🤣

dominic-r · 2025-02-03T20:26:56Z

website/integrations/services/rustdesk-pro/index.mdx

 >
 > -- https://rustdesk.com/
+>
+> This guide explains how to configure Rustdesk Server Pro to use authentik as the OAuth provider for logging in to the Web GUI.


This added sentence is not part of the integration template.

Was a line on all my other docs why I added it here now as well. As I started making docs for authentik I just copied anyone else others doc from a different app and started from this point 😂

haha yea I get it. I can't say I never did the same with some stuff. I'm just trying to standardize existing documentation to get a good base. That means a lot of cleanup, yes, but I think it's for the good. The sentence itself is a good idea, but I feel like it's already implied if you get what I mean

So if the most recent template is the best I can start; then I can start from scratch before you review the rest from here and then having to review it again. I'm absolutely on your side on standardizing stuff. That was sometimes a problem here for me. Started first PRs with fortigate stuff here then I copy pasted my old Fortigate guide and used it as my template for next PR, then stuff told me to use on FGT wasn't good anymore 😂 will do my best to keep this docs here as you want 👌

Let's leave the sentence for now, and decide about adding to other guides later. Let's get his merged, sorry I have been the bottleneck here!

dominic-r

Hi @nicedevil007 . Thanks for another contribution to authentik! Your work and your dedication is greatly appreciated. I'll approve this PR as it looks almost perfect for now :)

cc @tanberry for merge

nicedevil007 · 2025-02-16T16:30:53Z

is something missing for the merge from my side (beside time from owners :)).

tanberry · 2025-02-17T19:49:50Z

website/integrations/services/engomo/index.mdx

+>
+> -- https://engomo.com/
+>
+> This guide explains how to set up engomo to use authentik as the OAuth provider for the application login on the smartphone/tablet and login to the admin WebGUI (composer).


Suggested change

> This guide explains how to set up engomo to use authentik as the OAuth provider for the application login on the smartphone/tablet and login to the admin WebGUI (composer).

> This guide explains how to set up engomo to use authentik as the OAuth provider for the application on the smartphone/tablet and allow logging in to the admin WebGUI (composer).

Did that rewrite leave the original intent? The sentence was a little confusing.

tanberry · 2025-02-17T19:51:38Z

website/integrations/services/engomo/index.mdx

+
+- `engomo.mapping` is the value of the Mapping's name.
+- `profile` is the value for the Scope name.
+- `return {"preferred_username": request.user.email}` is the value for the Expression.


What do we mean by "the Expression"? Is there an expression somewhere that defines these values?

tanberry · 2025-02-17T20:28:55Z

website/integrations/services/engomo/index.mdx

+    - Add the `engomo.mapping` scope in addition to the default values.
+
+:::note
+Redirect URIs => write the values line by line.


Suggested change

Redirect URIs => write the values line by line.

Redirect URIs => add the redirect values line by line.

tanberry · 2025-02-17T20:29:37Z

website/integrations/services/engomo/index.mdx

+- Choose `authentik` from the Authenticator dropdown.
+- Create your user by entering the email address as the username. This email must match the one used for the user in authentik.
+
+## Test the login


Suggested change

## Test the login

## Test logging in

tanberry

Thank you @nicedevil007 !

* main: web/user: fix opening application with Enter not respecting new tab setting (#13115) web: bump API Client version (#13113) providers/rac: move to open source (#13015) website/docs: add 2025.2 release notes (#13002) core: clear expired database sessions (#13105) core: bump sentry-sdk from 2.21.0 to 2.22.0 (#13098) core: bump bandit from 1.8.2 to 1.8.3 (#13097) core: bump aws-cdk-lib from 2.178.2 to 2.179.0 (#13099) core: bump goauthentik.io/api/v3 from 3.2024123.4 to 3.2024123.6 (#13100) lifecycle/aws: bump aws-cdk from 2.178.2 to 2.179.0 in /lifecycle/aws (#13101) website/docs: Add AdventureLog Community Integration Documentation (#12928) website/docs: minor fixes (#13095) website/integrations: Update to Wizard and Styling Guide (#12919) web: bump API Client version (#13093) policies/geoip: distance + impossible travel (#12541) root: fix generated API docs not being excluded from codespell (#13091)

nicedevil007 and others added 2 commits February 2, 2025 10:02

update to Wizard and Styling Guide

46691f4

Ready for PR

c3d2879

nicedevil007 requested a review from a team as a code owner February 2, 2025 09:22

dominic-r requested changes Feb 2, 2025

View reviewed changes

remove changes on actual budget

826716c

#12716 Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com>

dominic-r requested changes Feb 3, 2025

View reviewed changes

dominic-r approved these changes Feb 5, 2025

View reviewed changes

tanberry reviewed Feb 17, 2025

View reviewed changes

tanberry approved these changes Feb 17, 2025

View reviewed changes

tanberry merged commit 179f5c7 into goauthentik:main Feb 17, 2025
67 checks passed

nicedevil007 deleted the StylingUpdate branch March 24, 2025 21:47

	> This guide explains how to set up engomo to use authentik as the OAuth provider for the application login on the smartphone/tablet and login to the admin WebGUI (composer).
	> This guide explains how to set up engomo to use authentik as the OAuth provider for the application on the smartphone/tablet and allow logging in to the admin WebGUI (composer).

	Redirect URIs => write the values line by line.
	Redirect URIs => add the redirect values line by line.

Uh oh!

Conversation

nicedevil007 commented Feb 2, 2025

Checklist

Uh oh!

netlify bot commented Feb 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for authentik-storybook canceled.

Uh oh!

netlify bot commented Feb 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for authentik-docs ready!

Uh oh!

codecov bot commented Feb 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

dominic-r left a comment

Choose a reason for hiding this comment

Uh oh!

nicedevil007 commented Feb 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dominic-r commented Feb 2, 2025

Uh oh!

nicedevil007 commented Feb 2, 2025

Uh oh!

dominic-r left a comment

Choose a reason for hiding this comment

Uh oh!

dominic-r Feb 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dominic-r Feb 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nicedevil007 Feb 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dominic-r left a comment

Choose a reason for hiding this comment

Uh oh!

nicedevil007 commented Feb 16, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tanberry Feb 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tanberry left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

netlify bot commented Feb 2, 2025 •

edited

Loading

netlify bot commented Feb 2, 2025 •

edited

Loading

codecov bot commented Feb 2, 2025 •

edited

Loading

nicedevil007 commented Feb 2, 2025 •

edited

Loading

dominic-r Feb 3, 2025 •

edited

Loading

dominic-r Feb 3, 2025 •

edited

Loading

nicedevil007 Feb 3, 2025 •

edited

Loading

tanberry Feb 17, 2025 •

edited

Loading