Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 4 additions & 14 deletions docs/references/web-ui-environment-variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,9 @@ docker run\
-e TEMPORAL_UI_PORT=8080\
-e TEMPORAL_UI_PUBLIC_PATH=path/to/webui\
-e TEMPORAL_UI_ENABLED=true\
-e TEMPORAL_BANNER_TEXT="Some banner text"\
-e TEMPORAL_CLOUD_UI=false\
-e TEMPORAL_DEFAULT_NAMESPACE=default\
-e TEMPORAL_FEEDBACK_URL=https://feedback.here\
-e TEMPORAL_NOTIFY_ON_NEW_VERSION=true\
-e TEMPORAL_CONFIG_REFRESH_INTERVAL=0s\
-e TEMPORAL_SHOW_TEMPORAL_SYSTEM_NAMESPACE=false\
-e TEMPORAL_DISABLE_WRITE_ACTIONS=false\
Expand All @@ -55,8 +53,8 @@ temporalio/ui:<tag>
```

The environment variables are defined in the
[UI server configuration template file](https://github.com/temporalio/ui-server/blob/main/config/docker.yaml)
and described in more detail below.
[UI server configuration template file](https://github.com/temporalio/ui-server/blob/main/config/docker.yaml) and
described in more detail below.

## `TEMPORAL_ADDRESS`

Expand All @@ -83,10 +81,6 @@ Enables or disables the [browser UI](/references/web-ui-configuration#enableui)
Enabling the browser UI allows the Server to be accessed from your web browser. If disabled, the server cannot be viewed
on the web, but the UI server APIs remain available for use.

## `TEMPORAL_BANNER_TEXT`

Provides banner text to display on the Web UI.

## `TEMPORAL_CLOUD_UI`

If enabled, use the alternate UI from Temporal Cloud.
Expand All @@ -101,10 +95,6 @@ The URL that users are directed to when they click the Feedback button in the UI

If not specified, this variable defaults to the UI's GitHub Issue page.

## `TEMPORAL_NOTIFY_ON_NEW_VERSION`

Enables or disables notifications that appear in the UI whenever a newer version of the Temporal Cluster is available.

## `TEMPORAL_CONFIG_REFRESH_INTERVAL`

Determines how often the UI Server reads the configuration file for new values.
Expand Down Expand Up @@ -231,8 +221,8 @@ Specifies whether to include credentials along with requests to the Codec Server

## `TEMPORAL_FORWARD_HEADERS`

Forward-specified HTTP headers to direct from HTTP API requests to the Temporal gRPC backend. This is a
comma-delimited list of the HTTP headers to be forwarded.
Forward-specified HTTP headers to direct from HTTP API requests to the Temporal gRPC backend. This is a comma-delimited
list of the HTTP headers to be forwarded.

## `TEMPORAL_HIDE_LOGS`

Expand Down