diff --git a/README.md b/README.md index 00d3a1cac4e6386e4e7546bd8efb40cf568d1f61..9a3f314b031af4b0c1bf5c55e62a9633fde92dbd 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