No description
Find a file
2016-12-05 10:19:02 -05:00
adapters Merge pull request #3548 from sebastienblanc/KEYCLOAK-3725 2016-12-03 13:46:52 -05:00
authz Bump to 2.5.0.Final-SNAPSHOT 2016-11-30 15:44:51 +01:00
common
core
dependencies
distribution KEYCLOAK-4002: realmRevisions cache too small with high number of realms. 2016-12-05 08:07:24 -05:00
examples enhance user storage jpa example 2016-12-03 13:33:16 -05:00
federation Merge pull request #3580 from abstractj/KEYCLOAK-3970 2016-12-03 13:37:48 -05:00
integration component query and remove provider alis fix 2016-12-03 11:34:48 -05:00
misc
model KEYCLOAK-4002: realmRevisions cache too small with high number of realms. 2016-12-05 08:07:24 -05:00
proxy
saml-core
saml-core-api
server-spi KEYCLOAK-3986 2016-12-03 09:33:52 -05:00
server-spi-private
services Merge pull request #3603 from thomasdarimont/issue/KEYCLOAK-3969-Allow-authentication-via-ScriptAuthenticator-without-user 2016-12-05 10:19:02 -05:00
testsuite KEYCLOAK-4027 Make AbstractTests really abstract in testsuite 2016-12-05 12:03:05 +01:00
themes Merge pull request #3588 from abstractj/KEYCLOAK-3847 2016-12-03 13:37:06 -05:00
util
wildfly KEYCLOAK-4002: realmRevisions cache too small with high number of realms. 2016-12-05 08:07:24 -05:00
.gitattributes
.gitignore
.travis.yml
License.html
pom.xml enhance user storage jpa example 2016-12-03 13:33:16 -05:00
README.md
travis-run-tests.sh KEYCLOAK-4021 Travis didn't run all tests 2016-12-02 21:56:40 +01:00

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/integration/pom.xml exec:java -Pkeycloak-server 

To start Keycloak from the appliance distribution first build the distribution it as specified above, then run:

tar xfz distribution/appliance-dist/target/keycloak-appliance-dist-all-<VERSION>.tar.gz
cd keycloak-appliance-dist-all-<VERSION>/keycloak
bin/standalone.sh

To stop the server press Ctrl + C.

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