No description
Find a file
Stian Thorgersen 74809b4132 Merge pull request #2864 from mhajas/fixOfflineServlets
KEYCLOAK-3025 Fix offline servlet adapter tests and refactoring
2016-05-23 08:41:42 +02:00
adapters KEYCLOAK-3016: BasicAuthRequestAuthenticator now consumes HttpEntity also on errors. 2016-05-19 08:47:51 +03:00
common KEYCLOAK-2903 Fix WelcomeResource to not allow requests forwarded from proxy/loadbalancer 2016-04-26 12:03:43 +02:00
core KEYCLOAK-2862 AuthenticationManagementResource tests 2016-05-06 20:19:58 +02:00
dependencies
distribution KEYCLOAK-2805 - Update docs for JBoss Fuse 6.3 2016-05-05 15:22:14 +02:00
docbook KEYCLOAK-2805 Minor changes - cleanup and docs 2016-05-05 22:55:53 +02:00
examples KEYCLOAK-2805 Minor changes - cleanup and docs 2016-05-05 22:55:53 +02:00
federation KEYCLOAK-2811 FederationProvidersIntegrationTest.testReadOnly failing on MSAD 2016-04-13 12:40:39 +02:00
integration KEYCLOAK-2863 ClientAttributeCertificateResource 2016-05-11 15:22:39 +02:00
misc Easier MariaDB support in tests 2016-05-04 23:08:30 +02:00
model KEYCLOAK-2973 Persist federated identity on token update 2016-05-05 14:51:17 -07: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-2846 export/import of clientTemplate scopes 2016-04-20 13:30:01 +02:00
services KEYCLOAK-2880 Refactor PermissionTest to not require Java8 2016-05-09 07:25:03 +02:00
testsuite Merge pull request #2864 from mhajas/fixOfflineServlets 2016-05-23 08:41:42 +02:00
themes KEYCLOAK-2994: Revise german translations for login pages in base theme 2016-05-12 10:41:09 +02:00
util Next is 2.0.0.CR1 2016-03-10 08:13:00 +01:00
wildfly Merge pull request #2752 from patriot1burke/master 2016-04-27 11:37:20 -04:00
.gitattributes
.gitignore
.travis.yml
License.html
pom.xml KEYCLOAK-2805 - Moved cxf.version up to the main pom 2016-05-05 15:22:03 +02:00
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