Skip to main content
Version: june-2022

Temporal Web UI configuration reference

The Temporal Web UI Server uses a configuration file for many of the UI's settings.

An example development.yaml file can be found in the temporalio/ui-server repo.

enableUi

Enables the browser UI. If disabled—that is, set to false—the UI server APIs remain available.

enableUi: true

enableOpenApi

Enables the UI Server's Open API reference documentation at /openapi/. For example, if you are currently viewing the Web UI at http://localhost:8080, the page is available at localhost:8080/openapi/.

enableOpenApi: true

cors

The name of the cors field stands for Cross-Origin Resource Sharing. Use this field to provide a list of domains that are authorized to access the UI Server APIs.```

cors:
allowOrigins:
- http://localhost:3000 # used at development by https://github.com/temporalio/ui

refreshInterval

How often the configuration UI Server reads the configuration file for new values. Currently, only tls configuration values are propagated during a refresh.

refreshInterval: 1m

defaultNamespace

The default Namespace that the UI loads data for. Defaults to default.

defaultNamespace: default

showTemporalSystemNamespace

When enabled—that is, when set to true—the Temporal System Namespace becomes visible in the UI. The Temporal System Namespace lists Workflow Executions used by the Temporal Platform.

showTemporalSystemNamespace: false

feedbackUrl

The URL to direct users to when they click on the Feedback button in the UI. If not specified, it defaults to the UI's GitHub Issue page.

feedbackUrl: https://github.com/temporalio/ui/issues/new/choose

notifyOnNewVersion

When enabled—that is, when set to true—a notification appears in the UI when a newer version of the Temporal Server is available.

notifyOnNewVersion: true

auth

Auth configuration.

auth:
enabled: false
providers:
- label: Auth0 oidc # for internal use; in future may expose as button text
type: oidc # for futureproofing; only oidc is supported today
providerUrl: https://myorg.us.auth0.com/
clientId: xxxxxxxxxxxxxxxxxxxx
clientSecret: xxxxxxxxxxxxxxxxxxxx
scopes:
- openid
- profile
- email
callbackUrl: http://localhost:8080/auth/sso/callback
passIdToken: false
options: # added as URL query params when redirecting to auth provider
audience: myorg-dev
organization: org_xxxxxxxxxxxx
invitation:

tls

Transport Layer Security (TLS) configuration.

tls:
caFile:
certFile:
keyFile:
caData:
certData:
keyData:
enableHostVerification: false
serverName:

codec

Codec Server configuration.

codec:
endpoint: http://your-codec-server-endpoint
passAccessToken: false