Skip to content

website/docs: updated debugging docs#12809

Merged
tanberry merged 8 commits intomainfrom
website/docs/debugger-docs
Feb 24, 2025
Merged

website/docs: updated debugging docs#12809
tanberry merged 8 commits intomainfrom
website/docs/debugger-docs

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
lifecycle: much improved debugging experience
dad4770 
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
@BeryJu BeryJu requested a review from a team as a code owner January 25, 2025 00:48
@authentik-automation
Copy link
Contributor

authentik-automation bot commented Jan 25, 2025

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.

@netlify
Copy link

netlify bot commented Jan 25, 2025 •
edited
Loading

✅ Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit c49311f
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/679d831bb223110008a9939b

@netlify
Copy link

netlify bot commented Jan 25, 2025 •
edited
Loading

✅ Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit c49311f
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/679d831b867d9b000869b939
😎 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.

@codecov
Copy link

codecov bot commented Jan 25, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.75%. Comparing base (d3d6040) to head (c49311f).
Report is 212 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.75%   +0.05%     
==========================================
  Files         769      769              
  Lines       38926    38929       +3     
==========================================
+ Hits        36084    36107      +23     
+ Misses       2842     2822      -20
Flag Coverage Δ
e2e 48.56% <ø> (+0.08%) ⬆️
integration 24.60% <ø> (+<0.01%) ⬆️
unit 90.39% <ø> (-0.01%) ⬇️

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.

@BeryJu
start documenting container debugging
5475581 
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
@github-actions
Copy link
Contributor

github-actions bot commented Jan 25, 2025 •
edited
Loading

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-c49311fdd55efeb85e14b383341e937c720d72f7
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-c49311fdd55efeb85e14b383341e937c720d72f7

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

BeryJu added 3 commits January 25, 2025 19:14
@BeryJu
add user: root
a90d64a 
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
@BeryJu
update example override file
6fa08e0 
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
@BeryJu
update env var
accfeab 
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
tanberry
tanberry reviewed Jan 27, 2025
View reviewed changes
tanberry
tanberry reviewed Jan 27, 2025
View reviewed changes
tanberry
tanberry reviewed Jan 27, 2025
View reviewed changes
tanberry
tanberry reviewed Jan 27, 2025
View reviewed changes
tanberry
tanberry reviewed Jan 27, 2025
View reviewed changes
tanberry
tanberry reviewed Jan 27, 2025
View reviewed changes
website/docs/developer-docs/setup/debugging.md

Note that authentik uses [debugpy](https://github.com/microsoft/debugpy), which relies on the "Debug Adapter Protocol". These instructions demonstrate debugging using [Visual Studio Code](https://code.visualstudio.com/), however they should be adaptable to other editors which support DAP.

To enable the debugging server, set the environment variable `AUTHENTIK_DEBUGGER` to `true`. This will launch the debugging server (by default on port _9901_).
Copy link
Contributor

@tanberry tanberry Jan 27, 2025

Choose a reason for hiding this comment

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

What do we mean by "the debugging server"? Is that server part of DAP, or do you mean our server, geting debugged by DAP?

Also let's link to /install-config/configuration/#set-your-environment-variables.

tanberry
tanberry reviewed Jan 27, 2025
View reviewed changes
website/docs/developer-docs/setup/debugging.md

To enable the debugging server, set the environment variable `AUTHENTIK_DEBUGGER` to `true`. This will launch the debugging server (by default on port _9901_).

With this setup in place, you can set Breakpoints in VS Code. To connect to the debugging server, run the command `> Debug: Start Debugging" in VS Code.
Copy link
Contributor

@tanberry tanberry Jan 27, 2025

Choose a reason for hiding this comment

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

If we clarify above what we mean by "debugging server" this is ok.

tanberry
tanberry reviewed Jan 27, 2025
View reviewed changes
tanberry
tanberry reviewed Jan 27, 2025
View reviewed changes
tanberry
tanberry reviewed Jan 27, 2025
View reviewed changes
tanberry
tanberry reviewed Jan 27, 2025
View reviewed changes
tanberry
tanberry reviewed Jan 27, 2025
View reviewed changes
tanberry
tanberry reviewed Jan 27, 2025
View reviewed changes
website/docs/install-config/configuration/configuration.mdx
- `AUTHENTIK_LISTEN__LDAPS`: Listening address:port (e.g. `0.0.0.0:6636`) for LDAPS (Applies to LDAP outpost)
- `AUTHENTIK_LISTEN__METRICS`: Listening address:port (e.g. `0.0.0.0:9300`) for Prometheus metrics (Applies to All)
- `AUTHENTIK_LISTEN__DEBUG`: Listening address:port (e.g. `0.0.0.0:9900`) for Go Debugging metrics (Applies to All)
- `AUTHENTIK_LISTEN__DEBUG_PY`: Listening address:port (e.g. `0.0.0.0:9901`) for Python debugging server (Applies to Server, see [Debugging](../../developer-docs/setup/debugging.md))
Copy link
Contributor

@tanberry tanberry Jan 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
- `AUTHENTIK_LISTEN__DEBUG_PY`: Listening address:port (e.g. `0.0.0.0:9901`) for Python debugging server (Applies to Server, see [Debugging](../../developer-docs/setup/debugging.md))
- `AUTHENTIK_LISTEN__DEBUG_PY`: Listening address:port (e.g. `0.0.0.0:9901`) for Python debugging server (applies to server, see [Debugging](../../developer-docs/setup/debugging.md))

Copy link
Contributor

@tanberry tanberry Jan 27, 2025

Choose a reason for hiding this comment

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

naah, we can catch this in a later PR if it impacts too many other docs.

tanberry
tanberry requested changes Jan 27, 2025
View reviewed changes
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.

Wow this is a great new topic to add to the docs! A few editorial edits, then let's get this merged!

@BeryJu @tanberry
Apply suggestions from code review
b85d7df 
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Jens L. <jens@beryju.org>
BeryJu
BeryJu commented Jan 27, 2025
View reviewed changes
@BeryJu
fix
c49311f 
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
@sirux88 sirux88 mentioned this pull request Feb 8, 2025
Merged
6 tasks
tanberry
tanberry approved these changes Feb 24, 2025
View reviewed changes
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.

Approve but there are some comments we shold address after the release.

tanberry
tanberry approved these changes Feb 24, 2025
View reviewed changes
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!!

@tanberry tanberry merged commit 86893d8 into main Feb 24, 2025
71 checks passed
@tanberry tanberry deleted the website/docs/debugger-docs branch February 24, 2025 12:17
rissson pushed a commit that referenced this pull request Mar 4, 2025
@BeryJu @authentik-automation
@tanberry @rissson
website/docs: updated debugging docs (#12809)
095570d 
* lifecycle: much improved debugging experience

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* Optimised images with calibre/image-actions

* start documenting container debugging

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* add user: root

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* update example override file

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* update env var

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* Apply suggestions from code review

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Jens L. <jens@beryju.org>

* fix

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

---------

Signed-off-by: Jens Langhammer <jens@goauthentik.io>
Signed-off-by: Jens L. <jens@beryju.org>
Co-authored-by: authentik-automation[bot] <135050075+authentik-automation[bot]@users.noreply.github.com>
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
rissson added a commit that referenced this pull request Mar 4, 2025
@rissson @BeryJu
@authentik-automation @tanberry
website/docs: fix build (#13385)
679bf17 
* website/docs: updated debugging docs (#12809)

* lifecycle: much improved debugging experience

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* Optimised images with calibre/image-actions

* start documenting container debugging

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* add user: root

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* update example override file

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* update env var

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* Apply suggestions from code review

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Jens L. <jens@beryju.org>

* fix

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

---------

Signed-off-by: Jens Langhammer <jens@goauthentik.io>
Signed-off-by: Jens L. <jens@beryju.org>
Co-authored-by: authentik-automation[bot] <135050075+authentik-automation[bot]@users.noreply.github.com>
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>

* website/docs: fix build

Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>

---------

Signed-off-by: Jens Langhammer <jens@goauthentik.io>
Signed-off-by: Jens L. <jens@beryju.org>
Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
Co-authored-by: Jens L. <jens@goauthentik.io>
Co-authored-by: authentik-automation[bot] <135050075+authentik-automation[bot]@users.noreply.github.com>
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tanberry tanberry tanberry approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@BeryJu @tanberry