-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
website/docs: update create oauth provider page #16617
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
Conversation
✅ Deploy Preview for authentik-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for authentik-integrations ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for authentik-storybook ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #16617 +/- ##
==========================================
+ Coverage 92.42% 92.77% +0.34%
==========================================
Files 838 838
Lines 45359 45374 +15
==========================================
+ Hits 41924 42095 +171
+ Misses 3435 3279 -156
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
authentik PR Installation instructions Instructions for docker-composeAdd the following block to your AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-37be18f3a10461653781740d39001fbfe9994e3f
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s Afterwards, run the upgrade commands from the latest release notes. Instructions for KubernetesAdd the following block to your authentik:
outposts:
container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
global:
image:
repository: ghcr.io/goauthentik/dev-server
tag: gh-37be18f3a10461653781740d39001fbfe9994e3f Afterwards, run the upgrade commands from the latest release notes. |
::: | ||
1. Log in to authentik as an administrator, and open the authentik Admin interface. | ||
2. Navigate to **Applications > Applications** and click **Create with provider** to create an application and provider pair. | ||
3. On the **New application** page, define the application settings, and then click **Next**. |
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 use of the word "box" was to indicate that it is a modal... I am fine with calling it a page, just like all the other pages, but that is a conscious decision to be less specific, imo.
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.
Also, why do we want to remove line 17 with the info about offline_access
?
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.
"Box" seems a bit weird to me in this case. I know that box is used as a CSS term but to a non-frontend type person, box isn't as clear as page/window IMO.
I removed the offline access information because it's already mentioned on the OAuth provider page and seems to fit better there: https://version-2024-8.goauthentik.io/docs/providers/oauth2/#authorization_code
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 agree about not using the term "box". I wish I had won the debate to use "modal". But sure, "page" is fine.
On the Note about offline access though I think we need to leave it here. This is the page about creating/configuring an Oauth provider, and this Note is about configuring the provider to use offline access scope, so this is where it most needs to be, so they see it as they are creating it. Thoughts?
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.
Re-added the note with slight wording changes
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.
Thanks @dewi-tik !!
* Updated the page to be more consistent with upcoming changes to the saml page * Add note
🍒 Cherry-pick to |
…16806) website/docs: update create oauth provider page (#16617) * Updated the page to be more consistent with upcoming changes to the saml page * Add note Co-authored-by: Dewi Roberts <[email protected]>
Details
Updates the page to be more consistent with upcoming changes to the saml page
Checklist
If applicable
make docs
)