From bcb99e63f70ecfeecf410d73937f29880bf42d8f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=A1clav=20Muzik=C3=A1=C5=99?= Date: Tue, 8 Aug 2023 16:57:59 +0200 Subject: [PATCH] Fix building instructions Closes #22320 --- docs/building.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/building.md b/docs/building.md index cd45695fef..2bb49bfa13 100644 --- a/docs/building.md +++ b/docs/building.md @@ -18,11 +18,17 @@ To build Keycloak run: ./mvnw clean install -This will build all modules and run the testsuite. +This will build all modules and run the testsuite. + +To build Keycloak with adapters run: + + ./mvnw clean install -Pdistribution To build only the server run: - ./mvnw -pl quarkus/dist -am -DskipTests clean install + ./mvnw -pl quarkus/deployment,quarkus/dist -am -DskipTests clean install + +You can then find the ZIP distribution in `quarkus/dist/target` folder. --- **NOTE** @@ -41,20 +47,16 @@ To enable it by default, add it to the `MAVEN_OPTS` environment variable: export MAVEN_OPTS="-Dmaven.build.cache.enabled=true" -### Building Quarkus Distribution - -Please, take a look at this [documentation](../quarkus/README.md). - -## Starting Keycloak +### Starting Keycloak To start Keycloak during development first build as specified above, then run: - ./mvnw -f testsuite/utils/pom.xml exec:java -Pkeycloak-server - -When running testsuite, by default an account with username `admin` and password `admin` will be created within the master realm at start. + java -jar quarkus/server/target/lib/quarkus-run.jar start-dev To stop the server press `Ctrl + C`. +For more details, follow the [`quarkus` module documentation](../quarkus/README.md). + ## Working with the codebase We don't currently enforce a code style in Keycloak, but a good reference is the code style used by WildFly. This can be