website/docs: updated debugging docs #12809
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 26%, saving 282.38 KB.
160 images did not require optimisation. |
✅ Deploy Preview for authentik-storybook canceled.
|
✅ Deploy Preview for authentik-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ 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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
|
authentik PR Installation instructions Instructions for docker-composeAdd the following block to your 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)sAfterwards, run the upgrade commands from the latest release notes. Instructions for KubernetesAdd the following block to your 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-c49311fdd55efeb85e14b383341e937c720d72f7Afterwards, run the upgrade commands from the latest release notes. |
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
reviewed
Jan 27, 2025
tanberry
reviewed
Jan 27, 2025
tanberry
reviewed
Jan 27, 2025
tanberry
reviewed
Jan 27, 2025
tanberry
reviewed
Jan 27, 2025
tanberry
reviewed
Jan 27, 2025
|
|
||
| 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_). |
There was a problem hiding this comment.
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
reviewed
Jan 27, 2025
|
|
||
| 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. |
There was a problem hiding this comment.
If we clarify above what we mean by "debugging server" this is ok.
tanberry
reviewed
Jan 27, 2025
tanberry
reviewed
Jan 27, 2025
tanberry
reviewed
Jan 27, 2025
tanberry
reviewed
Jan 27, 2025
tanberry
reviewed
Jan 27, 2025
tanberry
reviewed
Jan 27, 2025
| @@ -167,6 +167,7 @@ Additionally, you can set `AUTHENTIK_POSTGRESQL__CONN_HEALTH_CHECK` to perform h | |||
| - `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)) | |||
There was a problem hiding this comment.
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)) |
There was a problem hiding this comment.
naah, we can catch this in a later PR if it impacts too many other docs.
tanberry
requested changes
Jan 27, 2025
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com> Signed-off-by: Jens L. <jens@beryju.org>
BeryJu
commented
Jan 27, 2025
6 tasks
tanberry
approved these changes
Feb 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Details
docs for #12804
Checklist
ak test authentik/)make lint-fix)If an API change has been made
make gen-build)If changes to the frontend have been made
make web)If applicable
make website)