No description
Find a file
Tana M Berry e950c260ea added link to zip (#226)
* tiny test

* added link to zip
2017-11-08 08:59:09 +01:00
aggregation Convert Authorization Service to a flat topic structure (#212) 2017-10-09 08:38:46 +02:00
api_documentation Fix to api doc overview 2017-09-07 14:40:57 +02:00
authorization_services [KEYCLOAK-5726] - Documentation for scopes-enforcement-mode (#222) 2017-11-07 10:04:57 +01:00
getting_started added link to zip (#226) 2017-11-08 08:59:09 +01:00
internal_resources KEYCLOAK-5404 Add testing 2017-09-07 14:09:11 +02:00
securing_apps Fix: s/is can/can/ (#220) 2017-11-08 08:56:40 +01:00
server_admin KEYCLOAK-5595 Review / polish documentation for Admin CLI (#215) 2017-10-16 14:37:45 +02:00
server_development Fix: s/regisration/registration/ (#223) 2017-11-08 08:56:50 +01:00
server_installation Fix broken links 2017-10-02 14:57:28 +02:00
tests Fix links (#230) 2017-11-08 08:36:22 +01:00
topics/templates KEYCLOAK-5404 Add testing 2017-09-07 14:09:11 +02:00
upgrading KEYCLOAK-5404 Add testing 2017-09-07 14:09:11 +02:00
.gitattributes .git files 2016-05-04 11:11:47 -04:00
.gitignore KEYCLOAK-5404 Add testing 2017-09-07 14:09:11 +02:00
.travis.yml KEYCLOAK-5404 Add testing 2017-09-07 14:09:11 +02:00
build-auto.sh KEYCLOAK-5404 Add testing 2017-09-07 14:09:11 +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 KEYCLOAK-5404 Add testing 2017-09-07 14:09:11 +02:00
README.md another tiny edit 2017-09-05 14:10:34 +01:00
tests.sh KEYCLOAK-5404 Add testing 2017-09-07 14:09:11 +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 that 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