From 5c5306b219ec5268aaa8a82dcb1cc23aa9ffb436 Mon Sep 17 00:00:00 2001 From: Wendong Date: Mon, 10 Mar 2025 11:20:55 +0800 Subject: [PATCH] update readme for docker --- README.md | 16 +++++++++++----- README_zh.md | 13 ++++++++++--- 2 files changed, 21 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a907d5e..1b0fa7c 100644 --- a/README.md +++ b/README.md @@ -147,8 +147,6 @@ cp owl/.env_template .env ## **Running with Docker** -If you prefer to run the OWL project using Docker, we provide full Docker support: - ```bash # Clone the repository git clone https://github.com/camel-ai/owl.git @@ -158,14 +156,22 @@ cd owl cp owl/.env_template owl/.env # Edit the .env file and fill in your API keys -# Build and run the Docker container -docker-compose up -d +# Option 1: Using docker-compose directly +cd .container +docker-compose up -d # Run OWL inside the container docker-compose exec owl bash -c "xvfb-python run.py" + +# Option 2: Build and run using the provided scripts +cd .container +chmod +x build_docker.sh +./build_docker.sh +# Run OWL inside the container +./run_in_docker.sh "your question" ``` -For more detailed Docker usage instructions, including cross-platform support, optimized configurations, and troubleshooting, please refer to [DOCKER_README.md](DOCKER_README_en.md). +For more detailed Docker usage instructions, including cross-platform support, optimized configurations, and troubleshooting, please refer to [DOCKER_README.md](.container/DOCKER_README_en.md). # 🚀 Quick Start diff --git a/README_zh.md b/README_zh.md index 7f1cd91..043bdc6 100644 --- a/README_zh.md +++ b/README_zh.md @@ -155,14 +155,21 @@ cd owl cp owl/.env_template owl/.env # 编辑.env文件,填入您的API密钥 -# 构建并运行Docker容器 +# 选项1:直接使用docker-compose +cd .container docker-compose up -d - # 在容器中运行OWL docker-compose exec owl bash -c "xvfb-python run.py" + +# 选项2:使用提供的脚本构建和运行 +cd .container +chmod +x build_docker.sh +./build_docker.sh +# 在容器中运行OWL +./run_in_docker.sh "您的问题" ``` -更多详细的Docker使用说明,包括跨平台支持、优化配置和故障排除,请参阅 [DOCKER_README.md](DOCKER_README.md) +更多详细的Docker使用说明,包括跨平台支持、优化配置和故障排除,请参阅 [DOCKER_README.md](.container/DOCKER_README.md) # 🚀 快速开始