@@ -66,29 +66,10 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas
6666- [ 🎬 Demo Video] ( #-demo-video )
6767- [ ✨️ Core Features] ( #️-core-features )
6868- [ 🛠️ 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 )
7669- [ 🚀 Quick Start] ( #-quick-start )
77- - [ Basic Usage] ( #basic-usage )
78- - [ Running with Different Models] ( #running-with-different-models )
79- - [ Model Requirements] ( #model-requirements )
80- - [ Supported Models] ( #supported-models )
81- - [ Example Tasks] ( #example-tasks )
8270- [ 🧰 Toolkits and Capabilities] ( #-toolkits-and-capabilities )
8371 - [ Model Context Protocol (MCP)] ( #model-context-protocol-mcp )
84- - [ Available Toolkits] ( #available-toolkits )
85- - [ Available Toolkits] ( #available-toolkits-1 )
86- - [ Multimodal Toolkits (Require multimodal model capabilities)] ( #multimodal-toolkits-require-multimodal-model-capabilities )
87- - [ Text-Based Toolkits] ( #text-based-toolkits )
88- - [ Customizing Your Configuration] ( #customizing-your-configuration )
8972- [ 🌐 Web Interface] ( #-web-interface )
90- - [ Starting the Web UI] ( #starting-the-web-ui )
91- - [ Features] ( #features )
9273- [ 🧪 Experiments] ( #-experiments )
9374- [ ⏱️ Future Plans] ( #️-future-plans )
9475- [ 📄 License] ( #-license )
@@ -97,7 +78,6 @@ Our vision is to revolutionize how AI agents collaborate to solve real-world tas
9778- [ 🔥 Community] ( #-community )
9879- [ ❓ FAQ] ( #-faq )
9980- [ 📚 Exploring CAMEL Dependency] ( #-exploring-camel-dependency )
100- - [ Accessing CAMEL Source Code] ( #accessing-camel-source-code )
10181- [ ⭐ Star History] ( #-star-history )
10282
10383# 🔥 News
@@ -280,6 +260,10 @@ Alternatively, you can set environment variables directly in your terminal:
280260
281261## ** Running with Docker**
282262
263+ OWL can be easily deployed using Docker, which provides a consistent environment across different platforms.
264+
265+ ### ** Setup Instructions**
266+
283267``` bash
284268# Clone the repository
285269git clone https://github.com/camel-ai/owl.git
@@ -288,41 +272,63 @@ cd owl
288272# Configure environment variables
289273cp owl/.env_template owl/.env
290274# Edit the .env file and fill in your API keys
275+ ```
276+
277+ ### ** Deployment Options**
291278
292- # Option 1: Using docker-compose directly
293- # Docker image options:
294- # Option 1: Use pre-built image from Docker Hub (default, faster)
295- # This option downloads a ready-to-use image and is recommended for most users
279+ #### ** Option 1: Using Pre-built Image (Recommended)**
280+
281+ ``` bash
282+ # This option downloads a ready-to-use image from Docker Hub
283+ # Fastest and recommended for most users
296284docker-compose up -d
297285
298- # Option 2: Build image locally (more customizable)
299- # If you need to customize the Docker image or are unable to access Docker Hub:
286+ # Run OWL inside the container
287+ docker-compose exec owl bash
288+ cd .. && source .venv/bin/activate
289+ playwright install-deps
290+ xvfb-python examples/run.py
291+ ```
292+
293+ #### ** Option 2: Building Image Locally**
294+
295+ ``` bash
296+ # For users who need to customize the Docker image or cannot access Docker Hub:
300297# 1. Open docker-compose.yml
301298# 2. Comment out the "image: mugglejinx/owl:latest" line
302299# 3. Uncomment the "build:" section and its nested properties
303300# 4. Then run:
304301docker-compose up -d --build
305- cd .container
306302
307303# Run OWL inside the container
308304docker-compose exec owl bash
309-
310- # activate the virtual environment
311305cd .. && source .venv/bin/activate
312-
313- playwright install-deps
314-
315- # run example demo script
306+ playwright install-deps
316307xvfb-python examples/run.py
308+ ```
317309
318- # Option 3: Build and run using the provided scripts
310+ #### ** Option 3: Using Convenience Scripts**
311+
312+ ``` bash
313+ # Navigate to container directory
319314cd .container
315+
316+ # Make the script executable and build the Docker image
320317chmod +x build_docker.sh
321318./build_docker.sh
322- # Run OWL inside the container
319+
320+ # Run OWL with your question
323321./run_in_docker.sh " your question"
324322```
325323
324+ ### ** MCP Desktop Commander Setup**
325+
326+ If using MCP Desktop Commander within Docker, run:
327+
328+ ``` bash
329+ npx -y @wonderwhy-er/desktop-commander setup --force-file-protocol
330+ ```
331+
326332For more detailed Docker usage instructions, including cross-platform support, optimized configurations, and troubleshooting, please refer to [ DOCKER_README.md] ( .container/DOCKER_README_en.md ) .
327333
328334# 🚀 Quick Start
0 commit comments