No description
Find a file
Stian Thorgersen c91255f620 Merge pull request #2328 from abstractj/reg-cli-minor-fix
Client registration won't compile without these changes
2016-03-07 06:12:43 +01:00
adapters KEYCLOAK-2592 Set http-only on OAuth_Token_Request_State cookie 2016-03-04 13:43:00 +01:00
common KEYCLOAK-1928 Fix Saml with IBM JDK 2016-02-29 17:32:33 +01:00
core KEYCLOAK-2592 Set secure on OAuth_Token_Request_State cookie 2016-03-04 14:22:48 +01:00
dependencies Next is 1.9.1.Final-SNAPSHOT 2016-02-23 08:48:26 +01:00
distribution unsecure url has principal 2016-02-29 09:30:28 -05:00
docbook Inclusion of add user instructions for overlay 2016-03-02 10:14:41 -03:00
examples Updated examples with moved themes directory 2016-02-23 15:30:50 +01:00
federation unsecure url has principal 2016-02-29 09:30:28 -05:00
integration Client registration won't compile without these changes 2016-03-04 12:46:57 -03:00
misc Added wallpaper svg 2016-02-23 20:08:43 +01:00
model cleanup cache 2016-03-04 10:30:48 -05:00
proxy Next is 1.9.1.Final-SNAPSHOT 2016-02-23 08:48:26 +01:00
saml-core KEYCLOAK-2510 2016-02-29 20:39:44 -05:00
server-spi cleanup cache 2016-03-04 10:30:48 -05:00
services Merge pull request #2326 from stianst/KEYCLOAK-2592 2016-03-07 06:12:17 +01:00
testsuite Merge pull request #2322 from vramik/KEYCLOAK-2586 2016-03-04 08:22:47 +01:00
themes Removed english values from non-english messages bundles£ 2016-03-03 06:53:00 +01:00
util unsecure url has principal 2016-02-29 09:30:28 -05:00
wildfly Next is 1.9.1.Final-SNAPSHOT 2016-02-23 08:48:26 +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 Updating xmlsec to 2.0.5 2016-02-25 11:43:00 -03: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