History

Ryan Emerson 902abfdae4 JDBC_PING as default discovery protocol Closes #29399 - Add ProviderFactory#dependsOn to allow dependencies between ProviderFactories to be explicitly defined - Disable Infinispan default shutdownhook disabled to ensure lifecycle is managed exclusively by Keycloak - Remove Infinispan shutdown hook in KeycloakRecorder and manage EmbeddedCacheManager lifecycle only in DefaultInfinispanConnectionProviderFactory#close Signed-off-by: Ryan Emerson <remerson@redhat.com> Signed-off-by: Alexander Schwartz <aschwart@redhat.com> Co-authored-by: Alexander Schwartz <aschwart@redhat.com>		2024-10-22 20:19:19 +00:00
..
aggregation	Convert chapter planning for securing applications and services to guides	2024-08-01 16:45:56 +02:00
api_documentation	Remove inclusive language foreword	2024-06-27 15:22:03 +02:00
authorization_services	Automatically retrieve configuration for authorization	2024-10-18 14:03:36 +02:00
dist	Run tests for the moved documentation (#19278 )	2023-03-28 12:35:27 +02:00
header-maven-plugin	Use a default Java version from root POM (#29927 )	2024-06-21 14:19:31 +02:00
internal_resources	Update docs/documentation/internal_resources/contributing.adoc	2023-06-02 07:58:59 -03:00
release_notes	Add dark mode support to welcome theme and unify approach (#32495 )	2024-10-04 08:27:37 -04:00
server_admin	Update docs/documentation/server_admin/topics/threat/brute-force.adoc	2024-10-22 10:33:22 -03:00
server_development	fix: available SPIs should be found in Provider info (#33805 )	2024-10-11 06:47:24 +00:00
tests	Fixes release notes section on new login theme, keycloak.v2 (#33359 )	2024-09-30 15:38:29 +02:00
topics/templates	Re-add links to policy-enforcer to the authorization services documen… (#33905 )	2024-10-15 08:34:56 +02:00
upgrading	JDBC_PING as default discovery protocol	2024-10-22 20:19:19 +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	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	Convert chapter planning for securing applications and services to guides	2024-08-01 16:45:56 +02:00
README.md	Fix typos found by codespell in docs (#28890 )	2024-05-03 12:41:16 +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:

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.

License

Apache License, Version 2.0