No description
Find a file
2017-12-05 08:41:57 +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 Change curl PAT example to use form parameters instead of BASIC 2017-11-30 10:56:28 +01:00
getting_started added link to zip (#226) 2017-11-08 08:59:09 +01:00
internal_resources cleaned up existing styleguide file and fixed a minor format issue in the contributing file 2017-11-15 09:45:26 -06:00
securing_apps [KEYCLOAK-3629] - Documentation for confidential-port 2017-11-30 10:39:38 +01:00
server_admin add the missing binding step to enable the x509 client authentication 2017-11-30 11:41:27 +01:00
server_development fix typo in configuration example of user storage provider 2017-11-30 10:55:57 +01:00
server_installation KEYCLOAK-5950 - fixed cross references 2017-11-30 06:56:32 -06:00
tests Tweak output 2017-12-05 08:31:02 +01:00
topics/templates KEYCLOAK-4188 Documentation for Cross DC 2017-11-29 11:32:32 -06:00
upgrading KEYCLOAK-5846 2017-12-04 16:05:20 +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:41:57 +01: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 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