From 8fabcc79eedf8095d7c0fa5e9fe6ce130d9ad91b Mon Sep 17 00:00:00 2001 From: teutat3s Date: Fri, 14 Jul 2023 23:16:59 +0200 Subject: [PATCH] Update README --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index bd6260d..ad0683a 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ ## Development setup -To start a dev keycloak instance that can show the theme, you need to do the following: +To start a Dev Keycloak instance that can show the pub.solar theme, you need to do the following: -1. Go into Keycloak, and export the `pub.solar` realm config. In Keycloak, open the pub.solar realm, click on the menu item "Realm settings", open the dropdown "Action", and click "Partial export". Move the generated JSON file into `./.dev-imports` in this repo. +1. Go into Keycloak's [Administration Console](https://auth.pub.solar/admin), and export the `pub.solar` realm config. In Keycloak, open the pub.solar realm, click on the menu item "Realm settings", open the dropdown "Action", and click "Partial export". Move the generated JSON file into `./.dev-imports` in this repo. 2. Run the following command: ``` @@ -16,10 +16,12 @@ To start a dev keycloak instance that can show the theme, you need to do the fol -e KEYCLOAK_ADMIN_PASSWORD=admin \ -v $(pwd):/opt/keycloak/themes/pub.solar \ -v $(pwd)/.dev-import:/opt/keycloak/data/import \ - quay.io/keycloak/keycloak:20.0.1 \ - start-dev --import-realm + quay.io/keycloak/keycloak:21.1.1 \ + start-dev --import-realm --features="declarative-user-profile" ``` 3. After this, you can start and stop the container using `docker start keycloak-theme-dev` and `docker-stop keycloak-theme-dev`. -4. Connect to the local keycloak instance at `http://localhost:8080` and open the administration console. In the `pub.solar` realm, click on the menu item "Clients", then the client "account", "Advanced" tab, "Authentication flow overrides" section, select "Webauthn Browser" for the "Browser Flow". Press save. +4. Connect to the local Keycloak instance at http://localhost:8080 and open the Administration Console. Login with username: `admin`, password: `admin`. + +5. To view the theme in action, open http://localhost:8080/realms/pub.solar/account