2017-03-15 12:26:46 +00:00
Keycloak Documentation
======================
Open Source Identity and Access Management for modern Applications and Services.
2021-12-16 15:36:14 +00:00
For more information about Keycloak visit the [Keycloak homepage ](http://keycloak.org ) and [Keycloak blog ](https://www.keycloak.org/blog ).
2017-03-15 12:26:46 +00:00
2017-11-15 13:44:10 +00:00
Contributing to Keycloak Documentation
2021-11-04 16:52:58 +00:00
----------------------------------------
2017-11-15 13:44:10 +00:00
See our [Contributor's Guide ](internal_resources/contributing.adoc ). The directory also includes a set of templates and other resources to help you get started.
2023-05-08 13:55:56 +00:00
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 ](https://github.com/keycloak/keycloak/issues/ ).
2018-02-09 19:08:33 +00:00
2017-11-15 13:44:10 +00:00
2017-03-15 12:26:46 +00:00
Building Keycloak Documentation
2021-11-05 11:17:56 +00:00
---------------------------------
2017-03-15 12:26:46 +00:00
2017-09-05 11:13:44 +00:00
Ensure that you have [Maven installed ](https://maven.apache.org/ ).
2017-03-15 12:26:46 +00:00
2023-03-17 09:36:02 +00:00
First, clone the Keycloak repository:
2017-09-05 11:13:44 +00:00
2023-03-17 09:36:02 +00:00
git clone https://github.com/keycloak/keycloak.git
cd keycloak/docs/documentation
2017-09-05 11:13:44 +00:00
2019-04-25 11:56:21 +00:00
If you are using Windows, you need to run the following command with administrator privilege because this project uses symbolic links:
2023-03-17 09:36:02 +00:00
git clone -c core.symlinks=true https://github.com/keycloak/keycloak.git
2019-04-25 11:56:21 +00:00
2017-03-15 12:26:46 +00:00
To build Keycloak Documentation run:
2023-03-28 10:35:27 +00:00
mvn clean install -am -pl docs/documentation/dist -Pdocumentation
2017-08-29 07:33:20 +00:00
Or to build a specific guide run:
2023-05-03 06:58:52 +00:00
mvn clean install -pl docs/documentation/GUIDE_DIR -Pdocumentation
2019-11-06 09:57:00 +00:00
2020-07-21 16:03:07 +00:00
By default, an archive version of the documentation is built. To build the latest build run:
2019-11-06 09:57:00 +00:00
2023-03-28 10:35:27 +00:00
mvn clean install ... -Platest,documentation
2017-09-05 11:13:44 +00:00
2023-05-03 06:58:52 +00:00
You can then view the documentation by opening `docs/documentation/GUIDE_DIR/target/generated-docs/index.html` .
2017-03-15 12:26:46 +00:00
License
-------
* [Apache License, Version 2.0 ](https://www.apache.org/licenses/LICENSE-2.0 )
