History

rmartinc 6d74e6b289 Escape slashes in full group path representation but disabled by default Closes #23900 Signed-off-by: rmartinc <rmartinc@redhat.com>		2024-04-12 10:53:39 +02:00
..
aggregation
api_documentation
authorization_services	Clean up feature IDs in the docs (#27418 )	2024-03-06 12:32:06 +01:00
dist
header-maven-plugin	Update Maven dependency versions for docs	2024-02-01 13:42:25 +01:00
internal_resources
release_notes	Release notes for lightweight access tokens and group together relate… (#28622 )	2024-04-11 20:02:33 +02:00
securing_apps	Documentation for changes related to 'You are already logged in' scen… (#28595 )	2024-04-11 08:18:41 +02:00
server_admin	Escape slashes in full group path representation but disabled by default	2024-04-12 10:53:39 +02:00
server_development	doc: add a note about lack of other JAX-RS support (#28048 )	2024-03-21 16:59:22 +01:00
tests	docs: Support management port for health and metrics (#28213 )	2024-04-09 14:33:30 +02:00
topics/templates	Simplify Upgrade Guide structure	2024-03-11 16:22:46 +01:00
upgrading	Escape slashes in full group path representation but disabled by default	2024-04-12 10:53:39 +02:00
.asciidoctorconfig
.gitattributes
.gitignore	Cache Node.js installation and PNPM store	2023-10-30 07:50:06 -04:00
.vale.ini
build-auto.sh
get-version.sh
License.html
pom.xml	Update Maven dependency versions for docs	2024-02-01 13:42:25 +01: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.