No description
Find a file
2021-04-29 15:59:35 +02:00
.github/workflows [KEYCLOAK-16788] Fix broken links 2021-01-15 10:47:01 +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-16929 Adding conscious language preface of the release notes 2021-03-02 09:34:57 +01:00
authorization_services KEYCLOAK-15906 2021-03-11 16:25:37 +01:00
getting_started KEYCLOAK-16929 Adding conscious language preface of the release notes 2021-03-02 09:34:57 +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-16929 Adding conscious language preface of the release notes 2021-03-02 09:34:57 +01:00
openshift-openj9 KEYCLOAK-13364 Remove Mysql templates, add instructions for including custom JDBC driver 2020-03-27 11:48:41 +01:00
release_notes KEYCLOAK-17824 Fix ReleaseNotes test failure 2021-04-21 08:26:39 +02:00
securing_apps KEYCLOAK-12137 OpenID Connect Client Initiated Backchannel Authentication (CIBA) 2021-04-29 15:59:35 +02:00
server_admin KEYCLOAK-12137 OpenID Connect Client Initiated Backchannel Authentication (CIBA) 2021-04-29 15:59:35 +02:00
server_development KEYCLOAK-16729 Add more info for how to retrieve provider types 2021-03-16 09:46:44 +01:00
server_installation KEYCLOAK-12137 OpenID Connect Client Initiated Backchannel Authentication (CIBA) 2021-04-29 15:59:35 +02:00
tests Bump junit from 4.12 to 4.13.1 in /tests 2021-02-17 09:13:36 +01:00
topics/templates [KEYCLOAK-17433] Keycloak documentation changes related 2021-04-29 12:36:48 +02:00
upgrading [KEYCLOAK-17433] Keycloak documentation changes related 2021-04-29 12:36:48 +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
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-14361 make tests run as final module regardless of profile (community|product) 2020-07-20 14:16:46 +02:00
README.md Update README.md 2020-07-23 10:35:45 -03:00
set-version.sh Prepare for 4.7.0.Final 2018-11-14 20:16:43 +01:00
sync.sh KEYCLOAK-14374 Add synchronization for 9.0.x branch 2020-06-03 14:43:19 +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

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 the 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