Skip to content

Commit 28b7c63

Browse files
authored
feature: 修改部署文档 (#65)
1 parent 2138ba2 commit 28b7c63

File tree

3 files changed

+42
-15
lines changed

3 files changed

+42
-15
lines changed

README-zh.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,29 +34,43 @@
3434
- kubernetes (用于部署服务-k8s方式)
3535
- Helm (用于部署服务-k8s方式)
3636

37+
本项目支持docker-compose和helm两种方式部署,请在执行命令后输入部署方式的对应编号,命令回显如下所示:
38+
```shell
39+
Choose a deployment method:
40+
1. Docker/Docker-Compose
41+
2. Kubernetes/Helm
42+
Enter choice:
43+
```
44+
3745
### 拉取代码
3846

3947
```bash
4048
git clone [email protected]:ModelEngine-Group/DataMate.git
4149
cd DataMate
4250
```
4351

44-
### 镜像构建
52+
### 部署基础服务
4553

4654
```bash
47-
make build
55+
make install
4856
```
4957

50-
### Docker安装
51-
58+
### 构建并部署Mineru增强pdf处理
5259
```bash
53-
make install INSTALLER=docker
60+
make build-mineru
61+
make install-mineru
5462
```
5563

56-
### kubernetes安装
64+
### 部署DeerFlow服务
65+
1. 修改runtime/deer-flow/.env.example,添加SEARCH_API_KEY和EMBEDDING模型配置
66+
2. 修改runtime/deer-flow/.conf.yaml.example,添加基础模型服务配置
67+
3. 执行`make install-deer-flow`
5768

69+
### 本地开发部署
70+
本地代码修改后,请执行以下命令构建镜像并使用本地镜像部署
5871
```bash
59-
make install INSTALLER=k8s
72+
make build
73+
make install REGISTRY=""
6074
```
6175

6276
## 🤝 贡献指南

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,29 +37,43 @@ If you like this project, please give it a Star⭐️!
3737
- Kubernetes (for service deployment - k8s method)
3838
- Helm (for service deployment - k8s method)
3939

40+
This project supports deployment via two methods: docker-compose and helm. After executing the command, please enter the corresponding number for the deployment method. The command echo is as follows:
41+
```shell
42+
Choose a deployment method:
43+
1. Docker/Docker-Compose
44+
2. Kubernetes/Helm
45+
Enter choice:
46+
```
47+
4048
### Clone the Code
4149

4250
```bash
4351
git clone [email protected]:ModelEngine-Group/DataMate.git
4452
cd DataMate
4553
```
4654

47-
### Build Images
55+
### Deploy the basic services
4856

4957
```bash
50-
make build
58+
make install
5159
```
5260

53-
### Docker Installation
54-
61+
### Build and deploy Mineru Enhanced PDF Processing
5562
```bash
56-
make install INSTALLER=docker
63+
make build-mineru
64+
make install-mineru
5765
```
5866

59-
### Kubernetes Installation
67+
### Deploy the DeerFlow service
68+
1. Modify `runtime/deer-flow/.env.example` and add configurations for SEARCH_API_KEY and the EMBEDDING model.
69+
2. Modify `runtime/deer-flow/.conf.yaml.example` and add basic model service configurations.
70+
3. Execute `make install-deer-flow`
6071

72+
### Local Development and Deployment
73+
After modifying the local code, please execute the following commands to build the image and deploy using the local image.
6174
```bash
62-
make install INSTALLER=k8s
75+
make build
76+
make install REGISTRY=""
6377
```
6478

6579
## 🤝 Contribution Guidelines

runtime/deer-flow/.env.example

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,6 @@ MILVUS_URI=http://milvus-standalone:19530
5959
MILVUS_USER=root
6060
MILVUS_PASSWORD=Milvus
6161
MILVUS_AUTO_LOAD_EXAMPLES=false
62-
# MILVUS_COLLECTION=documents
6362
# MILVUS_EMBEDDING_PROVIDER=openai # support openai,dashscope
6463
# MILVUS_EMBEDDING_BASE_URL=
6564
# MILVUS_EMBEDDING_MODEL=

0 commit comments

Comments
 (0)