libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases 1 Packages Activity Actions
keycloak-scim/docs/documentation
History
rmartinc 942d5d0aa3 Convert chapter planning for securing applications and services to guides 
Final removal of the securing_apps documentation
Final checks for links, order and other minor things
Closes #31328

Signed-off-by: rmartinc <rmartinc@redhat.com>
2024-08-01 16:45:56 +02:00
..
aggregation Convert chapter planning for securing applications and services to guides 2024-08-01 16:45:56 +02:00
api_documentation Remove inclusive language foreword 2024-06-27 15:22:03 +02:00
authorization_services Move oidc documentation to guides (#31627) 2024-07-30 09:46:14 +02: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 Convert chapter planning for securing applications and services to guides 2024-08-01 16:45:56 +02:00
server_admin Convert chapter planning for securing applications and services to guides 2024-08-01 16:45:56 +02:00
server_development Convert chapter planning for securing applications and services to guides 2024-08-01 16:45:56 +02:00
tests Convert chapter planning for securing applications and services to guides 2024-08-01 16:45:56 +02:00
topics/templates Convert chapter planning for securing applications and services to guides 2024-08-01 16:45:56 +02:00
upgrading Convert chapter planning for securing applications and services to guides 2024-08-01 16:45:56 +02:00
.asciidoctorconfig
.gitattributes
.gitignore Cache Node.js installation and PNPM store 2023-10-30 07:50:06 -04:00
.vale.ini
build-auto.sh Convert chapter planning for securing applications and services to guides 2024-08-01 16:45:56 +02:00
get-version.sh
License.html Fix typos found by codespell in docs (#28890) 2024-05-03 12:41:16 +00:00
pom.xml Convert chapter planning for securing applications and services to guides 2024-08-01 16:45:56 +02:00
README.md Fix typos found by codespell in docs (#28890) 2024-05-03 12:41:16 +00:00

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.

License