Skip to content

Update mokey_oidc readme to include OIDC configuration without Mokey/Hydra integration #528

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

Merged
aebruno merged 1 commit into from
Jul 21, 2023
Merged

Update mokey_oidc readme to include OIDC configuration without Mokey/Hydra integration #528

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
8 changes: 7 additions & 1 deletion coldfront/plugins/mokey_oidc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ Django users.
- pip install mozilla-django-oidc

## Usage
### Mokey/Hydra integration

To enable this plugin set the following environment variables:

```

PLUGIN_AUTH_OIDC=True
PLUGIN_MOKEY=True
OIDC_OP_JWKS_ENDPOINT="https://hydra.local/.well-known/jwks.json"
Expand All @@ -35,3 +35,9 @@ OIDC_OP_AUTHORIZATION_ENDPOINT="https://hydra.local/oauth2/auth"
OIDC_OP_TOKEN_ENDPOINT="https://hydra.local/oauth2/token"
OIDC_OP_USER_ENDPOINT="https://hydra.local/userinfo"
```

### OIDC
If you are just using OIDC and do not need Mokey/Hydra integration:
- Set the above environment variables, but do not set `PLUGIN_MOKEY`.
- In your [ColdFront configuration file](https://coldfront.readthedocs.io/en/latest/config/#configuration-files) (`local_settings.py` or set by the `COLDFRONT_CONFIG` environment variable), set `SESSION_COOKIE_SAMESITE = "Lax"`
- You may also need to edit `mozilla-django-oidc` [settings](https://mozilla-django-oidc.readthedocs.io/en/stable/settings.html) in your `local_settings.py`.