update Readme: add pre-built option in running with docker

This commit is contained in:
Xiaotian Jin
2025-03-14 17:20:23 +03:00
parent f152f02133
commit 31e865d88e

View File

@@ -64,16 +64,32 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas
- [📋 Table of Contents](#-table-of-contents)
- [🔥 News](#-news)
- [🎬 Demo Video](#-demo-video)
- [✨️ Core Features](#-core-features)
- [✨️ Core Features](#-core-features)
- [🛠️ Installation](#-installation)
- [**Clone the Github repository**](#clone-the-github-repository)
- [**Set up Environment**](#set-up-environment)
- [**Install Dependencies**](#install-dependencies)
- [Option 1: Using uv (Recommended)](#option-1-using-uv-recommended)
- [Option 2: Using venv and pip](#option-2-using-venv-and-pip)
- [Option 3: Using conda](#option-3-using-conda)
- [**Setup Environment Variables**](#setup-environment-variables)
- [Option 1: Using a `.env` File (Recommended)](#option-1-using-a-env-file-recommended)
- [Option 2: Setting Environment Variables Directly](#option-2-setting-environment-variables-directly)
- [**Running with Docker**](#running-with-docker)
- [🚀 Quick Start](#-quick-start)
- [Try MCP (Model Context Protocol) Integration](#try-mcp-model-context-protocol-integration)
- [Basic Usage](#basic-usage)
- [Running with Different Models](#running-with-different-models)
- [Model Requirements](#model-requirements)
- [Supported Models](#supported-models)
- [Example Tasks](#example-tasks)
- [🧰 Toolkits and Capabilities](#-toolkits-and-capabilities)
- [Model Context Protocol (MCP)](#model-context-protocol-mcp)
- [Available Toolkits](#available-toolkits)
- [Available Toolkits](#available-toolkits-1)
- [Multimodal Toolkits (Require multimodal model capabilities)](#multimodal-toolkits-require-multimodal-model-capabilities)
- [Text-Based Toolkits](#text-based-toolkits)
- [Customizing Your Configuration](#customizing-your-configuration)
- [🌐 Web Interface](#-web-interface)
- [Starting the Web UI](#starting-the-web-ui)
- [Features](#features)
- [🧪 Experiments](#-experiments)
- [⏱️ Future Plans](#-future-plans)
- [📄 License](#-license)
@@ -82,6 +98,7 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas
- [🔥 Community](#-community)
- [❓ FAQ](#-faq)
- [📚 Exploring CAMEL Dependency](#-exploring-camel-dependency)
- [Accessing CAMEL Source Code](#accessing-camel-source-code)
- [⭐ Star History](#-star-history)
@@ -261,8 +278,10 @@ cd owl
cp owl/.env_template owl/.env
# Edit the .env file and fill in your API keys
# Option 1: Using pre-built docker image
docker run -it --rm --env-file owl/.env mugglejinx/owl
# Option 1: Using docker-compose directly
# Option 2: Using docker-compose directly
cd .container
docker-compose up -d
@@ -278,7 +297,7 @@ playwright install-deps
#run example demo script
xvfb-python examples/run.py
# Option 2: Build and run using the provided scripts
# Option 3: Build and run using the provided scripts
cd .container
chmod +x build_docker.sh
./build_docker.sh