keycloak-scim/docs/documentation
2023-03-23 11:45:34 +01:00
..
.github/workflows Integrate documentation into parent build 2023-03-20 13:09:23 +01:00
aggregation Moving docs to new folder 2023-03-20 09:07:58 +01:00
api_documentation Moving docs to new folder 2023-03-20 09:07:58 +01:00
authorization_services Moving docs to new folder 2023-03-20 09:07:58 +01:00
dist Moving docs to new folder 2023-03-20 09:07:58 +01: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 Moving docs to new folder 2023-03-20 09:07:58 +01:00
securing_apps Moving docs to new folder 2023-03-20 09:07:58 +01:00
server_admin Service Accounts Client must create the Client ID mapper with Token Claim Name as client_id 2023-03-23 11:45:34 +01:00
server_development Explicitly add note to the docs that admin user needs to be created be created before using admin REST API (#19246) 2023-03-22 21:19:09 +01:00
tests Skip on deploy plugin in documentation tests module 2023-03-22 12:40:32 +01:00
topics/templates Moving docs to new folder 2023-03-20 09:07:58 +01:00
upgrading Service Accounts Client must create the Client ID mapper with Token Claim Name as client_id 2023-03-23 11:45:34 +01:00
.asciidoctorconfig Moving docs to new folder 2023-03-20 09:07:58 +01: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 Skip deploying docs to Maven (#19192) 2023-03-21 07:52:34 +01:00
README.md Integrate documentation into parent build 2023-03-20 13:09:23 +01:00
release-details Moving docs to new folder 2023-03-20 09:07:58 +01:00
set-version.sh Moving docs to new folder 2023-03-20 09:07:58 +01:00
sync.sh Moving docs to new folder 2023-03-20 09:07:58 +01: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

Or to build a specific guide run:

mvn clean install -f GUIDE_DIR

By default, an archive version of the documentation is built. To build the latest build run:

mvn clean install -Dlatest

You can then view the documentation by opening GUIDE_DIR/target/generated-docs/index.html.

License