No description
Find a file
keycloak-bot 09aa20f9c8
Set next development version for 999 (#1436)
* Set version to 999

* Update topics/templates/document-attributes-community.adoc

* Update topics/templates/document-attributes-community.adoc

* Update topics/templates/document-attributes-community.adoc

Co-authored-by: Stian Thorgersen <stian@redhat.com>
2022-10-06 14:16:09 +02:00
.github
aggregation Remove WildFly distribution from documentation (#1666) 2022-08-19 13:15:51 +02:00
api_documentation Documentation dist bundle (#1464) 2022-04-06 09:04:27 +02:00
authorization_services Remove WildFly distribution from documentation (#1666) 2022-08-19 13:15:51 +02:00
dist Documentation dist bundle (#1464) 2022-04-06 09:04:27 +02:00
header-maven-plugin Documentation dist bundle (#1464) 2022-04-06 09:04:27 +02:00
internal_resources
release_notes 20 Release notes for dist changes (#1656) 2022-10-03 13:31:41 +02:00
runtimes-common
securing_apps Preparing Server Admin Guide for RHBK (#1690) 2022-10-05 14:43:15 -04:00
server_admin Preparing Server Admin Guide for RHBK (#1690) 2022-10-05 14:43:15 -04:00
server_development Preparing Server Admin Guide for RHBK (#1690) 2022-10-05 14:43:15 -04:00
tests Remove WildFly distribution from documentation (#1666) 2022-08-19 13:15:51 +02:00
topics/templates Set next development version for 999 (#1436) 2022-10-06 14:16:09 +02:00
upgrading add changenote to RESTEasy version update (#1679) 2022-10-03 13:26:15 +02:00
.asciidoctorconfig Add hints for IntelliJ AsciiDoc plugin with attributes to render a nicer preview 2022-05-25 16:30:23 -03:00
.gitattributes
.gitignore Keycloak 15698 (#47) 2021-09-21 08:58:46 +02:00
.vale.ini
build-auto.sh
build-product.sh
get-version.sh
License.html
pom.xml Remove WildFly distribution from documentation (#1666) 2022-08-19 13:15:51 +02:00
README.md
release-details
set-version.sh Documentation dist bundle (#1464) 2022-04-06 09:04:27 +02:00
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 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