Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chrismaille committed Sep 21, 2024
1 parent d1de7d5 commit 9393cbb
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion docs/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Troubleshooting Guide

### Common errors:
### Common questions:

??? question "Admin Message: _**State Mismatched. Time expired?**_"
This error occurs when the user is redirected to the Google login page and then returns to the Django login page but
Expand Down Expand Up @@ -35,6 +35,30 @@
To see these errors please check the logs or enable the option `GOOGLE_SSO_SHOW_FAILED_LOGIN_MESSAGE` to see failed
login messages on browser. Please, make note these messages can be used on exploit attacks.

??? question "Got a "KeyError: 'NAME'" error after set SSO_USE_ALTERNATE_W003"
If you get a `KeyError: 'NAME'` error, please set a `NAME` in `TEMPLATES` at `settings.py`:

```python
# settings.py

TEMPLATES = [
{
"BACKEND": "django.template.backends.django.DjangoTemplates",
"NAME" : "default", # <-- Add name here
"DIRS": [BASE_DIR / "templates"],
"APP_DIRS": True,
"OPTIONS": {
"context_processors": [
"django.template.context_processors.debug",
"django.template.context_processors.request",
"django.contrib.auth.context_processors.auth",
"django.contrib.messages.context_processors.messages",
],
},
},
]
```

### Example App

To test this library please check the `Example App` provided [here](https://github.com/megalus/django-google-sso/tree/main/example_google_app).
Expand Down

0 comments on commit 9393cbb

Please sign in to comment.