|
|
||
|---|---|---|
| aggregation | ||
| api_documentation | ||
| authorization_services | ||
| getting_started | ||
| header-maven-plugin | ||
| internal_resources | ||
| openshift | ||
| release_notes | ||
| securing_apps | ||
| server_admin | ||
| server_development | ||
| server_installation | ||
| tests | ||
| topics/templates | ||
| upgrading | ||
| .gitattributes | ||
| .gitignore | ||
| .travis.yml | ||
| build-auto.sh | ||
| build-product.sh | ||
| License.html | ||
| pom.xml | ||
| README.md | ||
| 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
To build Keycloak Documentation run:
mvn clean install
Or to build a specific guide run:
mvn clean install -f GUIDE_DIR
You can then view the documentation by opening GUIDE_DIR/target/frames.html or GUIDE_DIR/target/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 slighty 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/frames.html or GUIDE_DIR/target/index.html.
If you have ccutil installed you can build the guides with:
./build-product.sh
Or individual guides with:
./build-product.sh GUIDE_DIR