website/docs: add procedurals to flow inspector docs#9556
Merged
Conversation
✅ Deploy Preview for authentik-storybook canceled.
|
✅ Deploy Preview for authentik-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #9556 +/- ##
==========================================
+ Coverage 92.45% 92.50% +0.04%
==========================================
Files 669 669
Lines 32712 32899 +187
==========================================
+ Hits 30245 30433 +188
+ Misses 2467 2466 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
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-1cfcc8bd6e84ccdb9d97358ea6ca7f69adf57b1b
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-1cfcc8bd6e84ccdb9d97358ea6ca7f69adf57b1b-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-1cfcc8bd6e84ccdb9d97358ea6ca7f69adf57b1bFor 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-1cfcc8bd6e84ccdb9d97358ea6ca7f69adf57b1b-arm64Afterwards, run the upgrade commands from the latest release notes. |
kensternberg-authentik
approved these changes
May 3, 2024
Contributor
kensternberg-authentik
left a comment
There was a problem hiding this comment.
A few nitpicks.
website/docs/flow/inspector.md
Outdated
|
|
||
| :::info | ||
| When running a flow with the inspector enabled, the flow is still executed normally. This means that for example, a [User write](../flow/stages/user_write.md) stage will _actually_ write user data. | ||
| Be aware that when running a flow with the inspector enabled, the flow is still executed normally. This means that for example, a [User write](../flow/stages/user_write.md) stage will _actually_ write user data. |
Contributor
There was a problem hiding this comment.
"akshualllllly" is one of those words that makes me twitch.
"For example, even with the flow inspector enabled, executing a User write will write user data."
website/docs/flow/inspector.md
Outdated
| When developing authentik with the debug-mode enabled, the inspector is enabled by default and can be accessed by both unauthenticated users and standard users. However the debug-mode should only be used for the development of authentik. | ||
| 3. On the Flow's detail page, on the left side under **Execute Flow**, click **with inspector**. | ||
|
|
||
| 4. The selected flow will launch in a new browser window, with the Inspector displayed to the right. |
Contributor
There was a problem hiding this comment.
Window or Tab?
website/docs/flow/inspector.md
Outdated
|
|
||
| 4. The selected flow will launch in a new browser window, with the Inspector displayed to the right. | ||
|
|
||
| Alternatively, to launch the inspector a user with the correct permission can add the query parameter `?inspector` to the URL when a flow is designated in the URL; that is when you have a flow open. |
Contributor
There was a problem hiding this comment.
Suggestion: "Alternatively, a user with the correct permission can launch the inspector by adding the query parameter ?inspector to the URL when the URL opens on a flow."
added 2 commits
May 6, 2024 12:38
kensternberg-authentik
added a commit
that referenced
this pull request
May 8, 2024
* main: (42 commits) website/docs: prepare 2024.4.2 release notes (#9555) web: bump the esbuild group in /web with 2 updates (#9616) translate: Updates for file locale/en/LC_MESSAGES/django.po in ru (#9611) translate: Updates for file locale/en/LC_MESSAGES/django.po in zh_CN (#9560) translate: Updates for file locale/en/LC_MESSAGES/django.po in zh-Hans (#9563) ci: bump golangci/golangci-lint-action from 5 to 6 (#9615) web: bump esbuild from 0.20.2 to 0.21.0 in /web (#9617) core: bump cryptography from 42.0.6 to 42.0.7 (#9618) core: bump sentry-sdk from 2.0.1 to 2.1.1 (#9619) core: bump django from 5.0.4 to 5.0.5 (#9620) core, web: update translations (#9613) website/docs: move Sources from Integrations into Docs (#9515) website/docs: add procedurals to flow inspector docs (#9556) core: bump jinja2 from 3.1.3 to 3.1.4 (#9610) web: clean up the options rendering in PromptForm (#9564) translate: Updates for file locale/en/LC_MESSAGES/django.po in ru (#9608) website/docs: add instructions for deploying radius manually with docker compose (#9605) sources/scim: fix duplicate groups and invalid schema (#9466) core: fix condition in task clean_expiring_models (#9603) translate: Updates for file web/xliff/en.xlf in fr (#9600) ...
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.
This PR adds steps about how to open the Flow Inspector, permissions needed, when to use (and not use) Debug mode. Adds a link to Permissions doc.
make website)