No description
Find a file
2016-08-02 09:20:33 +02:00
adapters KEYCLOAK-3237 Add scope=openid to KeycloakInstalled 2016-08-02 05:45:55 +02:00
authz [KEYCLOAK-3338] - Adding client roles to role policy and UX improvements 2016-07-27 15:15:14 -03:00
common user fed spi querying tests 2016-07-22 11:42:07 -04:00
core component model 2016-08-02 05:48:57 +02:00
dependencies bump version 2016-06-30 17:17:53 -04:00
distribution [KEYCLOAK-3320] - Enable authorization services to WF8 adapter 2016-07-20 08:16:37 -03:00
examples fix 2016-08-02 05:50:23 +02:00
federation component model 2016-08-02 05:48:57 +02:00
integration bump version 2016-06-30 17:17:53 -04:00
misc KEYCLOAK-3175 Document run of OIDC Conformance test 2016-07-15 12:51:35 +02:00
model component model 2016-08-02 05:48:57 +02:00
proxy bump version 2016-06-30 17:17:53 -04:00
saml-core KEYCLOAK-3268 2016-07-27 09:28:48 -04:00
saml-core-api bump version 2016-06-30 17:17:53 -04:00
server-spi component model 2016-08-02 05:48:57 +02:00
services fix 2016-08-02 05:49:50 +02:00
testsuite component model 2016-08-02 05:48:57 +02:00
themes [KEYCLOAK-3385] - Improvements to evaluation tool UI and result 2016-08-01 18:01:24 -03:00
util bump version 2016-06-30 17:17:53 -04:00
wildfly KEYCLOAK-3202 Creating users causes memory leak 2016-07-05 19:54:55 +02: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 Travis workaround - another attempt 2016-08-02 09:20:33 +02:00
License.html distro 2014-01-07 14:37:50 -05:00
pom.xml Add versions for Jetty 9.3 adapter dists 2016-07-08 08:21:03 +02: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