Skip to content

website/docs: add docs for MTLS Stage#14571

Merged
tanberry merged 12 commits intomainfrom
website/docs/stage-mtls
May 28, 2025
Merged

website/docs: add docs for MTLS Stage#14571
tanberry merged 12 commits intomainfrom
website/docs/stage-mtls

Conversation

@BeryJu
Copy link
Member

@BeryJu BeryJu commented May 19, 2025

Details

Docs for #14296


Checklist

  • Local tests pass (ak test authentik/)
  • The code has been formatted (make lint-fix)

If an API change has been made

  • The API schema has been updated (make gen-build)

If changes to the frontend have been made

  • The code has been formatted (make web)

If applicable

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

@BeryJu BeryJu requested a review from a team as a code owner May 19, 2025 14:09
@netlify
Copy link

netlify bot commented May 19, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 2d04750
🔍 Latest deploy log https://app.netlify.com/projects/authentik-docs/deploys/68375f87a448470008490ddb
😎 Deploy Preview https://deploy-preview-14571--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.

@netlify
Copy link

netlify bot commented May 19, 2025

Deploy Preview for authentik-storybook ready!

Name Link
🔨 Latest commit 2d04750
🔍 Latest deploy log https://app.netlify.com/projects/authentik-storybook/deploys/68375f8717c3fe0008c8c388
😎 Deploy Preview https://deploy-preview-14571--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.

@BeryJu BeryJu mentioned this pull request May 19, 2025
9 tasks
@codecov
Copy link

codecov bot commented May 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.80%. Comparing base (70460bf) to head (2d04750).
Report is 113 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #14571      +/-   ##
==========================================
+ Coverage   91.70%   92.80%   +1.09%     
==========================================
  Files         814      817       +3     
  Lines       41898    42162     +264     
==========================================
+ Hits        38424    39129     +705     
+ Misses       3474     3033     -441     
Flag Coverage Δ
e2e 47.68% <ø> (-0.07%) ⬇️
integration 24.40% <ø> (?)
unit 90.64% <ø> (+0.05%) ⬆️

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.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions
Copy link
Contributor

github-actions bot commented May 19, 2025

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-31577e59926a91fa2102996eeb886e8a7766022c
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-31577e59926a91fa2102996eeb886e8a7766022c

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


See [ingress-nginx documentation](https://kubernetes.github.io/ingress-nginx/examples/auth/client-certs/) for reference.

### Traefik Standalone
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
### Traefik Standalone
### Traefik standalone


See [nginx documentation](https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_client_certificate) for reference.

### nginx Ingress
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
### nginx Ingress
### nginx ingress

- envoy
- No reverse proxy

### nginx Standalone
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
### nginx Standalone
### nginx standalone

@BeryJu BeryJu force-pushed the website/docs/stage-mtls branch from c1ece0e to 80c6e37 Compare May 19, 2025 14:52
@BeryJu BeryJu force-pushed the website/docs/stage-mtls branch 2 times, most recently from d7559c6 to ca1ac2b Compare May 19, 2025 22:05
@BeryJu BeryJu requested a review from a team as a code owner May 19, 2025 22:05
Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

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

A wee re-write, please, then LGTM!

BeryJu and others added 4 commits May 20, 2025 16:17
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
Co-authored-by: Dewi Roberts <dewi@goauthentik.io>
Signed-off-by: Jens L. <jens@beryju.org>
@BeryJu BeryJu force-pushed the website/docs/stage-mtls branch from efd5a27 to 1e66999 Compare May 20, 2025 14:18
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Jens L. <jens@beryju.org>
Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

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

LGTM!

BeryJu and others added 4 commits May 20, 2025 17:05
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Jens L. <jens@beryju.org>
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
tanberry added 2 commits May 28, 2025 14:09
Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com>
@tanberry tanberry enabled auto-merge (squash) May 28, 2025 19:21
@tanberry tanberry merged commit 3e3615a into main May 28, 2025
100 checks passed
@tanberry tanberry deleted the website/docs/stage-mtls branch May 28, 2025 19:34
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