Files
keycloak/docs/documentation
Steven Hawkins 2b44c5676f fix: adding logic to isolate realm migration processing (#39377)
* fix: adding logic to isolate realm migration processing

also adding an info log for each realm migrated

closes: #33978 #38649

Signed-off-by: Steve Hawkins <shawkins@redhat.com>

* switching to an export strategy tolerant to read committed

also preventing creating cached users during export

Signed-off-by: Steve Hawkins <shawkins@redhat.com>

* updating the docs to still recommend shutting the server down for export

Signed-off-by: Steve Hawkins <shawkins@redhat.com>

* accounting for null managed users

Signed-off-by: Steve Hawkins <shawkins@redhat.com>

* refinements based upon review comments

Signed-off-by: Steve Hawkins <shawkins@redhat.com>

* Scaling back the docs

Signed-off-by: Alexander Schwartz <alexander.schwartz@gmx.net>

* Remove rogue release note

Signed-off-by: Václav Muzikář <vmuzikar@redhat.com>

---------

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
Signed-off-by: Alexander Schwartz <alexander.schwartz@gmx.net>
Signed-off-by: Václav Muzikář <vmuzikar@redhat.com>
Co-authored-by: Alexander Schwartz <alexander.schwartz@gmx.net>
Co-authored-by: Václav Muzikář <vmuzikar@redhat.com>
2025-06-30 08:31:57 -04:00
..

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.

Building Keycloak Documentation

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.

License