From 31e865d88ed012721a72108678a26cd20afb9d46 Mon Sep 17 00:00:00 2001 From: Xiaotian Jin Date: Fri, 14 Mar 2025 17:20:23 +0300 Subject: [PATCH 1/3] update Readme: add pre-built option in running with docker --- README.md | 31 +++++++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index db2e5d0..ddf6021 100644 --- a/README.md +++ b/README.md @@ -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 From 1d721f28adf08e86fa5e78da9bb3a4ea9d17155d Mon Sep 17 00:00:00 2001 From: Xiaotian Jin Date: Fri, 14 Mar 2025 17:37:48 +0300 Subject: [PATCH 2/3] add image in docker-compose.yml --- .container/docker-compose.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.container/docker-compose.yml b/.container/docker-compose.yml index 21048d4..0f6762c 100644 --- a/.container/docker-compose.yml +++ b/.container/docker-compose.yml @@ -1,5 +1,6 @@ services: owl: + image: mugglejinx/owl:latest build: context: .. dockerfile: .container/Dockerfile From 31950a41a2d26aa456d8a31d45fc208b804d4ce0 Mon Sep 17 00:00:00 2001 From: Xiaotian Jin Date: Sat, 15 Mar 2025 11:18:35 +0300 Subject: [PATCH 3/3] fix Dockerfile, update readme --- .container/Dockerfile | 3 ++- .container/docker-compose.yml | 11 ++++++++--- README.md | 8 +++----- 3 files changed, 13 insertions(+), 9 deletions(-) diff --git a/.container/Dockerfile b/.container/Dockerfile index 7054876..2393ed9 100644 --- a/.container/Dockerfile +++ b/.container/Dockerfile @@ -15,13 +15,14 @@ WORKDIR /app # 安装系统依赖（合并为一个RUN命令减少层数） RUN apt-get update && apt-get install -y --no-install-recommends \ curl git ffmpeg libsm6 libxext6 xvfb xauth x11-utils \ - gcc python3-dev \ + build-essential python3-dev \ && apt-get clean \ && rm -rf /var/lib/apt/lists/* # 复制项目文件 COPY owl/ ./owl/ COPY licenses/ ./licenses/ COPY assets/ ./assets/ +COPY examples/ ./examples/ COPY README.md . COPY README_zh.md . COPY pyproject.toml . diff --git a/.container/docker-compose.yml b/.container/docker-compose.yml index 0f6762c..e099627 100644 --- a/.container/docker-compose.yml +++ b/.container/docker-compose.yml @@ -1,9 +1,14 @@ services: owl: + # Option 1: Use pre-built image from Docker Hub image: mugglejinx/owl:latest - build: - context: .. - dockerfile: .container/Dockerfile + + # Option 2: Build image locally + # Uncomment the following lines and comment out the 'image' line above to build locally + # build: + # context: .. + # dockerfile: .container/Dockerfile + volumes: # 挂载.env文件，方便配置API密钥 - ../owl/.env:/app/owl/.env diff --git a/README.md b/README.md index ddf6021..89e93db 100644 --- a/README.md +++ b/README.md @@ -278,10 +278,8 @@ 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 2: Using docker-compose directly +# Option 1: Using docker-compose directly +# (By default it's using pre-built online image, you can also check the docker-compose.yml for building locally) cd .container docker-compose up -d @@ -297,7 +295,7 @@ playwright install-deps #run example demo script xvfb-python examples/run.py -# Option 3: Build and run using the provided scripts +# Option 2: Build and run using the provided scripts cd .container chmod +x build_docker.sh ./build_docker.sh