keycloak-scim/docs/documentation
Marek Posolda a6ad701b5e
Update securing_applications guide for latest adapter changes (community) (#20995)
closes #20994


Co-authored-by: Pedro Igor <pigor.craveiro@gmail.com>
Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>
2023-06-20 09:21:47 +02:00
..
.github/workflows
aggregation
api_documentation
authorization_services allow specifying format of "permission" parameter in the UMA grant token 2023-05-29 08:56:39 -03:00
dist
header-maven-plugin
internal_resources Update docs/documentation/internal_resources/contributing.adoc 2023-06-02 07:58:59 -03:00
release_notes Promote Account Console v3 to preview (#20969) 2023-06-15 12:24:01 -04:00
securing_apps Update securing_applications guide for latest adapter changes (community) (#20995) 2023-06-20 09:21:47 +02:00
server_admin Update docs and tooltips for lifespan and idle timeout changes 2023-06-20 09:01:32 +02:00
server_development Clean-up of deprecated methods and interfaces 2023-06-09 17:11:20 +00:00
tests [docs] Add Keycloak JIRA login redirect to allow list. 2023-05-09 21:08:57 +02:00
topics/templates Replace guide with a placeholder for downstream docs (#20266) 2023-05-16 08:59:11 +02:00
upgrading Update UserQueryProvider methods 2023-06-12 16:04:26 +02:00
.asciidoctorconfig
.gitattributes
.gitignore
.vale.ini
build-auto.sh
get-version.sh
License.html
pom.xml Replace guide with a placeholder for downstream docs (#20266) 2023-05-16 08:59:11 +02:00
README.md Changed references to Jira issues to Github issues 2023-05-09 08:54:25 +02:00
release-details

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