Skip to content

Commit

Permalink
add more settings documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
lilioid committed Feb 14, 2024
1 parent 0c1df29 commit cc02414
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/django-integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,18 @@ Recommended settings
This is recommended to be set to ``simple_openid_connect:login`` to serve this libraries login page which handles Openid authentication.
If additional authentication methods are also used, don't do this.

- ``LOGIN_REDIRECT_URL`` (`django LOGIN_REDIRECT_URL docs <https://docs.djangoproject.com/en/dev/ref/settings/#login-redirect-url>`_)
This is the URL to which a user is redirected after a successful login.

- ``LOGOUT_REDIRECT_URL`` (`django LOGOUT_REDIRECT_URL docs <https://docs.djangoproject.com/en/dev/ref/settings/#logout-redirect-url>`_)
This is the url the user is redirected to after logging out. If it is not set, some Openid providers do not redirect the user back to the application.

Settings Reference
------------------

For a list of all settings that are read by *simple_openid_connect*, see the :class:`SettingsModel <simple_openid_connect.integrations.django.apps.SettingsModel>`.


Usage
=====

Expand Down

0 comments on commit cc02414

Please sign in to comment.