No description
Find a file
Bill Burke 34095ef522 docs
2016-01-28 23:28:11 -05:00
adapters saml adapter endpoint changes 2016-01-28 22:56:14 -05:00
common Version bump 2016-01-13 09:20:38 +01:00
core KEYCLOAK-2237 2016-01-26 10:16:05 +01:00
dependencies KEYCLOAK-2312 Move forms/common-themes to themes 2016-01-21 13:51:01 +01:00
distribution KEYCLOAK-2312 Move forms/common-themes to themes 2016-01-21 13:51:01 +01:00
docbook docs 2016-01-28 23:28:11 -05:00
examples email, login, account 2016-01-16 09:38:24 -05:00
federation KEYCLOAK-2379 Fix possible error during sycnchronization changed users with Active Directory 2016-01-26 10:43:17 +01:00
integration KEYCLOAK-2312 Move client-registration libs into integration 2016-01-21 09:06:23 +01:00
misc KEYCLOAK-2312 Move forms/common-themes to themes 2016-01-21 13:51:01 +01:00
model Merge remote-tracking branch 'upstream/master' 2016-01-28 09:23:34 -05:00
proxy KEYCLOAK-1809 2016-01-14 16:34:30 +01:00
saml-core saml logging 2016-01-25 17:38:29 -05:00
server-spi browser back button 2016-01-27 22:14:28 -05:00
services fix2 2016-01-27 23:06:20 -05:00
testsuite saml adapter endpoint changes 2016-01-28 22:56:14 -05:00
themes KEYCLOAK-2349 2016-01-26 15:45:40 -05:00
util Version bump 2016-01-13 09:20:38 +01:00
wildfly KEYCLOAK-2312 Move forms/common-themes to themes 2016-01-21 13:51:01 +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 KEYCLOAK-2080 Downgrade H2 to 1.3.173, which is version in Wildfly 10.0.0.CR5 2016-01-26 17:59:30 +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