trustchain-oc1-orchestral
/
authentik
Archived
10
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

website/docs: add instruction for local.env.yml for frontend dev 

Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
This commit is contained in:
Jens Langhammer 2021-06-22 12:06:55 +02:00
parent c297f28552
commit cea1289186
1 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
website/developer-docs/frontend-only-dev-environment.md
View File

@ -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: 3. Add the following entry to your `.env` file:
``` ```
AUTHENTIK_WEB__LOAD_LOCAL_FILES=true
AUTHENTIK_IMAGE=beryju.org/authentik/server AUTHENTIK_IMAGE=beryju.org/authentik/server
AUTHENTIK_TAG=gh-next AUTHENTIK_TAG=gh-next
AUTHENTIK_OUTPOSTS__DOCKER_IMAGE_BASE=beryju.org/authentik/outpost-%(type)s: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 ```yaml
version: '3.2' 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: volumes:
- ./web:/web - ./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 `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. Run `make gen-web` in the project root directory to generate the API Client used by the web interfaces
7. `cd web` 8. `cd web`
8. Run `npm i` and then `npm run watch` to start the build process. 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). You can now access authentik on http://localhost:9000 (or https://localhost:9443).