Differences

This shows you the differences between two versions of the page.

--- send_email_through_keyclock [2026/03/09 05:28] – sonali
+++ send_email_through_keyclock [2026/03/09 08:00] (current) – sonali
@@ Line 1: / Line 1: @@
+ <font 16px/inherit;;inherit;;inherit>**Overview**</font>
+A system where users can log in using their **email Id /Username + Email OTP** instead of username/password, by Keycloak.
+**Make Email OTP Java SPI **
 # Run this to find the Keycloak container:
@@ Line 20: / Line 26: @@
 We need email-otp-authenticator JAR if it is not available
-. Download the email-otp-authenticator JAR
+**1. Download the email-otp-authenticator JAR**
 <code>
@@ Line 27: / Line 33: @@
 </code>
-. Copy into the running container
+**2. Copy into the running container**
 <code>
 docker cp email-otp-authenticator.jar keycloak_app:/opt/keycloak/providers/
@@ Line 34: / Line 39: @@
 </code>
-. Run build inside the container (registers the provider)
+**3. Run build inside the container (registers the provider)**
+<code>
+# Verify it's there
+docker exec keycloak_app ls /opt/keycloak/providers/
+</code>
 <code>
@@ Line 41: / Line 51: @@
 </code>
-. Restart the container
+**4. Restart the container**
 <code>
 docker restart keycloak_app
@@ Line 50: / Line 59: @@
 # Now let's set up the Email OTP flow. Go to Keycloak Admin Console at [[https://64.227.190.56/|https://64.227.190.56/]]:
-. First configure SMTP (if not already done)
+**1. First configure SMTP (if not already done)**
-Realm Settings → \Email Host: smtp.gmail.com, Port: \587 From: from email \id Username: your username, Password: your app \password Enable StartTLS → Save → Test connection
+Realm Settings → Email
-. Create Email OTP Authentication \Flow Go to Authentication → Flows → Create \flow Name: Browser Email OTP → \Save Add step → Username Password Form → \Required Add step → Email OTP → Required
+Host: smtp.gmail.com,
-. Bind the \flow Client → account → Advance Override realm authentication flow bindings. →Browser Flow → Browser email otp
+Port: 587
-Customize email \content python3 -c "import zipfile; [print(f) for f in zipfile.ZipFile('email-otp-authenticator.jar').namelist()]"
+From: from email id
-# check current email template python3 -c " import \zipfile with zipfile.ZipFile('email-otp-authenticator.jar') as z:
+Username: your username,
+Password: your app
+password Enable StartTLS → Save → Test connection
+**2. Create Email OTP Authentication Flow**
 <code>
-print(z.read('theme-resources/messages/messages_en.properties').decode())
+Go to Authentication → Flows → Create flow Name: Browser Email OTP
+→ Save Add step → Username Password Form → Required Add step →
+Email OTP → Required
 </code>
+**3. Bind the flow**
+Client → account → Advance Override realm authentication flow bindings. →Browser Flow → Browser email otp
+**Customize email content**
+<code>
+python3 -c "import zipfile; [print(f) for f in zipfile.ZipFile('email-otp-authenticator.jar').namelist()]"
+</code>
+# check current email template
+<code>
+python3 -c "
+import zipfile
+with zipfile.ZipFile('email-otp-authenticator.jar') as z:
+    print(z.read('theme-resources/messages/messages_en.properties').decode())
 "
+</code>
 # To customize the email text, create a custom Keycloak theme. Run these commands on the droplet:
@@ Line 126: / Line 162: @@
 </code>
-# Browser email otp Flow order should be\\
+**# Browser email otp Flow order should be** \\
 Username Form → Required (first)\\
 Email OTP Form → Required (second)
-# Dont do this
+**# Dont do this**
 - No required user action available in user details\\