2019-02-19 18:59:45 +00:00
|
|
|
## Building from source
|
|
|
|
|
|
2020-01-22 11:57:02 +00:00
|
|
|
Ensure you have JDK 8 (or newer), Maven 3.5.4 (or newer) and Git installed
|
2019-02-19 18:59:45 +00:00
|
|
|
|
|
|
|
|
java -version
|
|
|
|
|
mvn -version
|
|
|
|
|
git --version
|
|
|
|
|
|
|
|
|
|
First clone the Keycloak repository:
|
|
|
|
|
|
|
|
|
|
git clone https://github.com/keycloak/keycloak.git
|
|
|
|
|
cd keycloak
|
|
|
|
|
|
|
|
|
|
To build Keycloak run:
|
|
|
|
|
|
2020-08-18 15:12:33 +00:00
|
|
|
mvn clean install
|
2019-02-19 18:59:45 +00:00
|
|
|
|
|
|
|
|
This will build all modules and run the testsuite.
|
|
|
|
|
|
|
|
|
|
To build the ZIP distribution run:
|
|
|
|
|
|
2020-08-18 15:12:33 +00:00
|
|
|
mvn clean install -Pdistribution
|
2019-02-19 18:59:45 +00:00
|
|
|
|
|
|
|
|
Once completed you will find distribution archives in `distribution`.
|
|
|
|
|
|
|
|
|
|
To build only the server run:
|
|
|
|
|
|
|
|
|
|
mvn -Pdistribution -pl distribution/server-dist -am -Dmaven.test.skip clean install
|
|
|
|
|
|
2020-07-02 14:12:28 +00:00
|
|
|
---
|
|
|
|
|
**NOTE**
|
|
|
|
|
|
|
|
|
|
Classes from `org.keycloak.testsuite.*` packages aren't suitable to be used in production.
|
|
|
|
|
|
|
|
|
|
---
|
2019-02-19 18:59:45 +00:00
|
|
|
|
|
|
|
|
## Starting Keycloak
|
|
|
|
|
|
|
|
|
|
To start Keycloak during development first build as specified above, then run:
|
|
|
|
|
|
|
|
|
|
mvn -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.
|
|
|
|
|
|
|
|
|
|
To start Keycloak from the server distribution first build the distribution it as specified above, then run:
|
|
|
|
|
|
|
|
|
|
tar xfz distribution/server-dist/target/keycloak-<VERSION>.tar.gz
|
|
|
|
|
cd keycloak-<VERSION>
|
|
|
|
|
bin/standalone.sh
|
|
|
|
|
|
|
|
|
|
To stop the server press `Ctrl + C`.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## 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
|
|
|
|
|
retrieved from [Wildfly ide-configs](https://github.com/wildfly/wildfly-core/tree/master/ide-configs).To import formatting
|
|
|
|
|
rules, see following [instructions](http://community.jboss.org/wiki/ImportFormattingRules).
|
|
|
|
|
|
|
|
|
|
If your changes require updates to the database read [Updating Database Schema](updating-database-schema.md).
|
|
|
|
|
|
|
|
|
|
If your changes require introducing new dependencies or updating dependency versions please discuss this first on the
|
|
|
|
|
dev mailing list. We do not accept new dependencies to be added lightly, so try to use what is available.
|
