No description
Find a file
2019-05-16 10:12:37 +02:00
aggregation Add release notes to aggregation 2018-06-14 09:15:35 +02:00
api_documentation KEYCLOAK-9319 fixes in developer guide 2019-02-21 09:09:54 +01:00
authorization_services Add permission management documentation 2019-04-18 08:07:36 -03:00
getting_started KEYCLOAK-9319 fixes in developer guide 2019-02-21 09:09:54 +01:00
header-maven-plugin KEYCLOAK-8692 - Make it possible to build on Windows 2019-05-08 09:03:13 +02:00
internal_resources edited to incorporate suggestions from Tana 2018-08-14 11:22:29 +02:00
openshift Fix OpenShift guide 2019-05-16 10:12:37 +02:00
release_notes KEYCLOAK-10122 Update documentation for RHSSO CD 6 2019-05-10 08:54:49 +02:00
securing_apps fix-broken-heading (#632) 2019-05-13 19:22:52 -03:00
server_admin Update audience.adoc 2019-05-13 09:57:47 +02:00
server_development Fix typos 2019-05-08 15:41:11 +02:00
server_installation KEYCLOAK-8692 - Make it possible to build on Windows 2019-05-08 09:03:13 +02:00
tests Add permission management documentation 2019-04-18 08:07:36 -03:00
topics/templates Fix OpenShift guide 2019-05-16 10:12:37 +02:00
upgrading KEYCLOAK-8692 - Make it possible to build on Windows 2019-05-08 09:03:13 +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 KEYCLOAK-9982 Fix broken link 2019-04-03 08:55:25 +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-7527 Release notes in documentation and additions for CD (#397) 2018-06-07 15:18:50 +02:00
README.md KEYCLOAK-8692 - Make it possible to build on Windows 2019-05-08 09:03:13 +02: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

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