django-saml2-pro-auth icon indicating copy to clipboard operation
django-saml2-pro-auth copied to clipboard

Errors in documentation, no migration path for pre v1.0 users

Open jrial opened this issue 3 years ago • 2 comments

The documentation (the README in the project root) contains a few errors and omissions:

  • It doesn't mention that one needs to add saml2_pro_auth to the INSTALLED_APPS list
  • It refers to the function_urls, which no longer exist

This second item is causing an issue for people migrating from pre 1.0 to post 1.0: the class-based views have changed the SAML URLs, which means the SSO provider must update their settings to match the new URLs. In some organisations this can be a bit problematic due to slow formal ITIL procedures.

Not sure if this is a bug, or simply not or badly documented, but I would have guessed that setting the SAML_ROUTE setting, and including the URLs for ACS and SLS under the SAML_PROVIDERS dictionary, would result in the system using the same URLs as previously under the function-based views. This doesn't seem to work. I already had them in my settings, and they remain unchanged. What's worse: the new URLs don't seem to work either. They either result in a 404 or a 500. Before I file a separate bug for that, can someone from the team enlighten me as to whether these settings should in fact override the URLs for the class-based views as well?

jrial avatar Jan 22 '21 15:01 jrial