Skip to main content
Version: 8.5

Configuration

note

Console Self-Managed is available only to Enterprise customers.

Console Self-Managed can be configured using environment variables and configuration parameters.

note

Underscores in environment variables correspond to configuration file key levels.

Environment variables

Environment variableDescriptionExample value
KEYCLOAK_BASE_URLBase URL for Keycloakhttps://example.com/auth
KEYCLOAK_INTERNAL_BASE_URLInternal Base URL for Keycloakhttp://camunda-platform-keycloak:80/auth
KEYCLOAK_REALMRealm for Keycloakcamunda-platform
CAMUNDA_IDENTITY_AUDIENCEAudience for Console clientconsole
CAMUNDA_IDENTITY_CLIENT_IDClient Id for Console clientconsole
CAMUNDA_CONSOLE_CONTEXT_PATHContext path for Consoleconsole
CAMUNDA_CONSOLE_CUSTOMERIDUnique identifier of the customercustomer-id
CAMUNDA_CONSOLE_INSTALLATIONIDUnique installation id of the current customer installationinstallation-id
CAMUNDA_CONSOLE_TELEMETRYTelemetry config for Console Self-Managed: disabled, online or downloadonline

Console environment variables could be set in Helm via the console.env key. For more details, check Console Helm values.

Telemetry

You can enable telemetry and usage collection to help us improve our product by sending several telemetry metrics to Camunda. The information we collect will contribute to continuous product enhancement and help us understand how Camunda is used. We do not collect sensitive information and limit data points to several metrics. For more information, you can download collected data set metrics from the telemetry page at anytime.

By enabling data collection and reporting, you can get a new page to introspect Camunda 8 component metrics. Usually accessible via monitoring tools like Prometheus, you can now access these metrics directly in Console. By default, telemetry collection is disabled and no data is collected. When CAMUNDA_CONSOLE_TELEMETRY env var or telemetry parameter is set to online, the telemetry feature is activated and the collected data is sent once every 24 hours via HTTPS. When CAMUNDA_CONSOLE_TELEMETRY env var or telemetry parameter is set to download, the telemetry feature is activated. Data collected will not be sent to Camuda automatically, but could be downloaded from Console and shared with us on request.

To enable usage collection, configure the parameters described in the next section.

Configuration parameters

To enable telemetry, the following parameters need to be configured. Camunda will provide you with the customer ID (Camunda Docker username) needed to send telemetry data to Camunda.

ParameterDescriptionExample value
customerIdUnique identifier of the customer. This is also a Camunda Docker registry user namecustomername
installationIdUnique installation id of the current customer installationmy-deployment
telemetryTelemetry config for Console Self-Managed: disabled, online or downloadonline

Console environment variables could be set in Helm. For more details, check Console Helm values. For example:

console:
env:
- name: CAMUNDA_CONSOLE_CUSTOMERID
values: customername
- name: CAMUNDA_CONSOLE_INSTALLATIONID
values: my-deployment
- name: CAMUNDA_CONSOLE_TELEMETRY
value: online

Monitoring

To help understand how Console operates, we expose the following endpoints by default:

EndpointPortPath
Metrics endpoint with default Prometheus metrics9100/prometheus
Readiness probe9100/health/readiness
Liveness probe9100/health/liveness

Troubleshooting

ProblemSolution
Invalid parameter: redirect_uriEnsure the correct redirect URL is configured for the application Console in Identity. The redirect URL must match the Console URL.
JWKS for authentication is not reachableTo verify a user's access token the JWKS needs to be reachable. Make sure the environment variable KEYCLOAK_INTERNAL_BASE_URL is set correctly.
Console shows error 401Make sure the logged-in user has the role Console assigned in the Identity service.