The TensorZero UI is a self-hosted web application that streamlines the use of TensorZero with features like observability and optimization. It’s easy to get started with the TensorZero UI.

​
Deploy

1

Configure the TensorZero Gateway

Deploy the TensorZero Gateway and configure TENSORZERO_GATEWAY_URL.For example, if the gateway is running locally, you can set TENSORZERO_GATEWAY_URL=http://localhost:3000.
2

Configure ClickHouse

Deploy ClickHouse and configure TENSORZERO_CLICKHOUSE_URL.
3

Configure model provider credentials

The TensorZero UI integrates with model providers like OpenAI to streamline workflows like fine-tuning. To use these features, you need to provide credentials for the relevant model providers as environment variables. You don’t need to provide credentials if you’re not using the fine-tuning features for those providers.The supported fine-tuning providers and their required credentials (environment variables) are:
ProviderRequired Credentials
Fireworks AIFIREWORKS_ACCOUNT_ID FIREWORKS_API_KEY
GCP VertexGCP account credentials
OpenAIOPENAI_API_KEY
Together AITOGETHER_API_KEY
4

Deploy the TensorZero UI

The TensorZero UI is available on Docker Hub as tensorzero/ui.
You can easily run the TensorZero UI using Docker Compose:
services:
  ui:
    image: tensorzero/ui
    # Mount your configuration folder (e.g. tensorzero.toml) to /app/config
    volumes:
      - ./config:/app/config:ro
    # Add your environment variables the .env file
    env_file:
      - ${ENV_FILE:-.env}
    # Publish the UI to port 4000
    ports:
      - "4000:4000"
    restart: unless-stopped
Make sure to create a .env file with the relevant environment variables.For more details, see the example docker-compose.yml file in the GitHub repository.
Alternatively, you can launch the UI directly with the following command:
docker run \
    --volume ./config:/app/config:ro \
    --env-file ./.env \
    --publish 4000:4000 \
    tensorzero/ui
Make sure to create a .env file with the relevant environment variables.
We provide a reference Helm chart contributed by the community in our GitHub repository. You can use it to run TensorZero in Kubernetes.
Alternatively, you can build the UI from source. See our GitHub repository for more details.

​
Configure

​
Add a health check

The TensorZero UI exposes an endpoint for health checks. This /health endpoint checks that the UI is running, the associated configuration is valid, and the ClickHouse connection is healthy.

​
Customize the deployment

The TensorZero UI supports the following optional environment variables. You can set TENSORZERO_UI_CONFIG_PATH to a custom path to the TensorZero configuration file. When using the official Docker image, this value defaults to /app/config/tensorzero.toml. For certain uncommon scenarios (e.g. IPv6), you can also customize HOST inside the UI container. See the Vite documentation for more details.