Skip to content

Update installation.rst to set LOGIN_URL #469

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.

Sign up for GitHub

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Update installation.rst to set LOGIN_URL #469

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
706516c
Update installation.rst to set LOGIN_URL
ajcollins Nov 3, 2022
9c8044f
Merge branch 'mozilla:main' into docs_login_url
ajcollins Nov 17, 2022
4d6748f
Update settings.py LOGIN_URL documentation for clarity.
ajcollins Nov 17, 2022
3751b74
Merge branch 'mozilla:main' into docs_login_url
ajcollins Jan 1, 2023
3600a40
docs: indicate setting LOGIN_URL is optional
ajcollins Jan 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Collaborator

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?

Copy link
Author

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.

# Views decorated with django.contrib.auth.decorators.login_required decorator
# or class-based views using the LoginRequiredMixin or AccessMixin will
# automatically be redirected to this URL if a user is not logged in.
LOGIN_URL = 'oidc_authentication_init'
)

You also need to configure some OpenID Connect related settings too.
Expand Down Expand Up @@ -144,7 +150,7 @@ Next, edit your ``urls.py`` and add the following:
.. code-block:: python

from django.urls import path, include

urlpatterns = [
# ...
path('oidc/', include('mozilla_django_oidc.urls')),
Expand Down