keycloak-quickstarts

Keycloak Quickstarts

Keycloak is an Open Source Identity and Access Management solution for modern Applications and Services.

The quickstarts herein provided demonstrate securing applications with 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 to secure Jakarta Applications js Examples about how to secure JavaScript Applications nodejs Examples about how to secure NodeJS Applications proxy Examples about how to deploy Keycloak behind a reverse proxy spring Examples about how to secure Spring Applications

For any missing programming language and framework, you might want to consider looking at:

• Quarkus
  • Securing a Client Application
  • Securing a Resource Server Application

We are happy to accept contributions for any reference that demonstrates how to integrate Keycloak with additional programming languages or frameworks.

Building, Testing, and Running the Quickstarts

First clone the Keycloak repository:

git clone https://github.com/keycloak/keycloak-quickstarts.git
cd keycloak-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.

Chrome driver version

Some 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.

Help and Documentation

• Documentation
• User Mailing List - Mailing list for help and general questions about Keycloak

Reporting Security Vulnerabilities

If you've found a security vulnerability, please look at the instructions on how to properly report it

Reporting an issue

If you believe you have discovered a defect in Keycloak, please open an issue. Please remember to provide a good summary, description as well as steps to reproduce the issue.

Contributing

Before contributing to this repository, please read our contributing guidelines.

Related Projects

• 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

License

• Apache License, Version 2.0