Update README

This commit is contained in:
teutat3s 2023-07-14 23:16:59 +02:00
parent c0abc24aa2
commit 8fabcc79ee
Signed by: teutat3s
GPG key ID: 4FA1D3FA524F22C1

View file

@ -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