upstream/keycloak
1
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2026-02-03 20:39:33 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
keycloak/docs/documentation
History
Stan Silvert 70b762ce32 Clarify documentation. 
Signed-off-by: Stan Silvert <ssilvert@redhat.com>
(cherry picked from commit eb77c055f5)
2026-01-13 16:23:29 -03:00
..
aggregation Add missing artifact descriptions to allow Maven Central Portal Publisher pass validation process. (#40822) 2025-08-12 16:50:17 +02:00
api_documentation Add missing artifact descriptions to allow Maven Central Portal Publisher pass validation process. (#40822) 2025-08-12 16:50:17 +02:00
authorization_services Updated the screenshot to correctly show "Apply to Resource Type" enabled, 2025-09-02 12:27:36 -03:00
dist Add missing artifact descriptions to allow Maven Central Portal Publisher pass validation process. (#40822) 2025-08-12 16:50:17 +02:00
header-maven-plugin Add missing artifact descriptions to allow Maven Central Portal Publisher pass validation process. (#40822) 2025-08-12 16:50:17 +02:00
internal_resources Adjust documentation according to new home in keycloak/docs/documentation 2024-11-28 14:28:11 +01:00
release_notes Use correct anchor for mdc logging in 26.5.0 release notes 2026-01-07 08:43:10 +01:00
server_admin Clarify documentation. 2026-01-13 16:23:29 -03:00
server_development Document missing artifact dependency for UserStoragePrivateUtil 2025-11-10 10:41:12 -03:00
tests Finalizing 26.5 release notes 2026-01-05 14:10:32 +01:00
topics/templates Release notes update for Keycloak 26.5 with core-clients related contributions (#44986) 2025-12-18 10:48:27 +01:00
upgrading Add indexes to BROKER_LINK table 2026-01-12 13:56:09 +01:00
.asciidoctorconfig Remove latest vs. archive document header (#20103) 2023-05-03 09:16:34 +00:00
.gitattributes Moving docs to new folder 2023-03-20 09:07:58 +01:00
.gitignore Cache Node.js installation and PNPM store 2023-10-30 07:50:06 -04:00
.vale.ini Moving docs to new folder 2023-03-20 09:07:58 +01:00
build-auto.sh Convert chapter planning for securing applications and services to guides 2024-08-01 16:45:56 +02:00
get-version.sh Moving docs to new folder 2023-03-20 09:07:58 +01:00
License.html Fix typos found by codespell in docs (#28890) 2024-05-03 12:41:16 +00:00
pom.xml Add missing artifact descriptions to allow Maven Central Portal Publisher pass validation process. (#40822) 2025-08-12 16:50:17 +02:00
README.md Add build documentation for REST API and Javadoc 2025-09-01 11:37:26 +00: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.

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.

To build the REST API documentation and the Javadoc:

  • Export the JAVA_HOME variable, for example: 
    export JAVA_HOME=/usr/lib/jvm/java-21-openjdk
    (without this, you may get the following error: Unable to find javadoc command: The environment variable JAVA_HOME is not correctly set.)
  • Run: 
    ./mvnw clean package -am -pl services -Pjboss-release -DskipTests

You can view the generated docs by opening the following files:

  • REST API: services/target/apidocs-rest/output/index.html
  • Javadoc: services/target/apidocs/index.html

License