keycloak-scim/docs/documentation
Pedro Ruivo 24fce87a8e
Deprecate old remote store (feedback)
Closes #32577

Signed-off-by: Pedro Ruivo <pruivo@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
2024-09-11 14:08:53 +00:00
..
aggregation
api_documentation
authorization_services Move documentation to keycloak-client 2024-09-04 10:55:46 +02:00
dist
header-maven-plugin
internal_resources
release_notes Lightweight access tokens for Admin REST API (#32347) 2024-09-04 18:04:23 +02:00
server_admin Removing the extra two-minute Window for persistent user sessions (#32660) 2024-09-09 09:28:48 +02:00
server_development Move documentation to keycloak-client 2024-09-04 10:55:46 +02:00
tests Add docs for the OpenTelemetry tracing 2024-08-13 08:46:48 +02:00
topics/templates Add docs for the OpenTelemetry tracing 2024-08-13 08:46:48 +02:00
upgrading Deprecate old remote store (feedback) 2024-09-11 14:08:53 +00:00
.asciidoctorconfig
.gitattributes
.gitignore
.vale.ini
build-auto.sh
get-version.sh
License.html
pom.xml
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