No description
Find a file
Ján Lieskovský 2b8143cb8d Fix issue with improper rendering of xreferences (#371)
Signed-off-by: Jan Lieskovsky <jlieskov@redhat.com>
2018-04-23 21:10:37 +02:00
aggregation KEYCLOAK-5574 Added edit this page on GitHub link 2018-02-14 10:17:38 +01:00
api_documentation KEYCLOAK-5574 Added edit this page on GitHub link 2018-02-14 10:17:38 +01:00
authorization_services Merge pull request #355 from Yonezawa-T2/patch-1 2018-04-06 15:40:49 -03:00
getting_started Update URLs to https (#366) 2018-04-20 10:25:03 +02:00
header-maven-plugin KEYCLOAK-5574 Added edit this page on GitHub link 2018-02-14 10:17:38 +01:00
internal_resources Added a couple of details to contrib guide 2017-12-19 10:39:02 +01:00
openshift Fix issue with improper rendering of xreferences (#371) 2018-04-23 21:10:37 +02:00
securing_apps KEYCLOAK-7196: Add kcLocale to login Options 2018-04-23 10:00:55 -04:00
server_admin fixed inconsistant spacing at top of files 2018-04-17 06:25:31 -05:00
server_development Theme Selector Provider Interface Correction and unimplemented method added (#354) 2018-04-06 07:32:03 +02:00
server_installation Update URLs to https (#366) 2018-04-20 10:25:03 +02:00
tests KEYCLOAK-7074 Exclude edit page on github links from tests (#357) 2018-04-06 08:38:27 +02:00
topics/templates Update URLs to https (#366) 2018-04-20 10:25:03 +02:00
upgrading KEYCLOAK-5574 Added edit this page on GitHub link 2018-02-14 10:17:38 +01:00
.gitattributes
.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
pom.xml KEYCLOAK-5574 Added edit this page on GitHub link 2018-02-14 10:17:38 +01: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