keycloak/docs/documentation
Emmanuel Lécharny 1dc97d5d4d
Update ldap.adoc with ApacheDS details
Added some precision about ApacheDS password management.

Closes #39136

Signed-off-by: Emmanuel Lécharny <elecharny@apache.org>
Signed-off-by: Alexander Schwartz <alexander.schwartz@gmx.net>
Co-authored-by: Alexander Schwartz <alexander.schwartz@gmx.net>
2025-04-23 07:55:59 +02:00
..
aggregation
api_documentation
authorization_services fix: adds back reporting of non-ip client addresses (#37797) 2025-03-27 19:33:20 +00:00
dist
header-maven-plugin
internal_resources
release_notes Introducing IdpLinkAction as AIA to replace client-initiated account linking (#38952) 2025-04-17 13:20:05 +02:00
server_admin Update ldap.adoc with ApacheDS details 2025-04-23 07:55:59 +02:00
server_development Introducing IdpLinkAction as AIA to replace client-initiated account linking (#38952) 2025-04-17 13:20:05 +02:00
tests Check HTML head for redirects 2025-04-04 18:40:41 +02:00
topics/templates Remove CACHE-EMBEDDED-REMOTE-STORE experimental feature 2025-04-16 12:01:55 +00:00
upgrading Introducing IdpLinkAction as AIA to replace client-initiated account linking (#38952) 2025-04-17 13:20:05 +02:00
.asciidoctorconfig
.gitattributes
.gitignore
.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.

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