diff --git a/charts/centralidp/README.md b/charts/centralidp/README.md index d98b2c23..f756634a 100644 --- a/charts/centralidp/README.md +++ b/charts/centralidp/README.md @@ -115,3 +115,17 @@ dependencies: | secrets.postgresql.auth.existingSecret.password | string | `""` | Password for the non-root username 'kccentral'. Secret-key 'password'. | | secrets.postgresql.auth.existingSecret.replicationPassword | string | `""` | Password for the non-root username 'repl_user'. Secret-key 'replication-password'. | +Autogenerated with [helm docs](https://github.com/norwoodj/helm-docs) + +## Post-Install Configuration + +Once the installation is completed, the following steps need to be executed in the Keycloak admin console within CX-Central realm: + +1. Generate Client-Secrets for confidential clients and service accounts with access type 'confidential'. + +2. Establish connection to the sharedidp instance + +In order to enable the login of the initial user (see CX-Operator realm in sharedidp instance for username), the connection between the 'CX-Operator' identity provider of the centralidp instance and the according realm in the sharedidp instance needs to be established. +This is done by setting the 'example.org' placeholder in the CX-Operator' Identity Provider to the address of the sharedidp instance. + +3. Setup SMTP configuration (Realm Settings --> Email) diff --git a/charts/centralidp/README.md.gotmpl b/charts/centralidp/README.md.gotmpl index 812f40b2..604bea55 100644 --- a/charts/centralidp/README.md.gotmpl +++ b/charts/centralidp/README.md.gotmpl @@ -36,4 +36,17 @@ dependencies: {{ template "chart.valuesSection" . }} -{{ template "helm-docs.versionFooter" . }} +Autogenerated with [helm docs](https://github.com/norwoodj/helm-docs) + +## Post-Install Configuration + +Once the installation is completed, the following steps need to be executed in the Keycloak admin console within CX-Central realm: + +1. Generate Client-Secrets for confidential clients and service accounts with access type 'confidential'. + +2. Establish connection to the sharedidp instance + +In order to enable the login of the initial user (see CX-Operator realm in sharedidp instance for username), the connection between the 'CX-Operator' identity provider of the centralidp instance and the according realm in the sharedidp instance needs to be established. +This is done by setting the 'example.org' placeholder in the CX-Operator' Identity Provider to the address of the sharedidp instance. + +3. Setup SMTP configuration (Realm Settings --> Email) diff --git a/charts/sharedidp/README.md b/charts/sharedidp/README.md index e1fb8ae7..5b654b29 100644 --- a/charts/sharedidp/README.md +++ b/charts/sharedidp/README.md @@ -122,3 +122,25 @@ dependencies: | secrets.postgresql.auth.existingSecret.replicationPassword | string | `""` | Password for the non-root username 'repl_user'. Secret-key 'replication-password'. | | secrets.realmuser.enabled | bool | `false` | | +Autogenerated with [helm docs](https://github.com/norwoodj/helm-docs) + +## Post-Install Configuration + +Once the installation is completed, the following steps need to be executed in the Keycloak admin console: + +### Within the master realm: + +Generate client-secrets for the service account with access type 'confidential'. + +### Within the CX-Operator realm: + +#### Establish connection to the centralidp instance: + +1. Change the example.org placeholder in the central-idp client the to the address of the centralidp instance: + +* Settings --> Valid Redirect URI +* Keys --> JWKS URL + +2. Set password and user details for the initial user. + +3. Setup SMTP configuration (Realm Settings --> Email) diff --git a/charts/sharedidp/README.md.gotmpl b/charts/sharedidp/README.md.gotmpl index 812f40b2..add6fc32 100644 --- a/charts/sharedidp/README.md.gotmpl +++ b/charts/sharedidp/README.md.gotmpl @@ -36,4 +36,25 @@ dependencies: {{ template "chart.valuesSection" . }} -{{ template "helm-docs.versionFooter" . }} +Autogenerated with [helm docs](https://github.com/norwoodj/helm-docs) + +## Post-Install Configuration + +Once the installation is completed, the following steps need to be executed in the Keycloak admin console: + +### Within the master realm: + +Generate client-secrets for the service account with access type 'confidential'. + +### Within the CX-Operator realm: + +#### Establish connection to the centralidp instance: + +1. Change the example.org placeholder in the central-idp client the to the address of the centralidp instance: + +* Settings --> Valid Redirect URI +* Keys --> JWKS URL + +2. Set password and user details for the initial user. + +3. Setup SMTP configuration (Realm Settings --> Email)