History

Pedro Igor a0ad680346 Adding an alias to organization and exposing them to templates Closes #30312 Closes #30313 Signed-off-by: Pedro Igor <pigor.craveiro@gmail.com>		2024-06-20 14:36:14 -03:00
..
aggregation
api_documentation
authorization_services	Fix typos found by codespell in docs (#28890 )	2024-05-03 12:41:16 +00:00
dist
header-maven-plugin	Update Maven dependency versions for docs	2024-02-01 13:42:25 +01:00
internal_resources
release_notes	Infinispan Protostream Marshaller (#29474 )	2024-06-13 18:02:46 +02:00
securing_apps	Release notes for support application/jwt response in token introspec… (#30105 )	2024-06-04 06:49:13 +02:00
server_admin	Adding an alias to organization and exposing them to templates	2024-06-20 14:36:14 -03:00
server_development	doc: Quarkus launch rebuild optimization (#28320 )	2024-05-10 12:28:38 +02:00
tests	Remove link to management interface guide from ignored links in docs	2024-06-12 11:50:21 +02:00
topics/templates	Simplify Upgrade Guide structure	2024-03-11 16:22:46 +01:00
upgrading	Use correct host URL for Admin Console requests (#30535 )	2024-06-19 15:21:53 +02: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	Fix typos found by codespell in docs (#28890 )	2024-05-03 12:41:16 +00:00
pom.xml	Update Maven dependency versions for docs	2024-02-01 13:42:25 +01:00
README.md	Fix typos found by codespell in docs (#28890 )	2024-05-03 12:41:16 +00: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.

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.