website/docs: add links and tweaks to existing docs on flow executors#10340
Merged
website/docs: add links and tweaks to existing docs on flow executors#10340
Conversation
✅ Deploy Preview for authentik-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for authentik-storybook canceled.
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #10340 +/- ##
=======================================
Coverage 92.64% 92.65%
=======================================
Files 713 713
Lines 34978 34978
=======================================
+ Hits 32407 32409 +2
+ Misses 2571 2569 -2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
kensternberg-authentik
approved these changes
Jul 2, 2024
Contributor
kensternberg-authentik
left a comment
There was a problem hiding this comment.
Generally fine. A few suggestions, nothing major.
| title: Flow executor (backend) | ||
| --- | ||
|
|
||
| A big focus of authentik is the flows system, which allows you to combine and build complex conditional processes using stages and policies. Normally, these flows are executed in the browser using the authentik inbuilt flow executor (/if/flows). |
Contributor
There was a problem hiding this comment.
You know, I don't think we need to use "inbuilt" or "default." Something that suggests what it's for rather than its position in a hierarchy of executors. "...using authentik's standard browser-based flow executor..." maybe? That way the rest of the conversation can be about non-standard (SFE) or non-browser (headless) executors.
| A big focus of authentik is the flows system, which allows you to combine and build complex conditional processes using stages and policies. Normally, these flows are automatically executed in the browser using authentik's frontend [default flow executor (/if/flows)](../../docs/flow/executors/if-flow.md). | ||
|
|
||
| However, any flow can be executed via an API from anywhere, in fact that is what the Web flow executor does. This means, you can, with a few requests, execute flows from anywhere, and integrate authentik even better. | ||
| However, any flow can be executed via an API from anywhere, in fact that is what the backend flow executor does. This means, you can, with a few requests, execute flows from anywhere, and integrate authentik even better. |
Contributor
There was a problem hiding this comment.
Suggestion: "With a few requests you can execute flows from any device and integrate authentik more fully into your workflows."
Otherwise it reads, a bit, like, William Shatner!, when he's, monologuing!
Contributor
|
authentik PR Installation instructions Instructions for docker-composeAdd the following block to your AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-ghcr.io/goauthentik/dev-server:gh-b055bf4f033f34eac5922e8a6f7ef8a61270dea8
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)sFor arm64, use these values: AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-ghcr.io/goauthentik/dev-server:gh-b055bf4f033f34eac5922e8a6f7ef8a61270dea8-arm64
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)sAfterwards, 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
image:
repository: ghcr.io/goauthentik/dev-server
tag: gh-ghcr.io/goauthentik/dev-server:gh-b055bf4f033f34eac5922e8a6f7ef8a61270dea8For arm64, use these values: authentik:
outposts:
container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
image:
repository: ghcr.io/goauthentik/dev-server
tag: gh-ghcr.io/goauthentik/dev-server:gh-b055bf4f033f34eac5922e8a6f7ef8a61270dea8-arm64Afterwards, run the upgrade commands from the latest release notes. |
kensternberg-authentik
added a commit
that referenced
this pull request
Jul 5, 2024
* main: website/docs: add links and tweaks to existing docs on flow executors (#10340) sources/saml: fix pickle error, add saml auth tests (#10348) web: bump API Client version (#10351) core: applications api: add option to only list apps with launch url (#10336) website/integrations: minio: configure openid on web (#9874) website/docs: integrations: gitea: specify callback url (#10180) providers/saml: fix metadata import error handling (#10349) core, web: update translations (#10341) core: bump twilio from 9.2.2 to 9.2.3 (#10343) core: bump google-api-python-client from 2.135.0 to 2.136.0 (#10344) translate: Updates for file web/xliff/en.xlf in zh-Hans (#10339) translate: Updates for file web/xliff/en.xlf in zh_CN (#10338) web: bump the storybook group in /web with 7 updates (#10263) web: lintpicking (#10212)
kensternberg-authentik
added a commit
that referenced
this pull request
Jul 15, 2024
* main: website/docs: add links and tweaks to existing docs on flow executors (#10340) sources/saml: fix pickle error, add saml auth tests (#10348) web: bump API Client version (#10351) core: applications api: add option to only list apps with launch url (#10336) website/integrations: minio: configure openid on web (#9874) website/docs: integrations: gitea: specify callback url (#10180) providers/saml: fix metadata import error handling (#10349) core, web: update translations (#10341) core: bump twilio from 9.2.2 to 9.2.3 (#10343) core: bump google-api-python-client from 2.135.0 to 2.136.0 (#10344) translate: Updates for file web/xliff/en.xlf in zh-Hans (#10339) translate: Updates for file web/xliff/en.xlf in zh_CN (#10338) web: bump the storybook group in /web with 7 updates (#10263) web: lintpicking (#10212)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
These changes add links between the backend Flow Exececutor and the frontend, defaul flow executor. Also a link to the Brands docs, and a few edits and clairifcations.
I did not add info about the upcoming SFE executor.
make website)