keycloak-scim/docs/documentation
Jon Koops 77fb3c4dd4
Use correct host URL for Admin Console requests (#30535)
Closes #30432

Signed-off-by: Jon Koops <jonkoops@gmail.com>
2024-06-19 15:21:53 +02: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 typos found by codespell in docs (#28890) 2024-05-03 12:41:16 +00:00
dist Run tests for the moved documentation (#19278) 2023-03-28 12:35:27 +02:00
header-maven-plugin Update Maven dependency versions for docs 2024-02-01 13:42:25 +01:00
internal_resources Update docs/documentation/internal_resources/contributing.adoc 2023-06-02 07:58:59 -03:00
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 add RS256 algorithm to webauthn default policy (#30528) 2024-06-19 10:16:46 +02: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 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 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.

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