96bab33db1
I recieved feedback from customer/users that keycloak client side is widely undocumented, which was surprising. After checking I found out that in fact for users that use npm there is no documentation provided: https://www.npmjs.com/package/keycloak-js This is very rare to see in NPM for package that have such large number of downloads. Additionally official docs doesn't mention NPM at all and recommend using js package from server (which is not be best advice if you do CDN's etc.). Additionally some old bower repo is still 3th result in google and since it has some docs people using it: https://github.com/keycloak/keycloak-js-bower - worth to remove this as well. Added simple note in the docs so hopefully google will position this documentation |
||
|---|---|---|
| .github | ||
| aggregation | ||
| api_documentation | ||
| authorization_services | ||
| getting_started | ||
| header-maven-plugin | ||
| internal_resources | ||
| openshift | ||
| openshift-openj9 | ||
| release_notes | ||
| runtimes-common | ||
| securing_apps | ||
| server_admin | ||
| server_development | ||
| server_installation | ||
| tests | ||
| topics/templates | ||
| upgrading | ||
| .gitattributes | ||
| .gitignore | ||
| .vale.ini | ||
| build-auto.sh | ||
| build-product.sh | ||
| get-version.sh | ||
| License.html | ||
| pom.xml | ||
| README.md | ||
| release-details | ||
| 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 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