2020-07-16 20:44:57 +00:00
|
|
|
# Keycloak on Quarkus
|
2019-10-08 09:20:37 +00:00
|
|
|
|
2020-07-16 20:44:57 +00:00
|
|
|
The module holds the codebase to run Keycloak on top of [Quarkus](https://quarkus.io/):
|
|
|
|
|
|
|
|
|
|
├── deployment
|
|
|
|
|
│ ├── Build-time codebase with all the necessary steps to build and configure the server
|
|
|
|
|
│
|
|
|
|
|
├── runtime
|
|
|
|
|
│ ├── Runtime codebase with all the runtime code
|
|
|
|
|
│
|
|
|
|
|
└── server
|
|
|
|
|
├── The server itself, only responsible for generating the server artifacts
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Activating the Module
|
|
|
|
|
|
|
|
|
|
The module isn't enabled by default. To enable it please activate the `quarkus` profile.
|
2019-10-08 09:20:37 +00:00
|
|
|
|
2019-10-11 14:16:27 +00:00
|
|
|
## Building
|
|
|
|
|
|
2020-07-16 20:44:57 +00:00
|
|
|
To build the module and produce the artifacts to run a server:
|
|
|
|
|
|
2019-10-11 14:16:27 +00:00
|
|
|
mvn -f ../pom.xml clean install -DskipTestsuite -DskipExamples -DskipTests -Pquarkus
|
|
|
|
|
|
2020-07-16 20:44:57 +00:00
|
|
|
### Building the Distribution
|
|
|
|
|
|
|
|
|
|
To build the module as well as the distribution packages:
|
|
|
|
|
|
|
|
|
|
mvn -f ../pom.xml clean install -DskipTestsuite -DskipExamples -DskipTests -Pquarkus,distribution
|
|
|
|
|
|
|
|
|
|
The distribution packages (ZIP and TAR) should be available at [../distribution/server-x](../distribution/server-x/target).
|
|
|
|
|
|
2019-10-11 14:16:27 +00:00
|
|
|
## Running
|
2019-10-08 09:20:37 +00:00
|
|
|
|
2020-09-15 14:22:11 +00:00
|
|
|
By default, the HTTP port is disabled and you need to provide the key material to configure HTTPS. If you want to enable
|
|
|
|
|
the HTTP port, run the server in development mode as follows:
|
|
|
|
|
|
|
|
|
|
java -jar server/target/lib/quarkus-run.jar --profile=dev
|
|
|
|
|
|
2020-07-16 20:44:57 +00:00
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
### Development Mode
|
|
|
|
|
|
|
|
|
|
To run the server in development mode:
|
2019-10-08 09:20:37 +00:00
|
|
|
|
|
|
|
|
cd server
|
2019-10-11 14:16:27 +00:00
|
|
|
mvn compile quarkus:dev
|
2020-07-16 20:44:57 +00:00
|
|
|
|
|
|
|
|
You should be able to attach your debugger to port `5005`.
|
|
|
|
|
|
|
|
|
|
Changes to files such as `server/src/main/resources` or `server/src/main/resources/META-INF/keycloak.properties` should
|
|
|
|
|
be recognized automatically when running in development mode.
|
|
|
|
|
|
|
|
|
|
However, considering that there is no real code in the `server` module (but from `runtime` and its dependencies), changes you make to
|
|
|
|
|
dependencies (e.g: services, model, etc) won't be reflected into the running server. However, you can still leverage the
|
|
|
|
|
hot reload capabilities from your IDE to make changes at runtime.
|
2019-10-11 14:16:27 +00:00
|
|
|
|
2020-07-16 20:44:57 +00:00
|
|
|
NOTE: We need to improve DevX and figure out why changes to dependencies are not being recognized when running tests or running
|
|
|
|
|
Quarkus Dev Mode.
|
