docs: update README

blogdefotsec · May 8, 2023 · 1b8bfdd · 1b8bfdd
1 parent a413ca0
commit 1b8bfdd
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 17 deletions.
diff --git a/.github/workflows/build-docker-image.yml b/.github/workflows/build-docker-image.yml
@@ -7,7 +7,7 @@ on:
 
 env:
   REGISTRY: docker.io
-  IMAGE_NAME: Dogtititi/AutoGPT-Next-Web
+  IMAGE_NAME: dogtititi/autogpt-next-web
 
 jobs:
   build-and-push-image:

diff --git a/README.md b/README.md
@@ -54,21 +54,20 @@ A: The project originated from AgentGPT. Our goal is to continuously provide use
 
 ## Docker Deployment
 
-### Docker Setup
+### Docker Local Setup
 
 The easiest way to run AutoGPT-Next-Web locally is by using docker.
-A convenient setup script is provided to help you get started.
 
 ```bash
-./setup.sh --docker
+ docker-compose -f docker-compose-local.yml up -d --remove-orphans
 ```
 
-### Docker-compose
+### Docker-Image
 
-Using `docker-compose` deploy
+Using `docker-image`
 
 ```bash
-./setup.sh --docker-compose
+docker-compose up -d --remove-orphans
 ```
 
 ### Local Development Setup
@@ -77,7 +76,7 @@ If you wish to develop AutoGPT-Next-Web locally, the easiest way is to
 use the provided setup script.
 
 ```bash
-./setup.sh --local
+./setup.sh
 ```
 
 ### Manual Setup
@@ -114,7 +113,8 @@ NODE_ENV=development
 NEXTAUTH_SECRET=''
 NEXTAUTH_URL=http://localhost:3000
 DATABASE_URL=file:./db.sqlite
-
+NEXT_PUBLIC_WEB_SEARCH_ENABLED='' #true or false
+SERP_API_KEY=''
 # Your open api key
 OPENAI_API_KEY=''
 ```

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -5,7 +5,7 @@ volumes:
 
 services:
   autogpt:
-    image: Dogtiti/AutoGPT-Next-Web:main
+    image: dogtititi/autogpt-next-web:main
     container_name: autogpt
     environment:
       OPENAI_API_KEY: ${OPENAI_API_KEY} # openai api key

diff --git a/docs/README_CN.md b/docs/README_CN.md
@@ -54,26 +54,28 @@ A：项目源自于 AgentGPT，我们目标是持续输出对国内用户友好
 
 ## Docker 部署
 
-### Docker 配置
+### Docker 本地配置
 
-使用 Docker 是在本地运行 AutoGPT-Next-Web 最简单的方法，这里提供了便捷的脚本以帮助您快速入门。
+使用 Docker 是在本地运行 AutoGPT-Next-Web 最简单的方法。
 
 ```bash
-./setup.sh --docker
+docker-compose -f docker-compose-local.yml up -d --remove-orphans
 ```
-### Docker-compose
 
-使用 `docker-compose` 部署
+### Docker-Image
+
+使用 `docker-image` 部署
+
 ```bash
-./setup.sh --docker-compose
+docker-compose up -d --remove-orphans
 ```
 
 ### 本地开发环境配置
 
 如果您想在本地开发 AutoGPT-Next-Web，则最简单的方法是使用提供的设置脚本。
 
 ```bash
-./setup.sh --local
+./setup.sh
 ```
 
 ### 手动配置