libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases 1 Packages Activity Actions
keycloak-scim/docs/documentation
History
Marek Posolda 908ba027b6
More docs clarification for script authenticator (#20444) 
* More docs clarification for script authenticator
closes #20009


Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>
2023-05-18 17:41:28 +02:00
..
.github/workflows Integrate documentation into parent build 2023-03-20 13:09:23 +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 Run tests for the moved documentation (#19278) 2023-03-28 12:35:27 +02:00
dist Run tests for the moved documentation (#19278) 2023-03-28 12:35:27 +02:00
header-maven-plugin Moving docs to new folder 2023-03-20 09:07:58 +01:00
internal_resources Moving docs to new folder 2023-03-20 09:07:58 +01:00
release_notes Replace guide with a placeholder for downstream docs (#20266) 2023-05-16 08:59:11 +02:00
securing_apps Replace guide with a placeholder for downstream docs (#20266) 2023-05-16 08:59:11 +02:00
server_admin Add note about preserving ID in imports 2023-05-18 13:23:07 +02:00
server_development More docs clarification for script authenticator (#20444) 2023-05-18 17:41:28 +02: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 Consistent message resolving regarding language fallbacks for all themes 2023-05-17 15:00:32 +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 Moving docs to new folder 2023-03-20 09:07:58 +01: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 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 Moving docs to new folder 2023-03-20 09:07:58 +01: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