Conversation
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://ambitious-pebble-0eed14903-1.westeurope.6.azurestaticapps.net |
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for integrating Keycloak authentication with DbGate to the admin authentication page. The documentation provides step-by-step configuration guidance for setting up Keycloak as an OAuth 2.0 provider in the DbGate Premium admin interface.
- Adds a new "Keycloak" section to the authentication documentation
- Documents required OAuth 2.0 endpoint URLs for Keycloak integration
- Provides configuration details for both DbGate and Keycloak client settings
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **OAuth auth endpoint**: `https://keycloak.company.com/realms/your-realm/protocol/openid-connect/auth` | ||
| - **OAuth token endpoint**: `https://keycloak.company.com/realms/your-realm/protocol/openid-connect/token` | ||
| - **OAuth logout endpoint**: `https://keycloak.company.com/realms/your-realm/protocol/openid-connect/logout` | ||
| - **OAuth client**: Your Keycloak client ID |
There was a problem hiding this comment.
The OAuth configuration is missing the OAuth client secret parameter, which is required for OAuth authentication. According to the OAuth configuration documentation in content/env-variables.md (line 89) and the example in content/web-app-config.md (line 99), OAUTH_CLIENT_SECRET is a necessary parameter. Add a line for "OAuth client secret" (or "OAuth secret" to match the UI naming) after the OAuth client line.
| - **OAuth client**: Your Keycloak client ID | |
| - **OAuth client**: Your Keycloak client ID | |
| - **OAuth secret**: Your Keycloak client secret |
content/admin/auth.md
Outdated
| - **OAuth token endpoint**: `https://keycloak.company.com/realms/your-realm/protocol/openid-connect/token` | ||
| - **OAuth logout endpoint**: `https://keycloak.company.com/realms/your-realm/protocol/openid-connect/logout` | ||
| - **OAuth client**: Your Keycloak client ID | ||
| - **OAuth login field**: preferred_username |
There was a problem hiding this comment.
Consider documenting the OAuth scope parameter, which is mentioned in the environment variables documentation (content/env-variables.md line 92) and shown in the Keycloak example in content/web-app-config.md line 101 with value "email". While it may have a default value, explicitly documenting it would provide complete configuration guidance.
| - **OAuth login field**: preferred_username | |
| - **OAuth login field**: preferred_username | |
| - **OAuth scope**: email |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://ambitious-pebble-0eed14903-1.westeurope.6.azurestaticapps.net |
2 participants
No description provided.