diff --git a/pom.xml b/pom.xml index 2f9924e..69cedc8 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ com.github.thomasdarimont.keycloak keycloak-health-checks - 19.0.3.0 + 20.0.0.0 @@ -18,11 +18,11 @@ 1.18.24 - 19.0.3 + 20.0.0 keycloak-${keycloak.version} 13.0.10.Final 2.0.2 - 2.7.6.Final + 2.13.3.Final diff --git a/readme.md b/readme.md index 677a120..965ff2a 100644 --- a/readme.md +++ b/readme.md @@ -11,7 +11,7 @@ A collection of health-checks for Keycloak subsystems. ## Requirements -* KeyCloak 19.0.3+ +* Keycloak 20.0.0 ## Compatibility @@ -20,6 +20,7 @@ A collection of health-checks for Keycloak subsystems. | 15.0.2.0 | 15.0.2 - 17.0.1 | not supported | | 17.0.1.4 | 17.0.1 - 18.0.1 | 17.0.1 - 18.0.1 | | 19.0.3.0 | 19.0.1 - 19.0.3 | 19.0.1 - 19.0.3 | +| 20.0.0.0 | 20.0.0 | not supported | ## Build @@ -48,97 +49,6 @@ To disable the `filesystem-health` check, one can use the following config setti spi-health-filesystem-health-enabled=false ``` - -## Keycloak-Legacy - -### Installation - -After the extension has been built, install it as a JBoss/WildFly module via `jboss-cli`: - -``` - -$ bin/jboss-cli.sh -You are disconnected at the moment. Type 'connect' to connect to the server or 'help' for the list of supported commands. -[disconnected /] connect -[standalone@localhost:9990 /] - -[standalone@localhost:9990 /] module add --name=com.github.thomasdarimont.keycloak.extensions.keycloak-health-checks --resources=/home/tom/dev/repos/gh/thomasdarimont/keycloak-dev/keycloak-health-checks/target/keycloak-health-checks.jar --dependencies=org.keycloak.keycloak-core,org.keycloak.keycloak-services,org.keycloak.keycloak-server-spi,org.keycloak.keycloak-server-spi-private,org.keycloak.keycloak-model-legacy,org.keycloak.keycloak-model-legacy-private,org.keycloak.keycloak-model-legacy-services,org.keycloak.keycloak-ldap-federation,org.keycloak.keycloak-kerberos-federation,org.jboss.resteasy.resteasy-jaxrs,org.apache.httpcomponents,com.google.guava,javax.api,javax.enterprise.api,javax.transaction.api,javax.ws.rs.api,com.fasterxml.jackson.core.jackson-core,com.fasterxml.jackson.core.jackson-databind,com.fasterxml.jackson.core.jackson-annotations,org.jboss.logging,org.infinispan,org.infinispan.commons -``` - -Alternatively, create `$KEYCLOAK_HOME/modules/com/github/thomasdarimont/keycloak/extensions/keycloak-health-checks/main/module.xml` and copy the .jar file next to the module.xml file: - -```xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -``` - -To uninstall the provider just remove the ... from `standalone.xml` or `standalone-ha.xml`. -To uninstall the module just remove the `com/github/thomasdarimont...` directory in your `modules` folder. - -### Configuration - -Edit the wildfly `standalone.xml` or `standalone-ha.xml` -`$KEYCLOAK_HOME/standalone/configuration/standalone.xml`: - -```xml -... - - auth - - - classpath:${jboss.home.dir}/providers/* - - module:com.github.thomasdarimont.keycloak.extensions.keycloak-health-checks - -... -``` - -... or register the provider via the module via `jboss-cli`: -``` -/subsystem=keycloak-server:list-add(name=providers,value=module:com.github.thomasdarimont.keycloak.extensions.keycloak-health-checks) -``` - -#### Disabling a Health-Check with Keycloak-Legacy - -A healh-check can be disabled via the jboss-cli. - -To disable the `filesystem-health` check, one can use the following command: -``` -/subsystem=keycloak-server/spi=health/:add -/subsystem=keycloak-server/spi=health/provider=filesystem-health/:add(enabled=false) -``` - ## Running example Start Keycloak and browse to: `http://localhost:8080/auth/realms/master/health/check`