Skip to content

website/docs: add a single page about our user interface, document Consent stage#20533

Merged
tanberry merged 51 commits intomainfrom
docs-user-interface
Mar 25, 2026
Merged

website/docs: add a single page about our user interface, document Consent stage#20533
tanberry merged 51 commits intomainfrom
docs-user-interface

Conversation

@tanberry
Copy link
Contributor

@tanberry tanberry commented Feb 24, 2026

This PR adds a single page about the User interface, and what tasks an end user can accomplish there.

It also adds a new page, about the Consent stage.

TODOs:

  • research "LDAP limitation with 2FA"
  • finish MFA section
  • on Consent stage page, step 4, explain how to select the Order value for the policy

If applicable

  • The documentation has been updated
  • The documentation has been formatted (make docs)

@tanberry tanberry requested a review from a team as a code owner February 24, 2026 21:31
@tanberry tanberry marked this pull request as draft February 24, 2026 21:31
@netlify
Copy link

netlify bot commented Feb 24, 2026

Deploy Preview for authentik-integrations ready!

Name Link
🔨 Latest commit 24fc66e
🔍 Latest deploy log https://app.netlify.com/projects/authentik-integrations/deploys/69c3f4f300b6c700081a926e
😎 Deploy Preview https://deploy-preview-20533--authentik-integrations.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link

netlify bot commented Feb 24, 2026

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 24fc66e
🔍 Latest deploy log https://app.netlify.com/projects/authentik-docs/deploys/69c3f4f352f8b80008379c19
😎 Deploy Preview https://deploy-preview-20533--authentik-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 24, 2026

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-0ff60c67223c95b397b235173b7acdc228c98467
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-0ff60c67223c95b397b235173b7acdc228c98467

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

@codecov
Copy link

codecov bot commented Feb 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.81%. Comparing base (237423d) to head (0ff60c6).
⚠️ Report is 3 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #20533   +/-   ##
=======================================
  Coverage   92.81%   92.81%           
=======================================
  Files        1000     1000           
  Lines       56604    56604           
  Branches      425      425           
=======================================
+ Hits        52536    52539    +3     
+ Misses       4068     4065    -3     
Flag Coverage Δ
conformance 37.38% <ø> (+<0.01%) ⬆️
e2e 42.89% <ø> (+0.04%) ⬆️
integration 22.22% <ø> (+<0.01%) ⬆️
rust 0.23% <ø> (ø)
unit 91.71% <ø> (+2.96%) ⬆️
unit-migrate 89.45% <ø> (-2.36%) ⬇️

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.

Copy link
Contributor

@dewi-tik dewi-tik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know it's a draft. Just did a quick once over.

@tanberry
Copy link
Contributor Author

tanberry commented Mar 2, 2026

I know it's a draft. Just did a quick once over.

Thanks @dewi-tik yeah for sure still a draft.. I just copy/pasted rough notes in there without looking at typos... this habit of putting in very rough drafts comes from my fear of losing content/ideas... if I push it to GH then it is "safe." (Just to explain why it is so very messy.)

@netlify
Copy link

netlify bot commented Mar 4, 2026

Deploy Preview for authentik-storybook ready!

Name Link
🔨 Latest commit 0ff60c6
🔍 Latest deploy log https://app.netlify.com/projects/authentik-storybook/deploys/69c404779c42f300075305eb
😎 Deploy Preview https://deploy-preview-20533--authentik-storybook.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@tanberry tanberry marked this pull request as ready for review March 16, 2026 20:17
@tanberry tanberry marked this pull request as draft March 16, 2026 20:31
Signed-off-by: Jens L. <jens@beryju.org>
A _policy binding_ connects a specific policy (a policy object) to a flow or stage binding. With the policy binding, the flow (or specifically the stage within the flow) will now have additional content (i.e. the rules of the policy).

With policy bindings, you can also bind groups and users to another component (an application, a source, a flow, etc.). For example you can bind a group to an application, and then only that group (or other groups also bound to it), can access the application.
With policy bindings, you can also bind groups and users to another component (an application, a source, a flow, etc.). For example you can bind a specific group to an application, and then only that group (or other groups also bound to it), can access the application.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Depending on policy engine mode on the application this might be and instead of or, however or is default so /shrug

@tanberry
Copy link
Contributor Author

@BeryJu got all the edits in, just one outstanding question.. On the MFA section of the User Interface, are there any options that are displayed by default, and the others can be added by adding stages? Or, are there none by default, and each one must be added?

@tanberry tanberry requested a review from BeryJu March 25, 2026 13:07
@tanberry tanberry enabled auto-merge (squash) March 25, 2026 14:47
@tanberry tanberry merged commit a6c5540 into main Mar 25, 2026
107 checks passed
@tanberry tanberry deleted the docs-user-interface branch March 25, 2026 16:25
kensternberg-authentik added a commit that referenced this pull request Mar 25, 2026
* main: (42 commits)
  endpoints/connectors: fix enabled flag not respected (#21144)
  web: bump vite from 7.3.1 to 8.0.2 in /web (#21109)
  website/docs: add a single page about our user interface, document Consent stage (#20533)
  website: bump the build group across 1 directory with 9 updates (#21127)
  web: bump knip from 5.88.1 to 6.0.5 in /web (#21129)
  core: bump drf-spectacular from 0.28.0 to 0.29.0 (#19420)
  packages/client-go: init (#21139)
  providers/proxy: Add a default maxResponseBodySize to Traefik Middleware (#21111)
  core: bump library/nginx from `dec7a90` to `7150b3a` in /website (#21137)
  core: bump gunicorn from 25.1.0 to 25.2.0 (#21134)
  core: bump github.com/getsentry/sentry-go from 0.43.0 to 0.44.1 (#21122)
  core: bump astral-sh/uv from 0.11.0 to 0.11.1 in /lifecycle/container (#21135)
  ci: bump taiki-e/install-action from 2.69.8 to 2.69.9 in /.github/actions/setup (#21136)
  web/a11y: Modals, Command Palette (Merge branch) (#17812)
  website/docs: document file picker values (#20994)
  packages/client-rust: init (#21117)
  core: bump sentry-sdk from 2.55.0 to 2.56.0 (#21124)
  events: add helper to log deprecation configuration_warning message (#21115)
  core: bump djangorestframework from 3.17.0 to 3.17.1 (#21126)
  core: bump twilio from 9.10.3 to 9.10.4 (#21123)
  ...
kensternberg-authentik added a commit that referenced this pull request Mar 25, 2026
* main: (42 commits)
  endpoints/connectors: fix enabled flag not respected (#21144)
  web: bump vite from 7.3.1 to 8.0.2 in /web (#21109)
  website/docs: add a single page about our user interface, document Consent stage (#20533)
  website: bump the build group across 1 directory with 9 updates (#21127)
  web: bump knip from 5.88.1 to 6.0.5 in /web (#21129)
  core: bump drf-spectacular from 0.28.0 to 0.29.0 (#19420)
  packages/client-go: init (#21139)
  providers/proxy: Add a default maxResponseBodySize to Traefik Middleware (#21111)
  core: bump library/nginx from `dec7a90` to `7150b3a` in /website (#21137)
  core: bump gunicorn from 25.1.0 to 25.2.0 (#21134)
  core: bump github.com/getsentry/sentry-go from 0.43.0 to 0.44.1 (#21122)
  core: bump astral-sh/uv from 0.11.0 to 0.11.1 in /lifecycle/container (#21135)
  ci: bump taiki-e/install-action from 2.69.8 to 2.69.9 in /.github/actions/setup (#21136)
  web/a11y: Modals, Command Palette (Merge branch) (#17812)
  website/docs: document file picker values (#20994)
  packages/client-rust: init (#21117)
  core: bump sentry-sdk from 2.55.0 to 2.56.0 (#21124)
  events: add helper to log deprecation configuration_warning message (#21115)
  core: bump djangorestframework from 3.17.0 to 3.17.1 (#21126)
  core: bump twilio from 9.10.3 to 9.10.4 (#21123)
  ...
kensternberg-authentik added a commit that referenced this pull request Mar 26, 2026
* main: (26 commits)
  endpoints/connectors: fix enabled flag not respected (#21144)
  web: bump vite from 7.3.1 to 8.0.2 in /web (#21109)
  website/docs: add a single page about our user interface, document Consent stage (#20533)
  website: bump the build group across 1 directory with 9 updates (#21127)
  web: bump knip from 5.88.1 to 6.0.5 in /web (#21129)
  core: bump drf-spectacular from 0.28.0 to 0.29.0 (#19420)
  packages/client-go: init (#21139)
  providers/proxy: Add a default maxResponseBodySize to Traefik Middleware (#21111)
  core: bump library/nginx from `dec7a90` to `7150b3a` in /website (#21137)
  core: bump gunicorn from 25.1.0 to 25.2.0 (#21134)
  core: bump github.com/getsentry/sentry-go from 0.43.0 to 0.44.1 (#21122)
  core: bump astral-sh/uv from 0.11.0 to 0.11.1 in /lifecycle/container (#21135)
  ci: bump taiki-e/install-action from 2.69.8 to 2.69.9 in /.github/actions/setup (#21136)
  web/a11y: Modals, Command Palette (Merge branch) (#17812)
  website/docs: document file picker values (#20994)
  packages/client-rust: init (#21117)
  core: bump sentry-sdk from 2.55.0 to 2.56.0 (#21124)
  events: add helper to log deprecation configuration_warning message (#21115)
  core: bump djangorestframework from 3.17.0 to 3.17.1 (#21126)
  core: bump twilio from 9.10.3 to 9.10.4 (#21123)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants