Skip to content

Commit d17aa81

Browse files
committed
docs: add server configuration information
1 parent 50305f5 commit d17aa81

1 file changed

Lines changed: 16 additions & 1 deletion

File tree

oci/temporal-ui/documentation.yaml

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,21 @@ application: temporal-ui
33
description: >
44
The Temporal UI provides a browser-based user interface for Temporal, allowing users to view Workflow Execution
55
state, metadata, and debug their Temporal applications.
6+
7+
#### Temporal UI Server Configuration
8+
9+
Temporal UI server must be provided with a configuration file to start up successfully. We do not include any default configurations in the image. Instead, we expect the user to either add a configuration file in the deployed container or mount a volume with the config file in the container.
10+
11+
Some development configuration files can be found in [the temporal ui repository](https://github.com/temporalio/ui/tree/main/server/config).
12+
13+
The following outlines steps to mount the development configuration files while launching a container:
14+
15+
```sh
16+
$ git clone https://github.com/temporalio/ui
17+
18+
$ docker run -d --name temporal-ui-container -p 8081:8081 -v ./ui/server/config:/home/ui-server/config -e TEMPORAL_ROOT=/home/ui-server -e TEMPORAL_ENVIRONMENT=development ubuntu/temporal-ui:2.39.0-24.04_edge
19+
```
20+
621
website: https://github.com/temporalio/ui
722
issues: https://github.com/canonical/temporal-rocks/issues
823
source-code: https://github.com/canonical/temporal-rocks
@@ -19,7 +34,7 @@ config:
1934
description: Root directory of execution environment.
2035
TEMPORAL_CONFIG_DIR:
2136
type: env
22-
description: Config directory path relative to `TMEMPORAL_ROOT`.
37+
description: Config directory path relative to `TEMPORAL_ROOT`.
2338
TEMPORAL_ENVIRONMENT:
2439
type: env
2540
description: Runtime environment.

0 commit comments

Comments
 (0)