No description
Find a file
Stian Thorgersen 5d22aa52c3 Merge pull request #197 from ASzc/KEYCLOAK-5388
Add overrides to asciidoctor's CSS so it looks more like keycloak.org
2017-09-08 07:07:43 +02:00
aggregation Add overrides to asciidoctor's CSS so it looks more like keycloak.org 2017-09-07 12:09:16 -06:00
api_documentation Fix to api doc overview 2017-09-07 14:40:57 +02:00
authorization_services KEYCLOAK-5404 Add testing 2017-09-07 14:09:11 +02:00
getting_started Convert frames.html into non-frame global navigation bar 2017-09-05 11:09:06 -06:00
internal_resources KEYCLOAK-5404 Add testing 2017-09-07 14:09:11 +02:00
securing_apps KEYCLOAK-5404 Add testing 2017-09-07 14:09:11 +02:00
server_admin KEYCLOAK-5404 Add testing 2017-09-07 14:09:11 +02:00
server_development KEYCLOAK-5404 Add testing 2017-09-07 14:09:11 +02:00
server_installation KEYCLOAK-5404 Add testing 2017-09-07 14:09:11 +02:00
tests KEYCLOAK-5404 Add testing 2017-09-07 14:09:11 +02: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