Skip to content
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

Clarify documentation intent for local user setup #37

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Clarify documentation intent for local user setup #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 6 additions & 5 deletions docs/scenario/local_user_setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ Setup for local user storage
.. toctree::
:maxdepth: 4

By local user storage a
When using local user storage a
`User object <https://docs.djangoproject.com/en/2.0/topics/auth/default/#user-objects>`_
get created for every logged in identity. This can be handy when you want to
link objects to this User. If that's not the case please read the
scenario :ref:`remote_user_setup`.
gets created for every logged in identity. This can be handy when you want to
add objects and relationships to the authenticated User.

However, if you do not wish to store a local copy of a user please read the scenario :ref:`remote_user_setup`.

Since **this is the default behaviour for Django Keycloak** you don't have to
configure any setting.
Expand All @@ -25,4 +26,4 @@ available.
.. code-block:: python

# settings.py
KEYCLOAK_OIDC_PROFILE_MODEL = 'django_keycloak.OpenIdConnectProfile'
KEYCLOAK_OIDC_PROFILE_MODEL = 'django_keycloak.OpenIdConnectProfile'