libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases 1 Packages Activity Actions
keycloak-scim/docs/documentation
History
rmartinc e30230488e Convert chapter mod_auth_mellon from securing apps into guides 
Closes #31569

Signed-off-by: rmartinc <rmartinc@redhat.com>
2024-07-24 21:16:49 +02:00
..
aggregation Remove latest vs. archive document header (#20103) 2023-05-03 09:16:34 +00:00
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 Run tests for the moved documentation (#19278) 2023-03-28 12:35:27 +02:00
header-maven-plugin Use a default Java version from root POM (#29927) 2024-06-21 14:19:31 +02:00
internal_resources Update docs/documentation/internal_resources/contributing.adoc 2023-06-02 07:58:59 -03:00
release_notes Move saml documentation to guides 2024-07-24 11:50:24 +02:00
securing_apps Convert chapter mod_auth_mellon from securing apps into guides 2024-07-24 21:16:49 +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 Allow users to customize the footer of a login theme (#31391) 2024-07-23 09:29:38 +02: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 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

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