website/docs: add more content about flows by tanberry · Pull Request #10527 · goauthentik/authentik

tanberry · 2024-07-17T01:19:36Z

This PR updates our docs about flows/stages, and policies.

netlify · 2024-07-17T01:19:51Z

✅ Deploy Preview for authentik-docs ready!

Name	Link
🔨 Latest commit	`3bd4ff0`
🔍 Latest deploy log	https://app.netlify.com/sites/authentik-docs/deploys/66b2184398fcfe0008de8bbc
😎 Deploy Preview	https://deploy-preview-10527--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-07-17T01:19:54Z

✅ Deploy Preview for authentik-storybook ready!

Name	Link
🔨 Latest commit	`3bd4ff0`
🔍 Latest deploy log	https://app.netlify.com/sites/authentik-storybook/deploys/66b21842d320960008ffb7e5
😎 Deploy Preview	https://deploy-preview-10527--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.

…uide

github-actions · 2024-08-02T01:22:28Z

authentik PR Installation instructions

Instructions for docker-compose

Add the following block to your .env file:

AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-3bd4ff0fe5fd262611c63ce02b935cbf81b80980
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s

For arm64, use these values:

AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-3bd4ff0fe5fd262611c63ce02b935cbf81b80980-arm64
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 Kubernetes

Add the following block to your values.yml file:

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-3bd4ff0fe5fd262611c63ce02b935cbf81b80980

For arm64, use these values:

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-3bd4ff0fe5fd262611c63ce02b935cbf81b80980-arm64

Afterwards, run the upgrade commands from the latest release notes.

kensternberg-authentik

I had only one question, really, because I don't really understand yet how the flow/stage/policy thing, which as far as I can tell is a sequence with no branches, turns into that mermaid-like branching diagram.

kensternberg-authentik · 2024-08-02T21:20:28Z

website/docs/flow/index.md

-Starting with authentik 2022.8, flows will be exported as YAML, but JSON-based flows can still be imported.
+-   **Denied action**: Configure what happens when access to a flow is denied by a policy. By default, authentik will redirect to a `?next` parameter if set, and otherwise show an error message.

-## Behavior settings


Where? Where does one "toggle these settings?"

Ah, yes, @kensternberg-authentik this confirms a concern I developed last week, that it is not at all clear that all of these sections in this page are sections of the UI. On the Create flow modal, there is a section called Denied action with these three radio buttons. I am going to look into how to make it more clear on this page that these are UI elements. Any ideas?

OK @kensternberg-authentik I reformatted that page to use bold text for each field, instead of H3s... hopefully that makes it more obvious that those are field names, not headers/titles. I also added a screenshot of the Create modal box... to hint that the items below are those fields.

tanberry · 2024-08-05T15:30:58Z

I had only one question, really, because I don't really understand yet how the flow/stage/policy thing, which as far as I can tell is a sequence with no branches, turns into that mermaid-like branching diagram.

Oh oh oh I am excited to try to answer this @kensternberg-authentik ... though Jens might have to correct me. I believe that the "branching" shown in the diagram represents the decisions that are made based on a policy. If a policy "passes" then the specified Stage is used. If the policy fails, then that Stage is skipped. So it is a sequence, but a dynamic one, based on policies.

…ings in the document

authentik-automation · 2024-08-05T23:29:15Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 53.5%, saving 129.49 KB.

Filename	Before	After	Improvement	Visual comparison
`website/docs/flow/create-flow.png`	242.10 KB	112.62 KB	-53.5%	View diff

157 images did not require optimisation.

website/developer-docs/docs/style-guide.mdx

website/docs/flow/index.md

website/docs/flow/simple_stages.png

authentik-automation · 2024-08-06T03:24:06Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 52.6%, saving 47.06 KB.

Filename	Before	After	Improvement	Visual comparison
`website/docs/flow/simple_stages.png`	89.50 KB	42.44 KB	-52.6%	View diff

157 images did not require optimisation.

website/docs/flow/simple_stages.png

Signed-off-by: Jens Langhammer <jens@goauthentik.io> # Conflicts: # website/docs/policies/index.md

authentik-automation · 2024-08-06T12:34:06Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 52.1%, saving 49.32 KB.

Filename	Before	After	Improvement	Visual comparison
`website/docs/flow/simple_stages.png`	94.68 KB	45.36 KB	-52.1%	View diff

157 images did not require optimisation.

* main: (473 commits) blueprints: handle model referencing non-existent app/model (#10796) website/docs: add more content about flows (#10527) brands: add OIDC webfinger support (#10400) web/admin: fix selectable card colour in dark theme (#10794) web: bump API Client version (#10793) policies: add GeoIP policy (#10454) core: bump debugpy from 1.8.3 to 1.8.5 (#10781) web: bump @sentry/browser from 8.22.0 to 8.23.0 in /web in the sentry group across 1 directory (#10782) website: bump postcss from 8.4.40 to 8.4.41 in /website (#10783) web: bump the wdio group across 2 directories with 4 updates (#10785) web: bump @lit/localize from 0.12.1 to 0.12.2 in /web (#10786) web: bump @floating-ui/dom from 1.6.8 to 1.6.9 in /web (#10787) web: bump @lit/localize-tools from 0.7.2 to 0.8.0 in /web (#10788) web: bump lit from 3.1.4 to 3.2.0 in /web (#10789) core: bump goauthentik.io/api/v3 from 3.2024062.2 to 3.2024063.1 (#10790) web: bump API Client version (#10779) release: 2024.6.3 website/docs: prepare 2024.6.3 release notes (#10775) website/scripts: updated readme, added docsmg.env file (#10710) web: bump API Client version (#10777) ...

* main: (702 commits) blueprints: handle model referencing non-existent app/model (#10796) website/docs: add more content about flows (#10527) brands: add OIDC webfinger support (#10400) web/admin: fix selectable card colour in dark theme (#10794) web: bump API Client version (#10793) policies: add GeoIP policy (#10454) core: bump debugpy from 1.8.3 to 1.8.5 (#10781) web: bump @sentry/browser from 8.22.0 to 8.23.0 in /web in the sentry group across 1 directory (#10782) website: bump postcss from 8.4.40 to 8.4.41 in /website (#10783) web: bump the wdio group across 2 directories with 4 updates (#10785) web: bump @lit/localize from 0.12.1 to 0.12.2 in /web (#10786) web: bump @floating-ui/dom from 1.6.8 to 1.6.9 in /web (#10787) web: bump @lit/localize-tools from 0.7.2 to 0.8.0 in /web (#10788) web: bump lit from 3.1.4 to 3.2.0 in /web (#10789) core: bump goauthentik.io/api/v3 from 3.2024062.2 to 3.2024063.1 (#10790) web: bump API Client version (#10779) release: 2024.6.3 website/docs: prepare 2024.6.3 release notes (#10775) website/scripts: updated readme, added docsmg.env file (#10710) web: bump API Client version (#10777) ...

* main: (690 commits) blueprints: handle model referencing non-existent app/model (#10796) website/docs: add more content about flows (#10527) brands: add OIDC webfinger support (#10400) web/admin: fix selectable card colour in dark theme (#10794) web: bump API Client version (#10793) policies: add GeoIP policy (#10454) core: bump debugpy from 1.8.3 to 1.8.5 (#10781) web: bump @sentry/browser from 8.22.0 to 8.23.0 in /web in the sentry group across 1 directory (#10782) website: bump postcss from 8.4.40 to 8.4.41 in /website (#10783) web: bump the wdio group across 2 directories with 4 updates (#10785) web: bump @lit/localize from 0.12.1 to 0.12.2 in /web (#10786) web: bump @floating-ui/dom from 1.6.8 to 1.6.9 in /web (#10787) web: bump @lit/localize-tools from 0.7.2 to 0.8.0 in /web (#10788) web: bump lit from 3.1.4 to 3.2.0 in /web (#10789) core: bump goauthentik.io/api/v3 from 3.2024062.2 to 3.2024063.1 (#10790) web: bump API Client version (#10779) release: 2024.6.3 website/docs: prepare 2024.6.3 release notes (#10775) website/scripts: updated readme, added docsmg.env file (#10710) web: bump API Client version (#10777) ...

* main: (229 commits) blueprints: handle model referencing non-existent app/model (#10796) website/docs: add more content about flows (#10527) brands: add OIDC webfinger support (#10400) web/admin: fix selectable card colour in dark theme (#10794) web: bump API Client version (#10793) policies: add GeoIP policy (#10454) core: bump debugpy from 1.8.3 to 1.8.5 (#10781) web: bump @sentry/browser from 8.22.0 to 8.23.0 in /web in the sentry group across 1 directory (#10782) website: bump postcss from 8.4.40 to 8.4.41 in /website (#10783) web: bump the wdio group across 2 directories with 4 updates (#10785) web: bump @lit/localize from 0.12.1 to 0.12.2 in /web (#10786) web: bump @floating-ui/dom from 1.6.8 to 1.6.9 in /web (#10787) web: bump @lit/localize-tools from 0.7.2 to 0.8.0 in /web (#10788) web: bump lit from 3.1.4 to 3.2.0 in /web (#10789) core: bump goauthentik.io/api/v3 from 3.2024062.2 to 3.2024063.1 (#10790) web: bump API Client version (#10779) release: 2024.6.3 website/docs: prepare 2024.6.3 release notes (#10775) website/scripts: updated readme, added docsmg.env file (#10710) web: bump API Client version (#10777) ...

* main: blueprints: handle model referencing non-existent app/model (#10796) website/docs: add more content about flows (#10527) brands: add OIDC webfinger support (#10400) web/admin: fix selectable card colour in dark theme (#10794) web: bump API Client version (#10793) policies: add GeoIP policy (#10454) core: bump debugpy from 1.8.3 to 1.8.5 (#10781) web: bump @sentry/browser from 8.22.0 to 8.23.0 in /web in the sentry group across 1 directory (#10782) website: bump postcss from 8.4.40 to 8.4.41 in /website (#10783) web: bump the wdio group across 2 directories with 4 updates (#10785) web: bump @lit/localize from 0.12.1 to 0.12.2 in /web (#10786) web: bump @floating-ui/dom from 1.6.8 to 1.6.9 in /web (#10787) web: bump @lit/localize-tools from 0.7.2 to 0.8.0 in /web (#10788) web: bump lit from 3.1.4 to 3.2.0 in /web (#10789) core: bump goauthentik.io/api/v3 from 3.2024062.2 to 3.2024063.1 (#10790) web: bump API Client version (#10779)

Tana M Berry added 3 commits July 16, 2024 17:24

first pass

a37fd9c

reordered config options to match UI, added more

ae0ec53

tweaks

dcb9943

tanberry requested a review from a team as a code owner July 17, 2024 01:19

tanberry requested review from a team and BeryJu and removed request for a team July 17, 2024 01:19

tanberry marked this pull request as draft July 17, 2024 01:20

Tana M Berry added 18 commits July 19, 2024 17:45

add content for creating flows, add links to policies, update Style G…

ddc0ea0

…uide

tweaks

743ee2f

procedurals, info about bindings

3c89aa5

stages stub file

e1911f4

fighting conflicts

197b347

messy

52a926d

reorg procedurals

681f52e

tweak titles

7e33de8

tweaks

08961a0

images

541945e

images, remove old images

59ed435

tweak

1ad7a3f

tweaks and fixes

b252352

smaller image

6bb08d5

tweak

abbfab5

had to rollback

8fb3259

starting over after VS Code branch war

b9c43af

fix links

6d22600

tanberry marked this pull request as ready for review August 2, 2024 00:19

more tweaks

5d542be

fighting build break

31d0ae8

Tana M Berry added 2 commits August 2, 2024 09:28

remove dupe image

5f28aa8

replace image with diagram code

4817a57

kensternberg-authentik approved these changes Aug 2, 2024

View reviewed changes

Tana M Berry and others added 2 commits August 5, 2024 18:21

add image of UI, and reformat to look more like field names, not head…

138f10a

…ings in the document

Optimised images with calibre/image-actions

a6a0db2

BeryJu reviewed Aug 6, 2024

View reviewed changes

Tana M Berry and others added 3 commits August 5, 2024 22:19

new image

5db1719

rest of Jens' edits

96dc851

Optimised images with calibre/image-actions

1549dea

BeryJu reviewed Aug 6, 2024

View reviewed changes

website/docs/flow/simple_stages.png Show resolved Hide resolved

Tana M Berry added 2 commits August 6, 2024 07:20

fix order of stages in example

caab464

fixed arrows in image

2a57bb0

tanberry requested a review from BeryJu August 6, 2024 12:32

Merge branch 'main' into docs-flows-howto

da44b63

Signed-off-by: Jens Langhammer <jens@goauthentik.io> # Conflicts: # website/docs/policies/index.md

BeryJu approved these changes Aug 6, 2024

View reviewed changes

BeryJu enabled auto-merge (squash) August 6, 2024 12:33

Optimised images with calibre/image-actions

3bd4ff0

BeryJu merged commit 34b01d9 into main Aug 6, 2024

BeryJu deleted the docs-flows-howto branch August 6, 2024 12:56

Uh oh!

Conversation

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

Uh oh!

Uh oh!

netlify bot commented Jul 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for authentik-docs ready!

Uh oh!

netlify bot commented Jul 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for authentik-storybook ready!

Uh oh!

github-actions bot commented Aug 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kensternberg-authentik left a comment

Choose a reason for hiding this comment

Uh oh!

kensternberg-authentik Aug 2, 2024

Choose a reason for hiding this comment

Uh oh!

tanberry Aug 5, 2024 • 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 Aug 5, 2024

Choose a reason for hiding this comment

Uh oh!

tanberry commented Aug 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

authentik-automation bot commented Aug 5, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

authentik-automation bot commented Aug 6, 2024

Uh oh!

Uh oh!

authentik-automation bot commented Aug 6, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

tanberry commented Jul 17, 2024 •

edited

Loading

netlify bot commented Jul 17, 2024 •

edited

Loading

netlify bot commented Jul 17, 2024 •

edited

Loading

github-actions bot commented Aug 2, 2024 •

edited

Loading

tanberry Aug 5, 2024 •

edited

Loading

tanberry commented Aug 5, 2024 •

edited

Loading