No description
Find a file
2018-09-10 09:04:47 -05:00
aggregation Add release notes to aggregation 2018-06-14 09:15:35 +02:00
api_documentation KEYCLOAK-7527 Release notes in documentation and additions for CD (#397) 2018-06-07 15:18:50 +02:00
authorization_services [KEYCLOAK-4902] - Response_mode parameter and release notes for authorization services 2018-08-14 12:05:43 +02:00
getting_started Markdown requires a CRLF before the list 2018-07-03 10:38:27 -05:00
header-maven-plugin KEYCLOAK-5574 Added edit this page on GitHub link 2018-02-14 10:17:38 +01:00
internal_resources edited to incorporate suggestions from Tana 2018-08-14 11:22:29 +02:00
openshift KEYCLOAK-8161 remove unused adoc files 2018-09-10 09:04:47 -05:00
release_notes Release notes for 4.4 2018-09-05 11:49:15 +02:00
securing_apps KEYCLOAK-7858 - OIDC servlet filter adapter OSGi support 2018-09-04 15:51:16 +02:00
server_admin KEYCLOAK-8069 Simplify config for fixed hostname provider 2018-08-17 14:47:08 +02:00
server_development KEYCLOAK-7527 Release notes in documentation and additions for CD (#397) 2018-06-07 15:18:50 +02:00
server_installation KEYCLOAK-6781 Wildfly 13: more documentation changes 2018-08-27 12:54:02 +02:00
tests Fix missing variables test 2018-07-30 10:37:35 +02:00
topics/templates Set version to 4.5.0.Final 2018-09-06 20:07:23 +02:00
upgrading [KEYCLOAK-6962] Added ways to (minor) upgrade rpm distribution 2018-09-05 13:52:27 +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 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-7527 Release notes in documentation and additions for CD (#397) 2018-06-07 15:18:50 +02:00
README.md added link to Jira in repo readme 2018-02-09 13:08:33 -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 the 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.

If you want to file a bug report or tell us about any other issue with this documentation, you are invited to please use our issue tracker.

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