No description
Find a file
2021-11-08 15:00:24 +01:00
.github KEYCLOAK-19785 Add GitHub issue forms to repositories 2021-11-08 11:44:04 +01:00
aggregation Remove getting started guide in community 2021-10-20 10:42:01 +02:00
api_documentation KEYCLOAK-16929 Adding conscious language preface of the release notes 2021-03-02 09:34:57 +01:00
authorization_services KEYCLOAK-18503 Regex Policy for authorization service 2021-08-03 08:49:24 -03:00
getting_started Fix links 2021-10-20 08:58:11 +02: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 KEYCLOAK-12535 Fix broken links 2019-12-20 08:09:48 +01:00
openshift KEYCLOAK-16784 Correcting attribute: 2021-10-18 19:53:48 +02:00
openshift-openj9 [KEYCLOAK-13207] Derive the value of the JBOSS_IMAGE_NAME information 2021-06-07 12:30:20 +02:00
release_notes [KEYCLOAK-17653] - Front-channel logout 2021-10-21 08:28:53 +02:00
runtimes-common [KEYCLOAK-17902] Fix failures of 'org.keycloak.documentation.test.ReleaseNotesTest' 2021-05-03 13:20:59 -03:00
securing_apps KEYCLOAK-19144 [PR] fixing broken links 2021-11-08 15:00:24 +01:00
server_admin KEYCLOAK-19144 [PR] fixed broken link for master->main 2021-11-08 15:00:24 +01:00
server_development typo in the package folder structure 2021-11-08 14:48:50 +01:00
server_installation KEYCLOAK-19145 [PR] removing the block of install by command on RHSSO, not only the link 2021-11-08 15:00:24 +01:00
tests Remove getting started guide in community 2021-10-20 10:42:01 +02:00
topics/templates Remove getting started guide in community 2021-10-20 10:42:01 +02:00
upgrading KEYCLOAK-18908 Note about losing user sessions in a minor upgrade. 2021-10-04 12:00:05 +02: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 Remove getting started guide in community 2021-10-20 10:42:01 +02:00
README.md KEYCLOAK-19144 [PR] dummy change to force rebuild 2021-11-08 15:00:24 +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