No description
Find a file
Vaclav Muzikar 18b07190bf Add system property for test constants location
(cherry picked from commit f9afa13)
2016-03-22 12:17:13 +01:00
adapters KEYCLOAK-2681 JS adapter init function with initOptions argument doesn't call success callback 2016-03-18 12:06:46 +01:00
common KEYCLOAK-2687 ZIPException during import big number of users 2016-03-22 07:04:54 +01:00
core Next is 2.0.0.CR1 2016-03-10 08:13:00 +01:00
dependencies Next is 2.0.0.CR1 2016-03-10 08:13:00 +01:00
distribution KEYCLOAK-2657 Remove copyright.txt and README.txt from server dist 2016-03-22 07:28:45 +00:00
docbook KEYCLOAK-2469 Minor changes 2016-03-21 15:45:53 +01:00
examples Next is 2.0.0.CR1 2016-03-10 08:13:00 +01:00
federation Merge pull request #2383 from ratcashdev/master 2016-03-18 12:18:02 +01:00
integration Next is 2.0.0.CR1 2016-03-10 08:13:00 +01:00
misc Added wallpaper svg 2016-02-23 20:08:43 +01:00
model KEYCLOAK-2631 Caching of service account links 2016-03-22 07:08:47 +01:00
proxy Next is 2.0.0.CR1 2016-03-10 08:13:00 +01:00
saml-core Next is 2.0.0.CR1 2016-03-10 08:13:00 +01:00
server-spi KEYCLOAK-2686 - Fix failing migration from 1.9.1 to 1.9.2. 2016-03-21 09:52:25 +01:00
services Merge pull request #2399 from stianst/KEYCLOAK-2469 2016-03-22 08:09:59 +01:00
testsuite Add system property for test constants location 2016-03-22 12:17:13 +01:00
themes Remove admin theme from i18n consideration 2016-03-21 09:42:00 -04:00
util Next is 2.0.0.CR1 2016-03-10 08:13:00 +01:00
wildfly KEYCLOAK-2612 Set default eviction strategy for users cache 2016-03-11 13:01:57 +01:00
.gitattributes KEYCLOAK-1385 Introduce end-of-line normalization 2015-07-17 13:46:51 +02:00
.gitignore Old experiment with keycloak-server.json embedded into standalone.xml 2014-11-05 08:31:05 -05:00
.travis.yml KEYCLOAK-1420 Removed redundant travis build step. 2016-01-20 07:28:27 +01:00
License.html distro 2014-01-07 14:37:50 -05:00
pom.xml Next is 2.0.0.CR1 2016-03-10 08:13:00 +01:00
README.md Updated readme 2016-01-21 09:50:33 +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.2.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 specficied 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

  • 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
  • Developer Mailing List - Mailing list to discuss development of Keycloak

License