ui-server serves an HTTP API analogue of Temporal gRPC API as well as serves Temporal UI https://github.com/temporalio/ui. It can be compiled into a binary or consumed as a Go library.
ui-server is published on Docker Hub: https://hub.docker.com/r/temporalio/ui
You can run it with Temporal Server using the Temporal docker-compose.
- When running ui-server as a docker image, you can pass docker env variables to configure auth, TLS and other options. See quickstart for production. For all options refer to Dockerize config template
- Alternatively you can pass a .yaml configuration file based on the Dockerize template . Ex development.yml config
Pre-requirements:
- Go v1.18 or later installed on your development machine
- Protobuf installed on your development machine (
brew install protobuf) (Note: M1 macs will need/opt/homebrew/binon the PATH or you may get/bin/sh: protoc: command not founderrors (or you can manually download protoc))
Execute from the project folder to build a binary:
make build-serverTo start the server, execute
./ui-server start
- Open http://localhost:8080/ in the browser to explore the UI
- Open http://localhost:8080/openapi/ in the browser to explore HTTP API
In VSCode launch "Debug Server" script (or press F5)