History

Pedro Igor b98e115183 Updating docs and account message Signed-off-by: Pedro Igor <pigor.craveiro@gmail.com>		2024-02-22 22:58:22 +09:00
..
aggregation
api_documentation
authorization_services	Update placeholders for hostname and port (#24153 )	2024-01-11 12:05:05 +01:00
dist
header-maven-plugin	Update Maven dependency versions for docs	2024-02-01 13:42:25 +01:00
internal_resources	Update docs/documentation/internal_resources/contributing.adoc	2023-06-02 07:58:59 -03:00
release_notes	Permanently lock users out after X temporary lockouts during a brute force attack	2024-02-22 09:34:51 +01:00
securing_apps	Supporting OAuth 2.1 for public clients	2024-02-22 10:57:29 +01:00
server_admin	Updating docs and account message	2024-02-22 22:58:22 +09:00
server_development	Write announcement and documentation for Account Console v3 (#26318 )	2024-02-21 13:42:33 -05:00
tests	Write announcement and documentation for Account Console v3 (#26318 )	2024-02-21 13:42:33 -05:00
topics/templates	Added event for temporary lockout for brute force protector (#26630 )	2024-02-07 14:13:33 +00:00
upgrading	Write announcement and documentation for Account Console v3 (#26318 )	2024-02-21 13:42:33 -05:00
.asciidoctorconfig
.gitattributes
.gitignore	Cache Node.js installation and PNPM store	2023-10-30 07:50:06 -04:00
.vale.ini
build-auto.sh
get-version.sh
License.html
pom.xml	Update Maven dependency versions for docs	2024-02-01 13:42:25 +01:00
README.md	Changed references to Jira issues to Github issues	2023-05-09 08:54:25 +02: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.