mirror of
https://github.com/keycloak/keycloak.git
synced 2026-01-25 16:42:34 +00:00
3ec516d14c
UserFederationProvidersResource is now aware of ConfiguredProvider and allows sophisticated configuration of configuration properties via ProviderConfigProperty definitions. See DummyUserFederationProviderFactory. getConfigProperties() for example. Previously UserFederationProvidersResource did only support simple key-value pairs for expressing configurable options. Tested this by launching a standalone KeycloakServer and creating a new Dummy UserFederationProvider. The default values, labels and help messages are correctly displayed and the values are stored correctly.
Keycloak
Keycloak is an SSO Service for web apps and REST services. For more information visit http://keycloak.org.
Building
Ensure you have JDK 7 (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.
Contributing
Documentation
- User Guide, Admin REST API and Javadocs
- 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
- Release Process - how to release Keycloak