Red Hat build of Keycloak is an Open Source Identity and Access Management solution for modern Applications and Services.
The quickstarts herein provided demonstrate securing applications with Red Hat build of Keycloak using different programming languages (and frameworks) and how to extend the server capabilities through a set of Java-based Service Provider Interfaces(SPI). They provide small, specific, working examples that can be used as a reference for your own project.
They are organized in this repository under different categories (or directories) as follows:
Category | Description |
---|---|
extension | Examples about how to extend the server capabilities using some of the Keycloak SPIs. |
jakarta | Examples about how secure Jakarta Applications |
js | Examples about how to secure JavaScript Applications |
nodejs | Examples about how to secure NodeJS Applications |
spring | Examples about how to secure Spring Applications |
For any missing programming language and framework, you might want to consider looking at:
We are happy to accept contributions for any reference that demonstrates how to integrate Red Hat build of Keycloak with additional programming languages or frameworks.
First clone the quickstarts repository:
git clone https://github.com/redhat-developer/rhbk-quickstarts.git
cd rhbk-quickstarts
Each quickstart provides its own documentation with the steps you need to follow in order to build, test, and run the example.
Look at the README.md
file at the root of a quickstart for more details.
In order to use maven repository with the productized artifacts, it is needed to add repository https://maven.repository.redhat.com/ga/ to you settings.xml file.
You can see this repository in the maven-settings.xml file. You can either add the repository to your default settings.xml
file
,which is usually in <your-home-dir>/.m2/settings.xml
file. Or you can run all the maven commands referred from individual quickstarts with the switch pointing to maven-settings.xml
file:
mvn <other arguments as described in the specific quickstarts> -s <path to the file>/.github/maven-settings.xml
Automated tests rely on the chrome browser present on your laptop. Also you need to have correct version of chrome driver according
to the version of the chrome browser used. In case of the issues, see Chrome page and download
correct chrome driver version for your Chrome browser. Then add system property webdriver.chrome.driver
when running the tests according to chrome version
and add whole path to the chrome driver. For instance something like -Dwebdriver.chrome.driver=/somedir/chromedriver-linux64-119.0.6045.105/chromedriver
.
- Documentation
- User Mailing List - Mailing list for help and general questions about Keycloak
If you've found a security vulnerability, please look at the instructions on how to properly report it
If you believe you have discovered a defect in Red Hat build of Keycloak, please open a JIRA issue. Please remember to provide a good summary, description as well as steps to reproduce the issue.
Before contributing to this repository, please read our contributing guidelines.
- Keycloak - Keycloak Server and Java adapters
- Keycloak Node.js Connect - Node.js adapter for Keycloak
- Keycloak Node.js Admin Client - Node.js library for Keycloak Admin REST API