No description
Find a file
Stian Thorgersen c9239cbfb6
Merge pull request #804 from keycloak/stianst-patch-3
Update idp_httpclient_subelement.adoc
2020-01-07 13:49:00 +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
authorization_services Added missing step in getting started 2020-01-07 08:27:38 +01:00
getting_started KEYCLOAK-11918 Moved guides docs to dropdown, and set version fixed at the top 2019-11-07 16:15:06 +01:00
header-maven-plugin
internal_resources KEYCLOAK-12535 Fix broken links 2019-12-20 08:09:48 +01:00
openshift KEYCLOAK-12582 Fixes for product 2019-12-20 09:44:35 +01:00
release_notes KEYCLOAK-12582 Fixes for product 2019-12-20 09:44:35 +01:00
securing_apps Merge pull request #804 from keycloak/stianst-patch-3 2020-01-07 13:49:00 +01:00
server_admin achieve -> achieved 2020-01-07 08:40:49 +01:00
server_development [KEYCLOAK-11707] Add documentation for the Elytron Credential Store provider 2019-12-18 11:54:08 +01:00
server_installation Fix typos in load-balancer documentation 2020-01-07 08:35:22 +01:00
tests KEYCLOAK-12582 Fixes for product 2019-12-20 09:44:35 +01:00
topics/templates KEYCLOAK-12582 Fixes for product 2019-12-20 09:44:35 +01:00
upgrading KEYCLOAK-12278 Default first broker login flow is broken after migration 2020-01-02 17:55:28 +01:00
.gitattributes
.gitignore
.travis.yml
build-auto.sh
build-product.sh
get-version.sh
License.html
pom.xml KEYCLOAK-12582 Fixes for product 2019-12-20 09:44:35 +01:00
README.md KEYCLOAK-12535 Fix broken links 2019-12-20 08:09:48 +01:00
set-version.sh
sync.sh

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