c7db7bd528
Add a mention about beans.xml and @Provider in the extending server documentation Add beans.xml in the rest provider example Add a mention about @Provider in the upgrading guides Closes #25882 Signed-off-by: zak905 <zakaria.amine88@gmail.com> Address suggested change for docs/documentation/server_development/topics/extensions.adoc Co-authored-by: Pedro Igor <pigor.craveiro@gmail.com> Address suggested change for docs/documentation/server_development/topics/extensions.adoc Co-authored-by: Pedro Igor <pigor.craveiro@gmail.com> Signed-off-by: zak905 <zakaria.amine88@gmail.com> Address suggested change for docs/documentation/upgrading/topics/keycloak/changes-22_0_0.adoc Co-authored-by: Pedro Igor <pigor.craveiro@gmail.com> Signed-off-by: zak905 <zakaria.amine88@gmail.com> |
||
|---|---|---|
| .. | ||
| aggregation | ||
| api_documentation | ||
| authorization_services | ||
| dist | ||
| header-maven-plugin | ||
| internal_resources | ||
| release_notes | ||
| securing_apps | ||
| server_admin | ||
| server_development | ||
| tests | ||
| topics/templates | ||
| upgrading | ||
| .asciidoctorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .vale.ini | ||
| build-auto.sh | ||
| get-version.sh | ||
| License.html | ||
| pom.xml | ||
| README.md | ||
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 repository:
git clone https://github.com/keycloak/keycloak.git
cd keycloak/docs/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.git
To build Keycloak Documentation run:
mvn clean install -am -pl docs/documentation/dist -Pdocumentation
Or to build a specific guide run:
mvn clean install -pl docs/documentation/GUIDE_DIR -Pdocumentation
By default, an archive version of the documentation is built. To build the latest build run:
mvn clean install ... -Platest,documentation
You can then view the documentation by opening docs/documentation/GUIDE_DIR/target/generated-docs/index.html.