Skip to content

Commit 4e812b4

Browse files
authored
Update README to point to separate keycloak readme (#2103)
1 parent 7612122 commit 4e812b4

File tree

1 file changed

+3
-19
lines changed

1 file changed

+3
-19
lines changed

README.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -211,26 +211,10 @@ This repo includes a config for running a [Jupyter notebook](https://jupyter.org
211211

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

214-
### Connecting with an OpenID Connect provider for authentication
214+
### Connecting with Keycloak for authentication
215215

216-
The MIT Learn application relies on an OpenID Connect client provided by Keycloak for authentication.
217-
218-
The following environment variables must be defined using values from a Keycloak instance:
219-
220-
- SOCIAL_AUTH_OL_OIDC_OIDC_ENDPOINT - The base URI for OpenID Connect discovery, https://<OIDC_ENDPOINT>/ without .well-known/openid-configuration.
221-
- OIDC_ENDPOINT - The base URI for OpenID Connect discovery, https://<OIDC_ENDPOINT>/ without .well-known/openid-configuration.
222-
223-
- SOCIAL_AUTH_OL_OIDC_KEY - The client ID provided by the OpenID Connect provider.
224-
- SOCIAL_AUTH_OL_OIDC_SECRET - The client secret provided by the OpenID Connect provider.
225-
- AUTHORIZATION_URL - Provider endpoint where the user is asked to authenticate.
226-
- ACCESS_TOKEN_URL - Provider endpoint where client exchanges the authorization code for tokens.
227-
- USERINFO_URL - Provder endpoint where client sends requests for identity claims.
228-
- KEYCLOAK_BASE_URL - The base URL of the Keycloak instance. Used for generating the
229-
- KEYCLOAK_REALM_NAME - The Keycloak realm that the OpenID Connect client exists in.
230-
231-
To login via the Keycloak client, open http://od.odl.local:8063/login/ol-oidc in your browser.
232-
233-
Additional details can be found at https://docs.google.com/document/d/17tJ-C2EwWoSpJWZKjuhMVgsqGtyPH0IN9KakXvSKU0M/edit
216+
Please read [the Keycloak README](README-keycloak.md) for instructions on authenticating via
217+
local Keycloak and APISIX containers.
234218

235219
### Configuring PostHog Support
236220

0 commit comments

Comments
 (0)