keycloak-scim/docs/documentation
Alexander Schwartz 01939bcf34
Remove concurrent loading of remote sessions as at startup time only one node is up anyway. (#25709)
Closes #22082

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Martin Kanis <martin-kanis@users.noreply.github.com>
2024-01-09 16:55:22 +01:00
..
aggregation Remove latest vs. archive document header (#20103) 2023-05-03 09:16:34 +00:00
api_documentation Run tests for the moved documentation (#19278) 2023-03-28 12:35:27 +02:00
authorization_services Fix broken links (#24476) 2023-11-13 09:17:34 +01:00
dist Run tests for the moved documentation (#19278) 2023-03-28 12:35:27 +02:00
header-maven-plugin Moving docs to new folder 2023-03-20 09:07:58 +01:00
internal_resources Update docs/documentation/internal_resources/contributing.adoc 2023-06-02 07:58:59 -03:00
release_notes Remove concurrent loading of remote sessions as at startup time only one node is up anyway. (#25709) 2024-01-09 16:55:22 +01:00
securing_apps Documentation about Australia Consumer Data Right security profile 2023-12-19 21:06:03 +01:00
server_admin Creating documentation for Lightweight access token(#25743) 2024-01-09 09:48:20 +01:00
server_development Remove topic on user attributes in Account Console 2023-12-15 12:07:35 +01:00
tests Fix broken link to node.js and internal anchor 2023-11-13 12:20:54 +01:00
topics/templates Remove adapters from product documentation (#21177) 2023-07-11 13:32:52 +02:00
upgrading Remove concurrent loading of remote sessions as at startup time only one node is up anyway. (#25709) 2024-01-09 16:55:22 +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 Moving docs to new folder 2023-03-20 09:07:58 +01:00
get-version.sh Moving docs to new folder 2023-03-20 09:07:58 +01:00
License.html Moving docs to new folder 2023-03-20 09:07:58 +01:00
pom.xml Replace guide with a placeholder for downstream docs (#20266) 2023-05-16 08:59:11 +02:00
README.md Changed references to Jira issues to Github issues 2023-05-09 08:54:25 +02: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.

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