No description
Find a file
2018-01-29 08:32:29 -06:00
aggregation Convert Authorization Service to a flat topic structure (#212) 2017-10-09 08:38:46 +02:00
api_documentation updated copyright year to 2018 across docs 2018-01-26 14:23:12 +01:00
authorization_services updated copyright year to 2018 across docs 2018-01-26 14:23:12 +01:00
getting_started updated copyright year to 2018 across docs 2018-01-26 14:23:12 +01:00
internal_resources Added a couple of details to contrib guide 2017-12-19 10:39:02 +01:00
securing_apps fixed need for variable 2018-01-26 14:27:52 +01:00
server_admin Fix typos in Server Admin 2018-01-26 14:25:22 +01:00
server_development Fix typos in Server Admin 2018-01-26 14:25:22 +01:00
server_installation updated copyright year to 2018 across docs 2018-01-26 14:23:12 +01:00
tests Tweak output 2017-12-05 08:31:02 +01:00
topics/templates updated version numbers 2018-01-29 08:32:29 -06:00
upgrading KEYCLOAK-6118 upgrading EAP adapters via RPM2 2018-01-26 14:25:51 +01: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 Tweak output 2017-12-05 08:57:42 +01:00
build-auto.sh KEYCLOAK-5404 Add testing 2017-09-07 14:09:11 +02:00
build-product.sh Mark tech preview features 2017-12-21 15:56:01 +01: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 created contributors guide and edited existing related files 2017-11-15 07:44:10 -06: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.

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.

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