From 0f56047dac8c1861bdbb44782238bace4ece2155 Mon Sep 17 00:00:00 2001
From: Dominic Grimm <dominic@dergrimm.net>
Date: Sun, 18 Feb 2024 18:51:49 +0100
Subject: [PATCH] Add README.md

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aeca637
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# MQTT Event Listener Provider for Keycloak
+
+Keycloak SPI to publish events to a MQTT broker
+
+Based on https://github.com/softwarefactory-project/keycloak-event-listener-mqtt
+
+## Configuration
+
+- `server-uri` (String): MQTT broker URI
+- `username` (String) / `password` (String): Credentials
+- `topic` (String): MQTT base topic
+- `use-persistence` (Boolean): MQTT persistence
+- `retained` (Boolean): Message retention
+- `clean-session` (Boolean): Establish clean sessions
+- `connection-timeout` (Int): Timeout duration in seconds
+- `qos` (Int): MQTT QoS
+
+## Installtion
+
+Copy the JAR into `providers/` and run Keycloak with these options:
+
+```sh
+./bin/kc.sh start \
+        --proxy=edge \
+        --hostname-strict=false \
+        --spi-events-listener-mqtt-server-uri tcp://localhost:1883 \
+        --spi-events-listener-mqtt-username username \
+        --spi-events-listener-mqtt-password password \
+        --spi-events-listener-mqtt-topic keycloak \
+        --spi-events-listener-mqtt-use-persistence true \
+        --spi-events-listener-mqtt-retained true \
+        --spi-events-listener-mqtt-clean-session true \
+        --spi-events-listener-mqtt-qos 0
+```