libre.sh/keycloak-scim
2
0
Fork 0
Code Issues 14 Pull requests Releases Packages Activity Actions 6
keycloak-scim/docs/documentation
History
Martin Bartoš 960e3503ec
Artifact SLF4J LOG4J-12 has been relocated (#20113)
2023-05-05 13:57:45 +02:00
..
.github/workflows Integrate documentation into parent build 2023-03-20 13:09:23 +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 Run tests for the moved documentation (#19278) 2023-03-28 12:35:27 +02: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 Moving docs to new folder 2023-03-20 09:07:58 +01:00
release_notes Fix links (#20147) 2023-05-04 10:27:52 +02:00
securing_apps Fix links (#20147) 2023-05-04 10:27:52 +02:00
server_admin Improve key rotation section (#19168) 2023-04-19 11:04:13 -03:00
server_development Ability to override default/built-in providers with same providerId. Using ProviderFactory.order() for choosing priority providers 2023-04-25 18:04:58 +02:00
tests Artifact SLF4J LOG4J-12 has been relocated (#20113) 2023-05-05 13:57:45 +02:00
topics/templates Remove latest vs. archive document header (#20103) 2023-05-03 09:16:34 +00:00
upgrading All commands now auto-reaugment except show-config 2023-04-21 15:06:51 +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 Moving docs to new folder 2023-03-20 09:07:58 +01: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 Remove latest vs. archive document header (#20103) 2023-05-03 09:16:34 +00:00
README.md Fix the links to the docs which have three groups starting from KC19 (#20035) 2023-05-03 08:58:52 +02:00
release-details Moving docs to new folder 2023-03-20 09:07:58 +01: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