No description
Find a file
2020-11-26 09:48:36 +01:00
.github/workflows Update maven.yml 2020-11-03 12:19:39 +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 Fix typo 2020-09-02 14:30:16 +02:00
getting_started KEYCLOAK-15248 Remove duplicated steps in getting started guide 2020-09-17 23:09:02 -07: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-FIX Reinstating missing content. 2020-08-05 18:05:48 -03: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 Release notes for KC 12 2020-11-26 09:48:36 +01:00
securing_apps KEYCLOAK-9551 Client Credentials Grant should not generate refresh token 2020-11-06 09:16:36 +01:00
server_admin adjustements and update images to match latest changes 2020-11-24 15:50:50 +01:00
server_development KEYCLOAK-14855 Add hints to realm-specific localization texts 2020-10-30 12:30:26 +01:00
server_installation KEYCLOAK-14887 Outgoing HTTPS request truststore documentation reads 'disabled' but actual parameter is 'enabled' 2020-11-05 17:44:36 +01:00
tests KEYCLOAK-14862 Upgrade httpclient test dependency 2020-08-05 10:57:16 -03:00
topics/templates [KEYCLOAK-16098] Documentation for the upgrade to Wildfly 21 2020-11-26 09:29:34 +01:00
upgrading [KEYCLOAK-16098] Documentation for the upgrade to Wildfly 21 2020-11-26 09:29:34 +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
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