ui

package
v0.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 26, 2026 License: AGPL-3.0 Imports: 11 Imported by: 0

Documentation

Overview

Package ui embeds the Temporal Web UI (temporalio/ui-server) in fallbck-server.

ui-server only knows how to bind its own listener, so it runs on a loopback port and fallbck-server reverse-proxies it under PublicPath behind admin authentication.

Index

Constants

View Source
const DefaultPort = 8233

DefaultPort is the loopback port of the UI server

View Source
const PublicPath = "/temporal"

PublicPath is the path prefix the UI is served under on the public port

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

type Config struct {
	// BindIP and Port are the loopback listener (default 127.0.0.1:8233)
	BindIP string
	Port   int
	// TemporalAddr is the frontend host:port the UI talks to
	TemporalAddr string
	// TLS is nil for a plaintext (embedded, loopback) frontend
	TLS *TLS
	// Namespace pre-selected in the UI
	Namespace string
}

Config for the embedded UI

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server is a running UI server

func Start

func Start(ctx context.Context, cfg Config, logger *slog.Logger) (_ *Server, err error)

Start launches the UI server and waits until it answers

func (*Server) Addr

func (s *Server) Addr() string

Addr is the loopback address the UI listens on (host:port)

func (*Server) Stop

func (s *Server) Stop()

Stop shuts the UI server down

type TLS

type TLS struct {
	CAFile             string
	CertFile           string
	KeyFile            string
	ServerName         string
	InsecureSkipVerify bool
}

TLS configures the UI server's client connection to a TLS-enabled Temporal frontend

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL