No description
Find a file
Stian Thorgersen f2f2158154 Merge pull request #2687 from mposolda/master
KEYCLOAK-2842 Not possible to add new execution under registration flow
2016-04-20 19:40:34 +02:00
adapters KEYCLOAK-2852 Moved JAAS classes back to package org.keycloak.adapters.jaas 2016-04-19 22:19:10 +02:00
common KEYCLOAK-2590 Add custom rest endpoint to set time offset 2016-04-06 11:14:37 +02:00
core KEYCLOAK-2846 export/import of clientTemplate scopes 2016-04-20 13:30:01 +02:00
dependencies
distribution KEYCLOAK-2827 ModuleLoadError: org.keycloak.keycloak-core-public:main 2016-04-14 15:23:21 +02:00
docbook Update spring-boot-adapter.xml 2016-04-19 17:02:37 +02:00
examples KEYCLOAK-2818 2016-04-14 08:16:07 +02:00
federation
integration KEYCLOAK-2861 Test AttackDetectionResource 2016-04-20 16:21:57 +02:00
misc
model KEYCLOAK-2820 Mongo doesn't start on wildfly 2016-04-14 10:43:57 +02:00
proxy
saml-core
saml-core-api public/private 2016-04-12 15:19:46 -04:00
server-spi KEYCLOAK-2846 export/import of clientTemplate scopes 2016-04-20 13:30:01 +02:00
services KEYCLOAK-2842 Not possible to add new execution under registration flow 2016-04-20 18:39:11 +02:00
testsuite Merge pull request #2687 from mposolda/master 2016-04-20 19:40:34 +02:00
themes KEYCLOAK-2491 Fix permissions in admin console to match permissions in admin endpoints 2016-04-20 09:57:57 +02:00
util
wildfly
.gitattributes
.gitignore
.travis.yml
License.html
pom.xml
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.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