-
Notifications
You must be signed in to change notification settings - Fork 169
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update installation.rst to set LOGIN_URL #469
base: main
Are you sure you want to change the base?
Conversation
Setting LOGIN_URL enables django's login_required decorator to use mozilla-django-keycloak's login URL.
@ajcollins thank you for this PR! Could you maybe explain why this needs to be part of the documentation? Probably there is a typo here too as you mention |
@akatsoulas thank you for considering it and for the very helpful project. Sorry for the lack of clarity and typo. I proposed the change as, after following the mozilla_django_oidc installation instructions, views decorated with django's I realise that many will add OIDC support having already set I've fixed the typo and updated the comment in the code. Hopefully this improves the clarity. |
Thanks @ajcollins for clarifying this! |
docs/installation.rst
Outdated
@@ -85,6 +85,12 @@ Start by making the following changes to your ``settings.py`` file. | |||
AUTHENTICATION_BACKENDS = ( | |||
'mozilla_django_oidc.auth.OIDCAuthenticationBackend', | |||
# ... | |||
|
|||
# Set LOGIN_URL to mozilla_django_oidc's login URL. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ajcollins can you maybe rephrase this a bit to indicate that is more of a hint and not a necessary step?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@akatsoulas sorry for the delay. Good point. PR updated.
Update docs to set LOGIN_URL, which enables django's login_required decorator to use mozilla-django-keycloak's login URL.