onaci/keycloak-gatekeeper repository overview

⁠Keycloak

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

This repository contains the source code for the Keycloak Gatekeeper. The Gatekeeper is most happy in the company of Keycloak, but is also able to make friends with other OpenID Connect providers. The service supports both access tokens in browser cookie or bearer tokens.

⁠Help and Documentation

• Gatekeeper documentation⁠
• Keycloak documentation⁠
• User Mailing List⁠ - Mailing list for help and general questions about Keycloak
• JIRA⁠ - Issue tracker for bugs and feature requests

⁠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 Gatekeeper please open an issue in our Issue Tracker⁠. Please remember to provide a good summary, description as well as steps to reproduce the issue.

⁠Getting started

To run Gatekeeper download the distribution from our website⁠. Extract it and run:

./keycloak-gatekeeper[.exe] 

Alternatively, you can use the Docker image by running:

docker run -it --rm quay.io/keycloak/keycloak-gatekeeper

For more details refer to the Documentation⁠.

⁠Building from Source

To build from source refer to the building and working with the code base⁠ guide.

⁠Writing Tests

To write tests refer to the writing tests⁠ guide.

⁠Contributing

Before contributing to Gatekeeper please read our contributing guidelines⁠.

⁠Other Keycloak Projects

• Keycloak⁠ - Keycloak Server and Java adapters
• Keycloak Documentation⁠ - Documentation for Keycloak
• Keycloak QuickStarts⁠ - QuickStarts for getting started with Keycloak
• Keycloak Docker⁠ - Docker images for Keycloak
• 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⁠