https://github.com/aboutbits/keycloak-extensions
https://github.com/aboutbits/keycloak-extensions
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/aboutbits/keycloak-extensions
- Owner: aboutbits
- Created: 2020-11-08T18:00:24.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-10-17T06:17:20.000Z (over 3 years ago)
- Last Synced: 2025-04-25T12:46:11.131Z (10 months ago)
- Language: Java
- Homepage:
- Size: 15.6 KB
- Stars: 31
- Watchers: 2
- Forks: 30
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Keycloak Extensions
This repository shows how you can extend Keycloak's features.
## Table of content
- [Prerequisites](#prerequesites)
- [Setup](#setup)
- [Custom Event Listener](#custom-event-listener)
## Prerequisites
- [Docker](https://docs.docker.com/get-docker/)
- [Docker Compose](https://docs.docker.com/compose/)
## Setup
### Build the artefact of the custom event listener
If you want to test the example event listener, than you have to build it before you start the keycloak server.
```bash
cd custom-event-listener && docker run --rm -v "$PWD":/usr/src/app -w /usr/src/app maven:3-openjdk-11 mvn clean install
```
### Start and stop the containers
Before start working you have to start the Docker containers:
```bash
docker-compose up --build --detach
```
After finished working you can stop the Docker containers:
```bash
docker-compose stop
```
The website will be accessible at [http://localhost:8080/](http://localhost:8080/). The default username for the master realm is "admin" and the password "password".
### SMTP Server
In order to test the whole workflow locally, [Mailhog](https://github.com/mailhog/MailHog) is set up and can be configured as SMTP server that catches all outgoing mails. These are the SMTP configurations:
- Host: mailhog
- Port: 1025
All catched emails can be visited at [http://localhost:8025/](http://localhost:8025/).
## Custom Event Listener
Lets build a custom event listener, that sends an email to an admin on every new registration.
Follow this [link](custom-event-listener/README.md) for more details.