No description
Find a file
2020-02-14 09:38:33 +01:00
aggregation KEYCLOAK-11918 Moved guides docs to dropdown, and set version fixed at the top 2019-11-07 16:15:06 +01:00
api_documentation KEYCLOAK-9319 fixes in developer guide 2019-02-21 09:09:54 +01:00
authorization_services Added missing step in getting started 2020-01-07 08:27:38 +01:00
getting_started Newbie friendly: "Wildfly 11" -> "Wildfly 11+" 2020-02-14 09:34:42 +01:00
header-maven-plugin Fix warnings in build log 2019-05-21 10:04:29 -03:00
internal_resources KEYCLOAK-12535 Fix broken links 2019-12-20 08:09:48 +01:00
openshift KEYCLOAK-11803 Vault support for RH-SSO openshift image 2020-02-06 15:52:28 +01:00
release_notes KEYCLOAK-12753 Apply feedback 2020-02-07 13:53:19 +01:00
securing_apps Fix a minor typo 2020-02-14 09:36:14 +01:00
server_admin KEYCLOAK-9391 Correcting grammatical problems. 2020-02-14 09:37:50 +01:00
server_development KEYCLOAK-12753 Apply feedback 2020-02-07 13:53:19 +01:00
server_installation Fix typo in standalone-ha.adoc 2020-02-14 09:38:33 +01:00
tests Updated to Log4j 2 2020-02-14 09:35:29 +01:00
topics/templates Update document-attributes-product.adoc 2020-01-08 12:47:31 +01:00
upgrading KEYCLOAK-12278 Default first broker login flow is broken after migration 2020-01-02 17:55:28 +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 Update .travis.yml 2019-06-27 07:25:23 +02: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
get-version.sh Add get version script 2019-03-05 13:01:06 +01:00
License.html KEYCLOAK-4506 Added missing ASL2 license file 2017-03-09 13:39:14 +01:00
pom.xml KEYCLOAK-12582 Fixes for product 2019-12-20 09:44:35 +01:00
README.md KEYCLOAK-12535 Fix broken links 2019-12-20 08:09:48 +01:00
set-version.sh Prepare for 4.7.0.Final 2018-11-14 20:16:43 +01:00
sync.sh Update sync script 2019-02-21 09:09:25 +01: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

If you are using Windows, you need to run the following command with administrator privilege because this project uses symbolic links:

git clone -c core.symlinks=true https://github.com/keycloak/keycloak-documentation.git

To build Keycloak Documentation run:

mvn clean install

Or to build a specific guide run:

mvn clean install -f GUIDE_DIR

By default an archive version of the documentation is built. To build a latest build run:

mvn clean install -Dlatest

You can then view the documentation by opening GUIDE_DIR/target/generated-docs/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 slightly 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/generated-docs/master.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