3ade41a76d
A product profile has been added to keycloak-api-docs-dist, to replace the downstream product javadocs POM. I've merged in any misc. changes from that pom, but I've kept the upstream zip layout: ``` index.html rest-api/index.html javadocs/index.html javadocs/index-all.html javadocs/* ``` instead of the current product deliverable layout of: ``` META-INF/* index.html index-all.html * ``` The community layout includes the rest-api that's distributed as a separate product deliverable in 7.2.0. I've kept this layout for better artifact consistency, but it could easily be changed to keep the product artifacts consistent for the next product minor version. |
||
|---|---|---|
| adapters | ||
| authz | ||
| boms | ||
| common | ||
| core | ||
| dependencies | ||
| distribution | ||
| examples | ||
| federation | ||
| integration | ||
| misc | ||
| model | ||
| proxy | ||
| saml-core | ||
| saml-core-api | ||
| server-spi | ||
| server-spi-private | ||
| services | ||
| testsuite | ||
| themes | ||
| util | ||
| wildfly | ||
| .gitattributes | ||
| .gitignore | ||
| .travis.yml | ||
| License.html | ||
| pom.xml | ||
| README.md | ||
| set-version.sh | ||
| travis-run-tests.sh | ||
Keycloak
Open Source Identity and Access Management for modern Applications and Services.
For more information about Keycloak visit Keycloak homepage and Keycloak blog.
Building
Ensure you have JDK 8 (or newer), Maven 3.1.1 (or newer) and Git installed
java -version
mvn -version
git --version
First clone the Keycloak repository:
git clone https://github.com/keycloak/keycloak.git
cd keycloak
To build Keycloak run:
mvn install
This will build all modules and run the testsuite.
To build the distribution run:
mvn install -Pdistribution
Once completed you will find distribution archives in distribution.
Starting Keycloak
To start Keycloak during development first build as specified above, then run:
mvn -f testsuite/utils/pom.xml exec:java -Pkeycloak-server
To start Keycloak from the server distribution first build the distribution it as specified above, then run:
tar xfz distribution/server-dist/target/keycloak-<VERSION>.tar.gz
cd keycloak-<VERSION>
bin/standalone.sh
To stop the server press Ctrl + C.
Reporting security vulnerabilities
If you've found a security vulnerability, please look at the instructions on how to properly report it
Help and Documentation
- Documentation - User Guide, Admin REST API and Javadocs
- User Mailing List - Mailing list to ask for help and general questions about Keycloak
- JIRA - Issue tracker for bugs and feature requests
Contributing
- Developer documentation
- Hacking on Keycloak - How to become a Keycloak contributor
- Testsuite - Details about testsuite, but also how to quickly run Keycloak during development and a few test tools (OTP generation, LDAP server, Mail server)
- Database Testing - How to do testing of Keycloak on different databases
- Updating Database - How to change the Keycloak database
- Changing the Default keycloak-subsystem Configuration - How to update the default keycloak-subsystem config
- Developer Mailing List - Mailing list to discuss development of Keycloak