From bff4fff866d9c0d916b03b6e45e5c165f607d8ff Mon Sep 17 00:00:00 2001
From: Roland Alton <ras@osalliance.com>
Date: Thu, 2 Mar 2023 19:06:17 +0000
Subject: [PATCH] extend readme and explain combination with home-idp-discovery

---
 README.md | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 00d3a1c..9a3f314 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,9 @@
 # Keycloak SAML2 metadata feed importer
 
+reads XML metadata and creates or updates identity providers in Keycloak
+
+works perfect in combination with [Keycloak home IdP discovery plugin](https://git.fairkom.net/fairlogin/kc-metadata-import) which offers to enter e-mail and then redirects to the matching IdP for login
+
 # requirements
 Python3.10+
 (optional) an external database, to keep track of the syncs, if there is no external DB, sqlite has to be selected 
@@ -15,6 +19,8 @@ run the sync script with
 ./main.py
 ```
 
+you may want to run the script once a day to update the IdPs
+
 ## configuration
 ### Environment variables
  - SAML2_METADATA_URL (e.g. https://eduid.at/md/aconet-registered.xml) 
@@ -24,7 +30,7 @@ run the sync script with
  - KEYCLOAK_PASSWORD (Keycloak users password)
  - DB_TYPE (postresql, mysql or sqlite)
 
-for external datbases
+for external databases
  - DB_USER (database user)
  - DB_PASSWORD (database password)
  - DB_HOST (dbms host)
@@ -35,4 +41,4 @@ for external datbases
 edit ./attribute_mapping.json, key is the SAML2 attribute, value is the keycloak user attribute
 
 ### blacklist IDPs and or SPs
-edit blacklist.json , for SPs list the clientId for IDPs the entityIds
\ No newline at end of file
+edit blacklist.json , for SPs list the clientId for IDPs the entityIds
-- 
GitLab