History

Jon Koops 5ac8ffa5b5 Move unrelated files out of `common` resources (#32285 ) Closes #24861 Signed-off-by: Jon Koops <jonkoops@gmail.com>		2024-08-22 09:57:15 +02:00
..
aggregation	Convert chapter planning for securing applications and services to guides	2024-08-01 16:45:56 +02:00
api_documentation
authorization_services	Move oidc documentation to guides (#31627 )	2024-07-30 09:46:14 +02:00
dist
header-maven-plugin
internal_resources
release_notes	Make sure federationLink always map to the storage provider associated with federated users	2024-08-20 11:27:22 +02:00
server_admin	Support for selecting an organization when requesting the organization scope	2024-08-21 13:04:58 +02:00
server_development	added documentation on how use npm packages (#31426 )	2024-08-16 11:09:18 +02:00
tests	Add docs for the OpenTelemetry tracing	2024-08-13 08:46:48 +02:00
topics/templates	Add docs for the OpenTelemetry tracing	2024-08-13 08:46:48 +02:00
upgrading	Move unrelated files out of `common` resources (#32285 )	2024-08-22 09:57:15 +02:00
.asciidoctorconfig
.gitattributes
.gitignore
.vale.ini
build-auto.sh	Convert chapter planning for securing applications and services to guides	2024-08-01 16:45:56 +02:00
get-version.sh
License.html
pom.xml	Convert chapter planning for securing applications and services to guides	2024-08-01 16:45:56 +02:00
README.md

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:

mvn clean install -am -pl docs/documentation/dist -Pdocumentation

Or to build a specific guide run:

mvn clean install -pl docs/documentation/GUIDE_DIR -Pdocumentation

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

mvn clean install ... -Platest,documentation

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