History

rmartinc e97ffe7a32 Convert chapter docker registry from securing apps into guides Closes #31331 Signed-off-by: rmartinc <rmartinc@redhat.com>		2024-07-26 15:39:51 +02:00
..
aggregation
api_documentation	Remove inclusive language foreword	2024-06-27 15:22:03 +02:00
authorization_services	Fix typos found by codespell in docs (#28890 )	2024-05-03 12:41:16 +00:00
dist
header-maven-plugin	Use a default Java version from root POM (#29927 )	2024-06-21 14:19:31 +02:00
internal_resources
release_notes	Persisting revoked access tokens	2024-07-26 11:46:14 +02:00
securing_apps	Convert chapter docker registry from securing apps into guides	2024-07-26 15:39:51 +02:00
server_admin	Updating docs	2024-07-24 15:12:16 -03:00
server_development	Allow users to customize the footer of a login theme (#31391 )	2024-07-23 09:29:38 +02:00
tests	Remove link to management interface guide from ignored links in docs	2024-06-12 11:50:21 +02:00
topics/templates	Remove inclusive language foreword	2024-06-27 15:22:03 +02:00
upgrading	Persisting revoked access tokens	2024-07-26 11:46:14 +02:00
.asciidoctorconfig
.gitattributes
.gitignore
.vale.ini
build-auto.sh
get-version.sh
License.html	Fix typos found by codespell in docs (#28890 )	2024-05-03 12:41:16 +00:00
pom.xml	Use a default Java version from root POM (#29927 )	2024-06-21 14:19:31 +02:00
README.md	Fix typos found by codespell in docs (#28890 )	2024-05-03 12:41:16 +00:00

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.

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.