upstream/keycloak
1
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2026-02-19 02:48:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 17
keycloak/docs/documentation
History
Akbar Husain 3f62bb4d2b
Make shebang in bash scripts consistent (#37369) 
Closes #34983

Signed-off-by: akbarhusainpatel <apatel@intermiles.com>
2026-02-17 11:32:28 +01: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 Fixing authorization service docs to remove references to the default settings 2026-02-13 17:18:15 +01: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 Make rolling updates for patch releases fully supported and Updated docs, release notes and upgrading guide for zero-downtime patch releases 2026-02-16 15:11:16 +00:00
server_admin Increase workflow executor timeout to 5 seconds by default 2026-02-13 14:33:31 -03:00
server_development Realign source code examples in auth-spi doc 2026-01-06 12:18:42 +01:00
tests Enable graceful HTTP shutdown and document default behavior 2026-02-13 14:28:49 +00:00
topics/templates DPoP Guide (#45274) 2026-01-13 11:01:28 +01:00
upgrading Make rolling updates for patch releases fully supported and Updated docs, release notes and upgrading guide for zero-downtime patch releases 2026-02-16 15:11:16 +00: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 Make shebang in bash scripts consistent (#37369) 2026-02-17 11:32:28 +01:00
get-version.sh Make shebang in bash scripts consistent (#37369) 2026-02-17 11:32:28 +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 Java 25 support (#45872) 2026-02-10 23:35:35 +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-25-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