mirror/keycloak
1
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2025-12-21 14:30:05 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fix building instructions

Browse Source 
Closes #22320
This commit is contained in:
Václav Muzikář
2023-08-08 16:57:59 +02:00
committed by Bruno Oliveira da Silva
parent 4900165691
commit bcb99e63f7
1 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/building.md
View File

@@ -18,11 +18,17 @@ To build Keycloak run:
./mvnw clean install ./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: 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** **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" export MAVEN_OPTS="-Dmaven.build.cache.enabled=true"
### Building Quarkus Distribution ### Starting Keycloak
Please, take a look at this [documentation](../quarkus/README.md).
## Starting Keycloak
To start Keycloak during development first build as specified above, then run: To start Keycloak during development first build as specified above, then run:
./mvnw -f testsuite/utils/pom.xml exec:java -Pkeycloak-server java -jar quarkus/server/target/lib/quarkus-run.jar start-dev
When running testsuite, by default an account with username `admin` and password `admin` will be created within the master realm at start.
To stop the server press `Ctrl + C`. To stop the server press `Ctrl + C`.
For more details, follow the [`quarkus` module documentation](../quarkus/README.md).
## Working with the codebase ## 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 We don't currently enforce a code style in Keycloak, but a good reference is the code style used by WildFly. This can be