diff --git a/homelab/server/config/keycloak/README.md b/homelab/server/config/keycloak/README.md index e38a6a59..286c20c2 100644 --- a/homelab/server/config/keycloak/README.md +++ b/homelab/server/config/keycloak/README.md @@ -1,14 +1,11 @@ -# Configuring an OIDC client with Keycloak -1. For the Jafner.net realm, navigate to Clients -> Create Client. -2. Create a client of type 'OpenID Connect', and choose a Client ID. The client ID should be short and unique (e.g. 'gitlab.jafner.net'). Click Next, enable Client Authentication, and click Save. -3. Under the Credentials tab, copy the Client secret for future use. -4. - -## URL Table +# OIDC Configuration Information Table | Application asks for... | URL | |:-----------------------:|:---:| +| Client ID | In Keycloak, under the Jafner.net realm, click Clients -> Create Client. Set your own Client ID | +| Client Secret | After creating the client in Keycloak, go to Clients -> -> Credentials. Then click the copy icon to the right of "Client secret". +| Client Scopes | `email openid profile` | Authorization URL | https://keycloak.jafner.net/realms/Jafner.net/protocol/openid-connect/auth | | Access token URL | https://keycloak.jafner.net/realms/Jafner.net/protocol/openid-connect/token | -| Resource URL or Userinfo URL | https://keycloak.jafner.net/realms/Jafner.net/protocol/openid-connect/userinfo | +| Resource URL, Userinfo URL, API URL | https://keycloak.jafner.net/realms/Jafner.net/protocol/openid-connect/userinfo | | Redirect URL | Use the home URL of the application (e.g. https://portainer.jafner.net) | Logout URL | https://keycloak.jafner.net/realms/Jafner.net/protocol/openid-connect/logout \ No newline at end of file