Skip to content

docs(config): clarify keycloak_admin_url subpath usage #266

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

Draft
Artem-Zahumonnyi wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs(config): clarify keycloak_admin_url subpath usage #266

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
14 changes: 7 additions & 7 deletions docs/admin/configuration/access-control/platform-managed-mode-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,13 +124,13 @@ In the Keycloak Admin Console, create a new client in the target realm:
Add the following environment variables to the AI/Run CodeMie Backend deployment alongside
`ENABLE_USER_MANAGEMENT=true`:

| Variable | Example value | Description |
| ------------------------------ | ------------------------------ | ---------------------------------------------------------------- |
| `KEYCLOAK_MIGRATION_ENABLED` | `true` | Enables the one-time import on startup. Disable after first run. |
| `KEYCLOAK_ADMIN_URL` | `https://keycloak.example.com` | Keycloak base URL (no trailing slash, no `/auth` path). |
| `KEYCLOAK_ADMIN_REALM` | `codemie-prod` | Realm that contains the users to migrate. |
| `KEYCLOAK_ADMIN_CLIENT_ID` | `codemie-migration-client` | Service account client ID with admin read permissions. |
| `KEYCLOAK_ADMIN_CLIENT_SECRET` | _(from Kubernetes secret)_ | Service account client secret. Use a Kubernetes secret. |
| Variable | Example value | Description |
| ------------------------------ | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `KEYCLOAK_MIGRATION_ENABLED` | `true` | Enables the one-time import on startup. Disable after first run. |
| `KEYCLOAK_ADMIN_URL` | `https://keycloak.example.com` | Keycloak base URL without trailing slash. Include the subpath if Keycloak is deployed under one (e.g. `https://keycloak.example.com/auth`). |
| `KEYCLOAK_ADMIN_REALM` | `codemie-prod` | Realm that contains the users to migrate. |
| `KEYCLOAK_ADMIN_CLIENT_ID` | `codemie-migration-client` | Service account client ID with admin read permissions. |
| `KEYCLOAK_ADMIN_CLIENT_SECRET` | _(from Kubernetes secret)_ | Service account client secret. Use a Kubernetes secret. |

#### Create Kubernetes secret for the client secret

Expand Down
Loading