Keycloak Documentation

Open Source Identity and Access Management for modern Applications and Services.

For more information about Keycloak visit the Keycloak homepage and Keycloak blog.

Contributing to Keycloak Documentation

See our Contributor's Guide. The directory also includes a set of templates and other resources to help you get started.

If you want to file a bug report or tell us about any other issue with this documentation, you are invited to please use our issue tracker.

Ensure that you have Maven installed.

First, clone the Keycloak repository:

git clone https://github.com/keycloak/keycloak.git
cd keycloak/docs/documentation

If you are using Windows, you need to run the following command with administrator privilege because this project uses symbolic links:

git clone -c core.symlinks=true https://github.com/keycloak/keycloak.git

To build Keycloak Documentation run:

./mvnw clean install -am -pl docs/documentation/dist -Pdocumentation

Or to build a specific guide run:

./mvnw clean install -pl docs/documentation/GUIDE_DIR -Pdocumentation

By default, an archive version of the documentation is built. To build the latest build run:

./mvnw clean install ... -Platest,documentation

You can then view the documentation by opening docs/documentation/GUIDE_DIR/target/generated-docs/index.html.

To build the REST API documentation and the Javadoc:

Export the JAVA_HOME variable, for example:
```
export JAVA_HOME=/usr/lib/jvm/java-25-openjdk
```
(without this, you may get the following error: Unable to find javadoc command: The environment variable JAVA_HOME is not correctly set.)

Run:

./mvnw clean package -am -pl services -Pjboss-release -DskipTests

You can view the generated docs by opening the following files: