No description
Find a file
2022-07-26 09:30:45 -04: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 Documentation dist bundle (#1464) 2022-04-06 09:04:27 +02:00
api_documentation Documentation dist bundle (#1464) 2022-04-06 09:04:27 +02:00
authorization_services Updates Account Console steps in Authorization Services Guide (#1627) 2022-07-26 09:30:45 -04:00
dist Documentation dist bundle (#1464) 2022-04-06 09:04:27 +02:00
getting_started Add hints for IntelliJ AsciiDoc plugin with attributes to render a nicer preview 2022-05-25 16:30:23 -03:00
header-maven-plugin Documentation dist bundle (#1464) 2022-04-06 09:04:27 +02:00
internal_resources Update main branch name in Contributor's Guide (#1345) 2022-01-03 13:30:44 +01:00
openshift Update OpenShift template versions (#1602) 2022-07-01 16:49:24 -03:00
openshift-openj9 Documentation dist bundle (#1464) 2022-04-06 09:04:27 +02:00
release_notes Documentation for latest logout changes (#1624) 2022-07-25 11:04:38 +02:00
runtimes-common [KEYCLOAK-17902] Fix failures of 'org.keycloak.documentation.test.ReleaseNotesTest' 2021-05-03 13:20:59 -03:00
securing_apps Update Securing Apps guide (#1569) 2022-07-25 16:37:28 -04:00
server_admin Updates Account Console steps in Authorization Services Guide (#1627) 2022-07-26 09:30:45 -04:00
server_development updated to use new UI (#1578) 2022-06-27 13:47:13 -04:00
server_installation Document that 7.6 Operator is compatible with 7.5 Keycloak (#1584) 2022-07-01 16:49:02 -03:00
tests For the product documentation, replace the section identifier as well to retrieve the local filename. 2022-06-28 09:06:02 -03:00
topics/templates Updating OpenShift to 7.6 (#1618) 2022-07-14 12:47:34 -03:00
upgrading Refactor UserStorageUtil usage. (#1607) 2022-07-07 09:57:23 -03:00
.asciidoctorconfig Add hints for IntelliJ AsciiDoc plugin with attributes to render a nicer preview 2022-05-25 16:30:23 -03: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 Documentation dist bundle (#1464) 2022-04-06 09:04:27 +02: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 Documentation dist bundle (#1464) 2022-04-06 09:04:27 +02: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