website/docs: Clarify frontend development. Document local overrides. #13586
Conversation
✅ Deploy Preview for authentik-storybook canceled.
|
✅ Deploy Preview for authentik-docs canceled.
|
Signed-off-by: Teffen Ellis <[email protected]>
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 #13586 +/- ##
==========================================
+ Coverage 92.75% 92.76% +0.01%
==========================================
Files 794 794
Lines 40493 40545 +52
==========================================
+ Hits 37559 37613 +54
+ Misses 2934 2932 -2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| - [Go](https://go.dev/) (1.23 or later) | ||
| - [Node.js](https://nodejs.org/en) (22 or later) | ||
| - [PostgreSQL](https://www.postgresql.org/) (16 or later) | ||
| - [Redis](https://redis.io/) (Latest stable release) |
There was a problem hiding this comment.
Technically, Redis 7 is preferred. IIRC, it was recently pinned to that version in CI. Not that it really matters anyways as we are moving stuff off Redis anyways in prevision of it's removal
| make web-watch | ||
| ``` | ||
| 6. From the cloned repository root (in a new terminal), start Docker Compose to run the backend services. |
There was a problem hiding this comment.
Also, how would this exactly work? Running the docker compose command runs the entire stack including the frontend. We override ESBuild's dist, but we still start all containers
Co-authored-by: Dominic R <[email protected]> Signed-off-by: Tana M Berry <[email protected]>
Co-authored-by: Dominic R <[email protected]> Signed-off-by: Tana M Berry <[email protected]>
Co-authored-by: Dominic R <[email protected]> Signed-off-by: Tana M Berry <[email protected]>
Co-authored-by: Dominic R <[email protected]> Signed-off-by: Tana M Berry <[email protected]>
Co-authored-by: Dominic R <[email protected]> Signed-off-by: Tana M Berry <[email protected]>
Signed-off-by: Tana M Berry <[email protected]>
Signed-off-by: Tana M Berry <[email protected]>
Signed-off-by: Tana M Berry <[email protected]>
Signed-off-by: Tana M Berry <[email protected]>
Signed-off-by: Teffen Ellis <[email protected]>
Signed-off-by: Teffen Ellis <[email protected]>
|
authentik PR Installation instructions Instructions for docker-composeAdd the following block to your AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-53809e3a305558d9f08a9030182c682a9711c6b4
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-53809e3a305558d9f08a9030182c682a9711c6b4Afterwards, run the upgrade commands from the latest release notes. |
|
|
||
| def generate_local_config(): | ||
| """Generate a local development configuration""" | ||
| # TODO: This should be generated and validated against a schema, such as Pydantic. |
There was a problem hiding this comment.
Do we want to leave this as a TODO for now? Otherwise, LGTM
There was a problem hiding this comment.
I'm fine with this as is, an improvement for future iterations
Details
This PR clarifies the frontend only setup, and adds additional documentation to the authentik config file.
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)