Skip to content

CookedApps/keycloak-documentation

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 Documentation repository:

git clone https://github.com/keycloak/keycloak-documentation.git
cd keycloak-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-documentation.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 a latest build run:

mvn clean install -Dlatest

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

Building RH-SSO Documentation

Keycloak is the basis of Red Hat Single Sign-On. The same documentation sources are used, but they are built slightly differently.

To build the documentation for RH-SSO run:

mvn clean install -Dproduct

Or to build a specific guide run:

mvn clean install -Dproduct -f GUIDE_DIR

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

If you have ccutil installed you can build the guides with:

./build-product.sh

Or individual guides with:

./build-product.sh GUIDE_DIR

License

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 44.0%
  • Java 28.9%
  • Shell 27.1%