RepoMirrors/keycloak
1
0
Fork 0
mirror of https://github.com/keycloak/keycloak synced 2025-05-16 23:30:01 +00:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity
db23d8e665
keycloak/docs/documentation
History
Marek Posolda db23d8e665
Clarify that XOAUTH2 configuration with Microsoft Office365 is community contributed 
Closes #38376

Signed-off-by: mposolda <mposolda@gmail.com>
Signed-off-by: Marek Posolda <mposolda@gmail.com>
Co-authored-by: Alexander Schwartz <alexander.schwartz@gmx.net>
Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>
2025-03-26 15:54:38 +01: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 update screens for new realm selector 2025-03-15 10:54:00 +01: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 Adjust documentation according to new home in keycloak/docs/documentation 2024-11-28 14:28:11 +01:00
release_notes Release notes updates for the community contributions related to core-clients areas 2025-03-24 12:49:52 +01:00
server_admin Clarify that XOAUTH2 configuration with Microsoft Office365 is community contributed 2025-03-26 15:54:38 +01:00
server_development update screens for new realm selector 2025-03-15 10:54:00 +01:00
tests Finalizing release notes and documentation for initial rolling update 2025-03-19 21:34:09 +01:00
topics/templates Sending Mails via SMTP and XOAUTH2 authentication mechanism 2025-03-21 10:12:18 +01:00
upgrading Reorder items in release notes for 26.2 (#38290) 2025-03-20 11:52:53 +01:00
.asciidoctorconfig Remove latest vs. archive document header (#20103) 2023-05-03 09:16:34 +00:00
.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 Adjust documentation according to new home in keycloak/docs/documentation 2024-11-28 14:28:11 +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:

./mvnw clean install -am -pl docs/documentation/dist -Pdocumentation

Or to build a specific guide run:

./mvnw clean install -pl docs/documentation/GUIDE_DIR -Pdocumentation

By default, an archive version of the documentation is built. To build the latest build run:

./mvnw clean install ... -Platest,documentation

You can then view the documentation by opening docs/documentation/GUIDE_DIR/target/generated-docs/index.html.

License