Skip to content

docs: Add comprehensive Keycloak configuration guide for Canton Valid…#2247

Merged
martinflorian-da merged 1 commit intohyperledger-labs:mainfrom
mikeProDev:feature/add-community-guide-keycloak
Sep 15, 2025
Merged

docs: Add comprehensive Keycloak configuration guide for Canton Valid…#2247
martinflorian-da merged 1 commit intohyperledger-labs:mainfrom
mikeProDev:feature/add-community-guide-keycloak

Conversation

@mikeProDev
Copy link
Contributor

…ator

Adds new community guide 'Complete Keycloak Configuration Guide for Canton Validator' with detailed step-by-step instructions for setting up Keycloak as an OIDC provider for validator node deployments.

The guide covers:

  • Realm and session configuration
  • Client scopes setup (daml_ledger_api, openid)
  • Multiple client configurations (ledger-api, validator-app-backend, wallet-web-ui, cns-ui)
  • User management with proper PARTY_HINT username matching
  • Environment variable configuration for validator applications
  • Validation testing and troubleshooting steps

Pull Request Checklist

Cluster Testing

  • If a cluster test is required, comment /cluster_test on this PR to request it, and ping someone with access to the DA-internal system to approve it.
  • If a hard-migration test is required (from the latest release), comment /hdm_test on this PR to request it, and ping someone with access to the DA-internal system to approve it.

PR Guidelines

  • Include any change that might be observable by our partners or affect their deployment in the release notes.
  • Specify fixed issues with Fixes #n, and mention issues worked on using #n
  • Include a screenshot for frontend-related PRs - see README or use your favorite screenshot tool

Merge Guidelines

  • Make the git commit message look sensible when squash-merging on GitHub (most likely: just copy your PR description).

…ator

Adds new community guide 'Complete Keycloak Configuration Guide for Canton Validator'
with detailed step-by-step instructions for setting up Keycloak as an OIDC provider
for validator node deployments.

The guide covers:
- Realm and session configuration
- Client scopes setup (daml_ledger_api, openid)
- Multiple client configurations (ledger-api, validator-app-backend, wallet-web-ui, cns-ui)
- User management with proper PARTY_HINT username matching
- Environment variable configuration for validator applications
- Validation testing and troubleshooting steps

Signed-off-by: mikeProDev <70226984+mikeProDev@users.noreply.github.com>
@martinflorian-da martinflorian-da added the static Used to label PRs for which static tests suffice label Sep 15, 2025
@martinflorian-da
Copy link
Contributor

Nice, thank you @mikeProDev ! Do you want to add a note about this to the release notes before I click merge? We can also follow up on that after we merge.

@mikeProDev
Copy link
Contributor Author

No, I don't have anything to add

Copy link
Contributor

@martinflorian-da martinflorian-da left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@martinflorian-da martinflorian-da merged commit 7e8c86e into hyperledger-labs:main Sep 15, 2025
40 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

static Used to label PRs for which static tests suffice

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants