No description
Find a file
2017-09-05 11:09:06 -06:00
aggregation Convert frames.html into non-frame global navigation bar 2017-09-05 11:09:06 -06:00
api_documentation Fixed api docs 2017-09-04 21:04:01 +02:00
authorization_services Convert frames.html into non-frame global navigation bar 2017-09-05 11:09:06 -06:00
getting_started Convert frames.html into non-frame global navigation bar 2017-09-05 11:09:06 -06:00
internal_resources Removed file that shouldn't be here 2017-08-30 09:14:56 +02:00
securing_apps Convert frames.html into non-frame global navigation bar 2017-09-05 11:09:06 -06:00
server_admin Convert frames.html into non-frame global navigation bar 2017-09-05 11:09:06 -06:00
server_development Convert frames.html into non-frame global navigation bar 2017-09-05 11:09:06 -06:00
server_installation Convert frames.html into non-frame global navigation bar 2017-09-05 11:09:06 -06:00
topics/templates Update Fuse version 2017-09-05 05:45:50 +02:00
upgrading Convert frames.html into non-frame global navigation bar 2017-09-05 11:09:06 -06:00
.gitattributes .git files 2016-05-04 11:11:47 -04:00
.gitignore Added build scripts for ccutil 2017-08-29 09:30:27 +02:00
build-auto.sh KEYCLOAK-5358 Move upgrade guide 2017-08-31 20:39:42 +02:00
build-product.sh Added build scripts for ccutil 2017-08-29 09:30:27 +02:00
License.html KEYCLOAK-4506 Added missing ASL2 license file 2017-03-09 13:39:14 +01:00
pom.xml Convert frames.html into non-frame global navigation bar 2017-09-05 11:09:06 -06:00
README.md Update README 2017-08-29 09:33:20 +02:00

Keycloak Documentation

Open Source Identity and Access Management for modern Applications and Services.

For more information about Keycloak visit Keycloak homepage and Keycloak blog.

Building Keycloak Documentation

Ensure you have Maven installed

First clone the Keycloak Documentation repository:

git clone https://github.com/keycloak/keycloak-documentation.git
cd keycloak-documentation

To build Keycloak Documentation run:

mvn clean install

Or to build a specific guide run:

mvn clean install -f GUIDE_DIR

You can then view the documentation by opening GUIDE_DIR/target/frames.html or GUIDE_DIR/target/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 slighty 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/frames.html or GUIDE_DIR/target/index.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