From cea12891862f0f257399409577e85009de03fb91 Mon Sep 17 00:00:00 2001 From: Jens Langhammer Date: Tue, 22 Jun 2021 12:06:55 +0200 Subject: [PATCH] website/docs: add instruction for local.env.yml for frontend dev Signed-off-by: Jens Langhammer --- .../frontend-only-dev-environment.md | 24 ++++++++++++------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/website/developer-docs/frontend-only-dev-environment.md b/website/developer-docs/frontend-only-dev-environment.md index 872c24b59..08707cab3 100644 --- a/website/developer-docs/frontend-only-dev-environment.md +++ b/website/developer-docs/frontend-only-dev-environment.md @@ -9,15 +9,22 @@ If you want to only make changes on the UI, you don't need a backend running fro 3. Add the following entry to your `.env` file: ``` - AUTHENTIK_WEB__LOAD_LOCAL_FILES=true AUTHENTIK_IMAGE=beryju.org/authentik/server AUTHENTIK_TAG=gh-next AUTHENTIK_OUTPOSTS__DOCKER_IMAGE_BASE=beryju.org/authentik/outpost-%(type)s:gh-next ``` - This will cause authentik to load static files from a folder and ignore the bundeled files. Also the beta image is used. + This will cause authentik to use the beta images. -4. Add this volume mapping to your compose file +4. Create a `local.env.yml` file to tell authentik to use local files instead of the bundled ones: + + ```yaml + log_level: debug + web: + load_local_files: true + ``` + +5. Add this volume mapping to your compose file ```yaml version: '3.2' @@ -28,14 +35,15 @@ If you want to only make changes on the UI, you don't need a backend running fro # [...] volumes: - ./web:/web + - ./local.env.yml:/local.env.yml ``` - This makes the local web files available to the authentik server. + This makes the local web files and the config file available to the authentik server. -5. Run `docker-compose up -d` to apply those changes to your containers. -6. Run `make gen-web` in the project root directory to generate the API Client used by the web interfaces -7. `cd web` -8. Run `npm i` and then `npm run watch` to start the build process. +6. Run `docker-compose up -d` to apply those changes to your containers. +7. Run `make gen-web` in the project root directory to generate the API Client used by the web interfaces +8. `cd web` +9. Run `npm i` and then `npm run watch` to start the build process. You can now access authentik on http://localhost:9000 (or https://localhost:9443).