diff --git a/README.md b/README.md index 33b6cec..2e9384b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ # keycloak-md5 -Adds MD5 hashing support to Keycloak +Add MD5 hashing support to Keycloak. + +## Requirements + +- Java 11 +- Maven 3.6 + +## Building + +1. `mvn install` +2. `mvn package` +3. It should generate a JAR archive under `./target/keycloak-md5.jar` + +## Deploying to Keycloak + +1. Move the built JAR file to Keycloak's directory `standalone/deployments/` (on Keycloak under Docker: `/opt/jboss/keycloak/standalone/deployments`) +2. Watch the `standalone/deployments/` for the file `keycloak-md5.jar.deployed` + +:warning: If you find instead the file `keycloak-md5.jar.failed`, you can run the command `cat keycloak-md5.jar.failed` to find out what went wrong with your deployment.