Skip to content

Update README to point to separate keycloak readme #2103

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
merged 1 commit into from
Mar 3, 2025
Merged

Update README to point to separate keycloak readme #2103

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
22 changes: 3 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,26 +211,10 @@ This repo includes a config for running a [Jupyter notebook](https://jupyter.org

From there, you should be able to run code snippets with a live Django app just like you would in a Django shell.

### Connecting with an OpenID Connect provider for authentication
### Connecting with Keycloak for authentication

The MIT Learn application relies on an OpenID Connect client provided by Keycloak for authentication.

The following environment variables must be defined using values from a Keycloak instance:

- SOCIAL_AUTH_OL_OIDC_OIDC_ENDPOINT - The base URI for OpenID Connect discovery, https://<OIDC_ENDPOINT>/ without .well-known/openid-configuration.
- OIDC_ENDPOINT - The base URI for OpenID Connect discovery, https://<OIDC_ENDPOINT>/ without .well-known/openid-configuration.

- SOCIAL_AUTH_OL_OIDC_KEY - The client ID provided by the OpenID Connect provider.
- SOCIAL_AUTH_OL_OIDC_SECRET - The client secret provided by the OpenID Connect provider.
- AUTHORIZATION_URL - Provider endpoint where the user is asked to authenticate.
- ACCESS_TOKEN_URL - Provider endpoint where client exchanges the authorization code for tokens.
- USERINFO_URL - Provder endpoint where client sends requests for identity claims.
- KEYCLOAK_BASE_URL - The base URL of the Keycloak instance. Used for generating the
- KEYCLOAK_REALM_NAME - The Keycloak realm that the OpenID Connect client exists in.

To login via the Keycloak client, open http://od.odl.local:8063/login/ol-oidc in your browser.

Additional details can be found at https://docs.google.com/document/d/17tJ-C2EwWoSpJWZKjuhMVgsqGtyPH0IN9KakXvSKU0M/edit
Please read [the Keycloak README](README-keycloak.md) for instructions on authenticating via
local Keycloak and APISIX containers.

### Configuring PostHog Support

Expand Down
Loading