No description
Find a file
2022-02-02 16:06:47 +01:00
.github Add issue forms to repository to fix issue with labels not being added (#1353) 2022-01-03 13:00:38 +01:00
aggregation Remove getting started guide in community 2021-10-20 10:42:01 +02:00
api_documentation CIAM-793 Updating copyright in API documentation (#1262) 2021-11-10 11:44:52 +01:00
authorization_services CIAM-950 Changing Java EE and JavaEE to Jaka rta EE (#1268) 2021-11-10 11:45:59 +01:00
getting_started CIAM-950 Changing Java EE and JavaEE to Jaka rta EE (#1268) 2021-11-10 11:45:59 +01:00
header-maven-plugin admin-reuse -- Found one more Data Grid link to fix based on a separate PR. 2021-09-21 08:58:46 +02:00
internal_resources Update main branch name in Contributor's Guide (#1345) 2022-01-03 13:30:44 +01:00
openshift CIAM-794 Updating Copyright date for OpenShift guides (#1263) 2021-11-10 11:57:22 +01:00
openshift-openj9 CIAM-794 Updating Copyright date for OpenShift guides (#1263) 2021-11-10 11:57:22 +01:00
release_notes KEYCLOAK-18727 Improve user search change notes. 2022-01-26 17:02:57 +01:00
runtimes-common [KEYCLOAK-17902] Fix failures of 'org.keycloak.documentation.test.ReleaseNotesTest' 2021-05-03 13:20:59 -03:00
securing_apps Fix typo (#1369) 2022-01-31 09:29:34 +01:00
server_admin Update themes.adoc (#1382) 2022-01-31 09:30:40 +01:00
server_development Closes #1389 (#1390) 2022-02-02 16:06:47 +01:00
server_installation Fix typos (#1368) 2022-01-31 09:29:53 +01:00
tests Bump log4j-core from 2.17.0 to 2.17.1 in /tests (#1356) 2022-01-12 12:08:09 +01:00
topics/templates Correcting JavaScript spelling. 2021-12-22 12:38:01 -03:00
upgrading Separate migration changes for 16 into separate file (#1354) 2022-01-04 13:51:35 +01:00
.gitattributes .git files 2016-05-04 11:11:47 -04:00
.gitignore Keycloak 15698 (#47) 2021-09-21 08:58:46 +02:00
.vale.ini KEYCLOAK-15942 Rewording (#56) 2021-09-21 08:58:46 +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 Refactor tests (#1300) 2021-11-12 12:34:19 +01:00
README.md Update readme to fix blog link 2021-12-17 12:11:34 +01:00
release-details admin-reuse -- Found one more Data Grid link to fix based on a separate PR. 2021-09-21 08:58:46 +02: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