No description
Find a file
Thomas Darimont d167636534 KEYCLOAK-13267 Add note to upgrade guide about keycloak-admin-client version
Add note to upgrade guide that keycloak-admin-client versions must match server version
2020-07-10 07:29:38 +02: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 Update auth-services-architecture.adoc 2020-07-03 12:58:40 -03:00
getting_started KEYCLOAK-14392 Adressing input from Lukas. 2020-07-01 18:50:29 -03: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-13562 -- Adding back missing line: [[env_vars]] 2020-07-02 09:04:09 -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 KEYCLOAK 12209 Adding an S to Z series 2020-07-03 12:42:43 +02:00
securing_apps add proxy configuration section to node.js adapter docs 2020-07-02 16:24:17 -03:00
server_admin Updated section on the Credentials tab 2020-07-10 07:26:20 +02:00
server_development typo 2020-06-19 11:16:28 +02:00
server_installation KEYCLOAK-14386 Replacing cr_name with CR-Name and other minor changes 2020-06-17 14:57:33 +02:00
tests Bump log4j-core from 2.13.0 to 2.13.2 in /tests 2020-07-07 08:59:35 +02:00
topics/templates KEYCLOAK-11450 Update version for 7.4.0.CR2 2020-07-01 18:53:23 -03:00
upgrading KEYCLOAK-13267 Add note to upgrade guide about keycloak-admin-client version 2020-07-10 07:29:38 +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
.travis.yml Update .travis.yml 2019-06-27 07:25:23 +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-13248 Revising cross DC graphic to use standard formats. (#891) 2020-03-26 07:43:05 +01:00
README.md KEYCLOAK-12535 Fix broken links 2019-12-20 08:09:48 +01: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 a 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