Skip to content

README.md

Latest commit

 

History

History
84 lines (58 loc) · 1.86 KB

README.md

File metadata and controls

84 lines (58 loc) · 1.86 KB

Docker Deployment Guide

This guide explains how to deploy the Youtu-agent service with its frontend using Docker.

Prerequisites

  • Docker installed on your system
    • Visit https://www.docker.com/ to download and install Docker if needed
    • Verify your installation by running docker --version

Deployment Steps

Step 1. Clone the Repository

Execute the command below to clone the project repository:

git clone https://github.com/Tencent/youtu-agent.git

Step 2. Build the Docker Image

Build the Youtu-agent Docker image.

Note: The Dockerfile is located in the docker/ directory.

cd youtu-agent/docker
docker build -t youtu-agent .

Step 3. Configure the Environment

  1. Create a configuration file by copying the template:
cp .env.docker.example .env
  1. Configure the following required variables in .env:
# LLM Configuration (required)
UTU_LLM_TYPE=chat.completions
UTU_LLM_MODEL=deepseek-chat
UTU_LLM_BASE_URL=https://api.deepseek.com/v1
UTU_LLM_API_KEY=<your-api-key> # Required

# Serper API Configuration
# Get your key from https://serper.dev/playground
SERPER_API_KEY=<your-serper-key>

# Frontend Configuration
# Note: IP must be 0.0.0.0 for Docker container port forwarding
UTU_WEBUI_PORT=8848
UTU_WEBUI_IP=0.0.0.0

Step 4. Launch the Service

Option 1: Run the Default Web Search Agent Demo

Replace /path/to/your/.env with the actual path to your .env file, then run:

docker run -it \
    -p 8848:8848 \
    -v "/path/to/your/.env:/youtu-agent/.env" \
    youtu-agent

The service will be accessible at http://127.0.0.1:8848

Option 2: Interactive Shell Access

To run other examples or custom configurations by replacing the /path/to/your/.env:

docker run -it \
    -p 8848:8848 \
    -v "/path/to/your/.env:/youtu-agent/.env" \
    youtu-agent \
    bash