History

Pedro Igor ceb085e7b8 Update the UPDATE_EMAIL feature to rely on the user profile configuration when rendering templates and validating the email Closes #25704 Signed-off-by: Pedro Igor <pigor.craveiro@gmail.com>		2023-12-20 15:15:06 -03:00
..
aggregation
api_documentation
authorization_services	Fix broken links (#24476 )	2023-11-13 09:17:34 +01:00
dist
header-maven-plugin
internal_resources	Update docs/documentation/internal_resources/contributing.adoc	2023-06-02 07:58:59 -03:00
release_notes	Update the UPDATE_EMAIL feature to rely on the user profile configuration when rendering templates and validating the email	2023-12-20 15:15:06 -03:00
securing_apps	Documentation about Australia Consumer Data Right security profile	2023-12-19 21:06:03 +01:00
server_admin	Client policies : executor for enforcing DPoP	2023-12-18 10:45:18 +01:00
server_development	Remove topic on user attributes in Account Console	2023-12-15 12:07:35 +01:00
tests	Fix broken link to node.js and internal anchor	2023-11-13 12:20:54 +01:00
topics/templates	Remove adapters from product documentation (#21177 )	2023-07-11 13:32:52 +02:00
upgrading	Update the UPDATE_EMAIL feature to rely on the user profile configuration when rendering templates and validating the email	2023-12-20 15:15:06 -03: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
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.