Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

website/docs: updated debugging docs #12809

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Conversation

BeryJu
Copy link
Member

@BeryJu BeryJu commented Jan 25, 2025

Details

docs for #12804


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 January 25, 2025 00:48
@authentik-automation
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 26%, saving 282.38 KB.

Filename Before After Improvement Visual comparison
website/docs/developer-docs/setup/debug_vscode.png 1.06 MB 805.20 KB -26.0% View diff

160 images did not require optimisation.

Copy link

netlify bot commented Jan 25, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit accfeab
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/6796aaf84d2602000879b0f0

Copy link

netlify bot commented Jan 25, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit accfeab
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/6796aaf8c48a7f000838b629
😎 Deploy Preview https://deploy-preview-12809--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 site configuration.

Copy link

codecov bot commented Jan 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.76%. Comparing base (d3d6040) to head (accfeab).
Report is 2 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #12809      +/-   ##
==========================================
+ Coverage   92.69%   92.76%   +0.06%     
==========================================
  Files         769      769              
  Lines       38926    38926              
==========================================
+ Hits        36084    36109      +25     
+ Misses       2842     2817      -25     
Flag Coverage Δ
e2e 48.62% <ø> (+0.13%) ⬆️
integration 24.60% <ø> (ø)
unit 90.39% <ø> (ø)

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

github-actions bot commented Jan 25, 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-accfeab326e7aa260b27ba8906c5cc4d9a8eb062
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-accfeab326e7aa260b27ba8906c5cc4d9a8eb062

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

Signed-off-by: Jens Langhammer <[email protected]>
Signed-off-by: Jens Langhammer <[email protected]>
Signed-off-by: Jens Langhammer <[email protected]>
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.

1 participant