Open Source Identity and Access Management For Modern Applications and Services
Java JavaScript CSS HTML FreeMarker TypeScript Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
adapters KEYCLOAK-6086 Casting Jetty WebAppContext in Spring Adapter checks va… Aug 13, 2018
authz [KEYCLOAK-4902] - Using streams to process requested permissions and … Aug 17, 2018
boms Set version to 4.3.0.Final-SNAPSHOT Aug 1, 2018
common Set version to 4.3.0.Final-SNAPSHOT Aug 1, 2018
core [KEYCLOAK-7885] Add user policy support to the policy API Aug 14, 2018
dependencies Set version to 4.3.0.Final-SNAPSHOT Aug 1, 2018
distribution Fixes to examples-dist for removed Fuse example Aug 15, 2018
examples KEYCLOAK-7994 Move examples to test-apps Aug 8, 2018
federation KEYCLOAK-6038 Kerberos cross-realm trust test Aug 10, 2018
integration Set version to 4.3.0.Final-SNAPSHOT Aug 1, 2018
misc KEYCLOAK-6038 Kerberos cross-realm trust test Aug 10, 2018
model [KEYCLOAK-4902] - Using streams to process scopes and cache improvements Aug 14, 2018
proxy Set version to 4.3.0.Final-SNAPSHOT Aug 1, 2018
saml-core-api Set version to 4.3.0.Final-SNAPSHOT Aug 1, 2018
saml-core KEYCLOAK-6832 Unify Destination attribute handling Aug 9, 2018
server-spi-private [KEYCLOAK-4902] - Using streams to process requested permissions and … Aug 17, 2018
server-spi Set version to 4.3.0.Final-SNAPSHOT Aug 1, 2018
services [KEYCLOAK-4902] - Using streams to process requested permissions and … Aug 17, 2018
testsuite [KEYCLOAK-4902] - Using streams to process requested permissions and … Aug 17, 2018
themes KEYCLOAK-8036 Fix misplaced IdP buttons Aug 15, 2018
util KEYCLOAK-6038 Kerberos cross-realm trust test Aug 10, 2018
wildfly Set version to 4.3.0.Final-SNAPSHOT Aug 1, 2018
.gitattributes KEYCLOAK-1385 Introduce end-of-line normalization Jul 17, 2015
.gitignore KEYCLOAK-5391: Add node_modules back to repository for commons theme (#… Sep 5, 2017
.travis.yml KEYCLOAK-7635 : Authenticate clients with x509 certificate Aug 13, 2018
License.html distro Jan 7, 2014
README.md KEYCLOAK-7641 Add details on how to build server-only, including some… Jun 18, 2018
pom.xml Fix product versions Aug 15, 2018
prod-arguments.json KEYCLOAK-7479: Sanitize Aug 1, 2018
set-version.sh Bump versions Nov 9, 2017
travis-run-tests.sh KEYCLOAK-7635 : Authenticate clients with x509 certificate Aug 13, 2018

README.md

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.

To build only the server run:

mvn -Pdistribution -pl distribution/server-dist -am -Dmaven.test.skip clean install

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

License