No description
Find a file
2016-04-14 13:16:14 +02:00
adapters merge adapter-spi adapter-spi-public 2016-04-13 22:25:30 -04:00
common KEYCLOAK-2590 Add custom rest endpoint to set time offset 2016-04-06 11:14:37 +02:00
core KEYCLOAK-2766 Add missing id to AuthenticatorConfigRepresentation 2016-04-11 07:42:55 +02:00
dependencies Next is 2.0.0.CR1 2016-03-10 08:13:00 +01:00
distribution merge adapter-spi adapter-spi-public 2016-04-13 22:25:30 -04:00
docbook KEYCLOAK-2774 2016-04-08 06:59:39 +02:00
examples KEYCLOAK-2818 2016-04-14 08:16:07 +02:00
federation KEYCLOAK-2811 FederationProvidersIntegrationTest.testReadOnly failing on MSAD 2016-04-13 12:40:39 +02:00
integration KEYCLOAK-2818 2016-04-14 08:16:07 +02:00
misc Added wallpaper svg 2016-02-23 20:08:43 +01:00
model KEYCLOAK-2820 Mongo doesn't start on wildfly 2016-04-14 10:43:57 +02:00
proxy KEYCLOAK-2791 - Proxy handling for X-Forwarded headers 2016-04-09 02:11:59 -04:00
saml-core public/private 2016-04-12 15:19:46 -04:00
saml-core-api public/private 2016-04-12 15:19:46 -04:00
server-spi KEYCLOAK-2819 Fix realm security header setup after migration 2016-04-14 10:43:48 +02:00
services KEYCLOAK-2810 Added robots.txt and robots meta header 2016-04-13 11:22:57 +02:00
testsuite KEYCLOAK-2818 2016-04-14 08:16:07 +02:00
themes KEYCLOAK-2823 Password policy 'hashAlgorithm' value not correctly shown in admin console 2016-04-14 13:16:14 +02: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 merge adapter-spi adapter-spi-public 2016-04-13 22:25:30 -04: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