No description
Find a file
Stian Thorgersen 1f2f18a5a0 Update README
2017-08-29 09:33:20 +02:00
aggregation Convert documentation to AsciiDoctor 2017-08-28 20:10:09 +02:00
authorization_services Fix community build 2017-08-29 07:06:13 +02:00
getting_started Fix community build 2017-08-29 07:06:13 +02:00
internal_resources Update styleguide.adoc 2017-05-30 13:42:11 -05:00
securing_apps Fix community build 2017-08-29 07:06:13 +02:00
server_admin Fix community build 2017-08-29 07:06:13 +02:00
server_development Fix community build 2017-08-29 07:06:13 +02:00
server_installation Fix server installation guide 2017-08-29 07:16:35 +02:00
topics/templates More fixes 2017-08-29 06:43:34 +02: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
assembly.xml Convert documentation to AsciiDoctor 2017-08-28 20:10:09 +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 documentation to AsciiDoctor 2017-08-28 20:10:09 +02: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