keycloak-scim/docs/documentation
rmartinc 4ff4c3f897 Increase internal algorithm security using HS512 and 128 byte hmac keys
Closes #13080

Signed-off-by: rmartinc <rmartinc@redhat.com>
2024-02-15 08:16:45 +01:00
..
aggregation Remove latest vs. archive document header (#20103) 2023-05-03 09:16:34 +00:00
api_documentation Run tests for the moved documentation (#19278) 2023-03-28 12:35:27 +02:00
authorization_services Update placeholders for hostname and port (#24153) 2024-01-11 12:05:05 +01:00
dist Run tests for the moved documentation (#19278) 2023-03-28 12:35:27 +02:00
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 User profile - release notes and more migration instructions (#27003) 2024-02-15 08:14:16 +01:00
securing_apps [docs] Align OAuth 2.0 Security Best Current Practice links (#24706) 2024-02-13 13:53:56 +01:00
server_admin Fixing the docs about default hashing iterations (#27020) 2024-02-15 08:11:44 +01:00
server_development Update theme documentation about the considerations when deploying custom themes (#26885) 2024-02-09 04:21:54 +01:00
tests Allow formating numbers when rendering attributes 2024-02-01 08:14:58 -03:00
topics/templates Added event for temporary lockout for brute force protector (#26630) 2024-02-07 14:13:33 +00:00
upgrading Increase internal algorithm security using HS512 and 128 byte hmac keys 2024-02-15 08:16:45 +01:00
.asciidoctorconfig Remove latest vs. archive document header (#20103) 2023-05-03 09:16:34 +00:00
.gitattributes Moving docs to new folder 2023-03-20 09:07:58 +01:00
.gitignore Cache Node.js installation and PNPM store 2023-10-30 07:50:06 -04:00
.vale.ini Moving docs to new folder 2023-03-20 09:07:58 +01:00
build-auto.sh Moving docs to new folder 2023-03-20 09:07:58 +01:00
get-version.sh Moving docs to new folder 2023-03-20 09:07:58 +01:00
License.html Moving docs to new folder 2023-03-20 09:07:58 +01:00
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.

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.

License