Temporal UI Server 镜像文档

镜像概述和主要用途

Temporal UI Server镜像是用于部署Temporal Web UI的专用镜像。虽然Temporal CLI开发服务器包含内置Web UI，但大多数可扩展的Temporal Server部署通常不包含该UI，因为用户可能需要将Web UI部署在独立主机上。本镜像提供了独立部署Temporal Web UI的能力，适用于生产环境和规模化部署场景。

核心功能和特性

• 独立部署能力：可与Temporal Server分离部署，提高系统架构灵活性
• 完整Web UI功能：提供Temporal工作流、活动、命名空间等核心资源的可视化管理界面
• 灵活配置选项：通过环境变量支持多维度配置，包括网络端口、认证授权、UI行为控制等
• 安全增强：支持OIDC认证和TLS加密通信
• 自定义能力：支持自定义横幅文本、默认命名空间、反馈链接等UI元素
• API可用性：即使禁用UI展示，仍保持API服务可用，支持集成第三方系统

使用场景和适用范围

• 生产环境部署：适用于需要将Web UI与Temporal Server分离部署的生产环境
• 可扩展架构：满足大规模Temporal集群的Web UI独立扩展需求
• 多团队协作：为不同团队提供独立的Web UI访问端点
• 安全合规场景：需要严格控制Web UI访问权限的企业级部署
• 定制化需求：需要自定义UI展示内容或行为的场景

详细的使用方法和配置说明

基本部署方法

1. 使用docker run部署

docker run -d \
  --name temporal-ui \
  -p 8080:8080 \
  -e TEMPORAL_ADDRESS=your-temporal-frontend:7233 \
  -e TEMPORAL_DEFAULT_NAMESPACE=production \
  -e TEMPORAL_BANNER_TEXT="Production Environment - Temporal UI" \
  temporalio/ui:latest

2. Docker Compose配置示例

version: '3.8'

services:
  temporal-ui:
    image: temporalio/ui:latest
    container_name: temporal-ui
    ports:
      - "8080:8080"
    environment:
      TEMPORAL_ADDRESS: "temporal-frontend:7233"       # Temporal前端服务地址
      TEMPORAL_UI_PORT: "8080"                          # UI服务端口
      TEMPORAL_DEFAULT_NAMESPACE: "default"             # 默认命名空间
      TEMPORAL_BANNER_TEXT: "Production Temporal Cluster" # UI顶部横幅文本
      TEMPORAL_AUTH_ENABLED: "false"                    # 是否启用认证
      TEMPORAL_TLS_ENABLE_HOST_VERIFICATION: "true"     # 是否启用TLS主机验证
    networks:
      - temporal-network
    restart: unless-stopped

networks:
  temporal-network:
    driver: bridge

3. 部署注意事项

• 确保UI容器能够网络访问Temporal前端服务（通过TEMPORAL_ADDRESS指定）
• 生产环境建议启用TLS加密（配置TEMPORAL_TLS_CA、TEMPORAL_TLS_CERT和TEMPORAL_TLS_KEY）
• 如需启用认证，需正确配置OIDC相关参数（TEMPORAL_AUTH_*系列变量）
• 端口映射需根据实际需求调整，确保宿主机端口未被占用

配置参数（环境变量）