Docs: Add Docker option - running pre-built image. (#300)
Browse files- .container/Dockerfile +2 -1
- .container/docker-compose.yml +9 -3
- README.md +22 -5
.container/Dockerfile
CHANGED
@@ -15,13 +15,14 @@ WORKDIR /app
|
|
15 |
# 安装系统依赖(合并为一个RUN命令减少层数)
|
16 |
RUN apt-get update && apt-get install -y --no-install-recommends \
|
17 |
curl git ffmpeg libsm6 libxext6 xvfb xauth x11-utils \
|
18 |
-
|
19 |
&& apt-get clean \
|
20 |
&& rm -rf /var/lib/apt/lists/*
|
21 |
# 复制项目文件
|
22 |
COPY owl/ ./owl/
|
23 |
COPY licenses/ ./licenses/
|
24 |
COPY assets/ ./assets/
|
|
|
25 |
COPY README.md .
|
26 |
COPY README_zh.md .
|
27 |
COPY pyproject.toml .
|
|
|
15 |
# 安装系统依赖(合并为一个RUN命令减少层数)
|
16 |
RUN apt-get update && apt-get install -y --no-install-recommends \
|
17 |
curl git ffmpeg libsm6 libxext6 xvfb xauth x11-utils \
|
18 |
+
build-essential python3-dev \
|
19 |
&& apt-get clean \
|
20 |
&& rm -rf /var/lib/apt/lists/*
|
21 |
# 复制项目文件
|
22 |
COPY owl/ ./owl/
|
23 |
COPY licenses/ ./licenses/
|
24 |
COPY assets/ ./assets/
|
25 |
+
COPY examples/ ./examples/
|
26 |
COPY README.md .
|
27 |
COPY README_zh.md .
|
28 |
COPY pyproject.toml .
|
.container/docker-compose.yml
CHANGED
@@ -1,8 +1,14 @@
|
|
1 |
services:
|
2 |
owl:
|
3 |
-
|
4 |
-
|
5 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
6 |
volumes:
|
7 |
# 挂载.env文件,方便配置API密钥
|
8 |
- ../owl/.env:/app/owl/.env
|
|
|
1 |
services:
|
2 |
owl:
|
3 |
+
# Option 1: Use pre-built image from Docker Hub
|
4 |
+
image: mugglejinx/owl:latest
|
5 |
+
|
6 |
+
# Option 2: Build image locally
|
7 |
+
# Uncomment the following lines and comment out the 'image' line above to build locally
|
8 |
+
# build:
|
9 |
+
# context: ..
|
10 |
+
# dockerfile: .container/Dockerfile
|
11 |
+
|
12 |
volumes:
|
13 |
# 挂载.env文件,方便配置API密钥
|
14 |
- ../owl/.env:/app/owl/.env
|
README.md
CHANGED
@@ -64,16 +64,32 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas
|
|
64 |
- [📋 Table of Contents](#-table-of-contents)
|
65 |
- [🔥 News](#-news)
|
66 |
- [🎬 Demo Video](#-demo-video)
|
67 |
-
- [✨️ Core Features](
|
68 |
- [🛠️ Installation](#️-installation)
|
69 |
-
- [
|
70 |
-
- [
|
71 |
-
- [
|
72 |
- [**Setup Environment Variables**](#setup-environment-variables)
|
|
|
|
|
73 |
- [**Running with Docker**](#running-with-docker)
|
74 |
- [🚀 Quick Start](#-quick-start)
|
|
|
|
|
|
|
|
|
|
|
|
|
75 |
- [🧰 Toolkits and Capabilities](#-toolkits-and-capabilities)
|
|
|
|
|
|
|
|
|
|
|
|
|
76 |
- [🌐 Web Interface](#-web-interface)
|
|
|
|
|
77 |
- [🧪 Experiments](#-experiments)
|
78 |
- [⏱️ Future Plans](#️-future-plans)
|
79 |
- [📄 License](#-license)
|
@@ -82,6 +98,7 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas
|
|
82 |
- [🔥 Community](#-community)
|
83 |
- [❓ FAQ](#-faq)
|
84 |
- [📚 Exploring CAMEL Dependency](#-exploring-camel-dependency)
|
|
|
85 |
- [⭐ Star History](#-star-history)
|
86 |
|
87 |
|
@@ -261,8 +278,8 @@ cd owl
|
|
261 |
cp owl/.env_template owl/.env
|
262 |
# Edit the .env file and fill in your API keys
|
263 |
|
264 |
-
|
265 |
# Option 1: Using docker-compose directly
|
|
|
266 |
cd .container
|
267 |
|
268 |
docker-compose up -d
|
|
|
64 |
- [📋 Table of Contents](#-table-of-contents)
|
65 |
- [🔥 News](#-news)
|
66 |
- [🎬 Demo Video](#-demo-video)
|
67 |
+
- [✨️ Core Features](#️-core-features)
|
68 |
- [🛠️ Installation](#️-installation)
|
69 |
+
- [Option 1: Using uv (Recommended)](#option-1-using-uv-recommended)
|
70 |
+
- [Option 2: Using venv and pip](#option-2-using-venv-and-pip)
|
71 |
+
- [Option 3: Using conda](#option-3-using-conda)
|
72 |
- [**Setup Environment Variables**](#setup-environment-variables)
|
73 |
+
- [Option 1: Using a `.env` File (Recommended)](#option-1-using-a-env-file-recommended)
|
74 |
+
- [Option 2: Setting Environment Variables Directly](#option-2-setting-environment-variables-directly)
|
75 |
- [**Running with Docker**](#running-with-docker)
|
76 |
- [🚀 Quick Start](#-quick-start)
|
77 |
+
- [Try MCP (Model Context Protocol) Integration](#try-mcp-model-context-protocol-integration)
|
78 |
+
- [Basic Usage](#basic-usage)
|
79 |
+
- [Running with Different Models](#running-with-different-models)
|
80 |
+
- [Model Requirements](#model-requirements)
|
81 |
+
- [Supported Models](#supported-models)
|
82 |
+
- [Example Tasks](#example-tasks)
|
83 |
- [🧰 Toolkits and Capabilities](#-toolkits-and-capabilities)
|
84 |
+
- [Model Context Protocol (MCP)](#model-context-protocol-mcp)
|
85 |
+
- [Available Toolkits](#available-toolkits)
|
86 |
+
- [Available Toolkits](#available-toolkits-1)
|
87 |
+
- [Multimodal Toolkits (Require multimodal model capabilities)](#multimodal-toolkits-require-multimodal-model-capabilities)
|
88 |
+
- [Text-Based Toolkits](#text-based-toolkits)
|
89 |
+
- [Customizing Your Configuration](#customizing-your-configuration)
|
90 |
- [🌐 Web Interface](#-web-interface)
|
91 |
+
- [Starting the Web UI](#starting-the-web-ui)
|
92 |
+
- [Features](#features)
|
93 |
- [🧪 Experiments](#-experiments)
|
94 |
- [⏱️ Future Plans](#️-future-plans)
|
95 |
- [📄 License](#-license)
|
|
|
98 |
- [🔥 Community](#-community)
|
99 |
- [❓ FAQ](#-faq)
|
100 |
- [📚 Exploring CAMEL Dependency](#-exploring-camel-dependency)
|
101 |
+
- [Accessing CAMEL Source Code](#accessing-camel-source-code)
|
102 |
- [⭐ Star History](#-star-history)
|
103 |
|
104 |
|
|
|
278 |
cp owl/.env_template owl/.env
|
279 |
# Edit the .env file and fill in your API keys
|
280 |
|
|
|
281 |
# Option 1: Using docker-compose directly
|
282 |
+
# (By default it's using pre-built online image, you can also check the docker-compose.yml for building locally)
|
283 |
cd .container
|
284 |
|
285 |
docker-compose up -d
|