From 5749f66197c302c7d638964e10c7356847da58bc Mon Sep 17 00:00:00 2001 From: Archer <545436317@qq.com> Date: Mon, 29 Sep 2025 11:42:47 +0800 Subject: [PATCH] update deploy doc (#5723) --- deploy/README.md | 13 ++++++++++--- deploy/docker/cn/docker-compose.milvus.yml | 4 ++-- deploy/docker/cn/docker-compose.oceanbase.yml | 4 ++-- deploy/docker/cn/docker-compose.pg.yml | 4 ++-- deploy/docker/cn/docker-compose.zilliz.yml | 4 ++-- deploy/docker/global/docker-compose.milvus.yml | 4 ++-- deploy/docker/global/docker-compose.oceanbase.yml | 4 ++-- deploy/docker/global/docker-compose.pg.yml | 4 ++-- deploy/docker/global/docker-compose.ziliiz.yml | 4 ++-- deploy/templates/docker-compose.prod.yml | 4 ++-- .../deploy/docker/cn/docker-compose.milvus.yml | 4 ++-- .../deploy/docker/cn/docker-compose.oceanbase.yml | 4 ++-- .../public/deploy/docker/cn/docker-compose.pg.yml | 4 ++-- .../deploy/docker/cn/docker-compose.zilliz.yml | 4 ++-- .../deploy/docker/global/docker-compose.milvus.yml | 4 ++-- .../docker/global/docker-compose.oceanbase.yml | 4 ++-- .../deploy/docker/global/docker-compose.pg.yml | 4 ++-- .../deploy/docker/global/docker-compose.ziliiz.yml | 4 ++-- 18 files changed, 44 insertions(+), 37 deletions(-) diff --git a/deploy/README.md b/deploy/README.md index 8618bf8d3..da949e8d5 100644 --- a/deploy/README.md +++ b/deploy/README.md @@ -1,21 +1,25 @@ ## 更新 docker compose 脚本 ### 正常更新（不动服务，只改版本） + 1. 更新 `args.json` 中的版本号 2. 在 `FastGPT` 目录执行 `pnpm run gen:deploy` 即可 ### 加服务 + 比如要添加 `example` 服务: -1. init.mjs 的 Services Enum 中添加 example -2. 更新 templates/docker-compose.[dev|prod].yml 文件，把服务的相关配置加进去，并且：服务的 image 改为 ${{example.image}}:${{example.tag}} -3. 在 `args.json` 中添加 image 和 tag, 注意名字要和 `Service Enum` 中声明的一样才能被正确替换 +1. `init.mjs` 的 `Services Enum` 中添加 fastgptExample: fastgpt-example +2. 在 `args.json` 中添加 image 和 tag, 注意 `args.json` 的 `key` 值，要和 `init.mjs` 的 `value` 值一致。 +3. 更新 templates/docker-compose.[dev|prod].yml 文件，把服务的相关配置加进去，并且：服务的 image 改为 ${{example.image}}:${{example.tag}} ### 加向量库 + 比如添加 `exampleDB` 向量库: 1. 添加 vector service 配置在 `templates/vector` 下面，例如 `templates/vector/exampleDB.txt` 内容可以参考其他 txt，注意缩进，image 名字也要替换成 ${{exampleDB.image}}:${{exampleDB:tag}} 2. 在 `args.json` 中添加 `exampleDB` 的配置 3. init.mjs vector enum 中添加 `vector` 4. init.mjs 中添加 vector 的相关配置: + ```ts const vector = { // pg, milvus, ob ... @@ -28,7 +32,9 @@ const vector = { } } ``` + 5. init.mjs 读入 vector 配置 + ```json { // 这是个块作用域, 直接搜 read in Vectors // read in Vectors @@ -37,6 +43,7 @@ const vectordb = fs.readFileSync(path.join(process.cwd(), 'templates', 'vector', vector.vector.db = String(vectordb); } ``` + 6. init.mjs 最后生成的时候，需要添加 ```ts fs.promises.writeFile( diff --git a/deploy/docker/cn/docker-compose.milvus.yml b/deploy/docker/cn/docker-compose.milvus.yml index de3234d3c..caf521d30 100644 --- a/deploy/docker/cn/docker-compose.milvus.yml +++ b/deploy/docker/cn/docker-compose.milvus.yml @@ -5,9 +5,9 @@ # - 建议修改账密后再运行 # plugin auth token -x-plugin-auth-token: &x-plugin-auth-token token +x-plugin-auth-token: &x-plugin-auth-token 'token' # aiproxy token -x-aiproxy-token: &x-aiproxy-token token +x-aiproxy-token: &x-aiproxy-token 'token' # 数据库连接相关配置 x-share-db-config: &x-share-db-config MONGODB_URI: mongodb://username:password@mongo:27017/fastgpt?authSource=admin diff --git a/deploy/docker/cn/docker-compose.oceanbase.yml b/deploy/docker/cn/docker-compose.oceanbase.yml index 3c0b89e89..f580bb875 100644 --- a/deploy/docker/cn/docker-compose.oceanbase.yml +++ b/deploy/docker/cn/docker-compose.oceanbase.yml @@ -5,9 +5,9 @@ # - 建议修改账密后再运行 # plugin auth token -x-plugin-auth-token: &x-plugin-auth-token token +x-plugin-auth-token: &x-plugin-auth-token 'token' # aiproxy token -x-aiproxy-token: &x-aiproxy-token token +x-aiproxy-token: &x-aiproxy-token 'token' # 数据库连接相关配置 x-share-db-config: &x-share-db-config MONGODB_URI: mongodb://username:password@mongo:27017/fastgpt?authSource=admin diff --git a/deploy/docker/cn/docker-compose.pg.yml b/deploy/docker/cn/docker-compose.pg.yml index 62fe58e75..fd027b5bd 100644 --- a/deploy/docker/cn/docker-compose.pg.yml +++ b/deploy/docker/cn/docker-compose.pg.yml @@ -5,9 +5,9 @@ # - 建议修改账密后再运行 # plugin auth token -x-plugin-auth-token: &x-plugin-auth-token token +x-plugin-auth-token: &x-plugin-auth-token 'token' # aiproxy token -x-aiproxy-token: &x-aiproxy-token token +x-aiproxy-token: &x-aiproxy-token 'token' # 数据库连接相关配置 x-share-db-config: &x-share-db-config MONGODB_URI: mongodb://username:password@mongo:27017/fastgpt?authSource=admin diff --git a/deploy/docker/cn/docker-compose.zilliz.yml b/deploy/docker/cn/docker-compose.zilliz.yml index c9798ed9f..78930fda1 100644 --- a/deploy/docker/cn/docker-compose.zilliz.yml +++ b/deploy/docker/cn/docker-compose.zilliz.yml @@ -5,9 +5,9 @@ # - 建议修改账密后再运行 # plugin auth token -x-plugin-auth-token: &x-plugin-auth-token token +x-plugin-auth-token: &x-plugin-auth-token 'token' # aiproxy token -x-aiproxy-token: &x-aiproxy-token token +x-aiproxy-token: &x-aiproxy-token 'token' # 数据库连接相关配置 x-share-db-config: &x-share-db-config MONGODB_URI: mongodb://username:password@mongo:27017/fastgpt?authSource=admin diff --git a/deploy/docker/global/docker-compose.milvus.yml b/deploy/docker/global/docker-compose.milvus.yml index de06bce03..e459bcec8 100644 --- a/deploy/docker/global/docker-compose.milvus.yml +++ b/deploy/docker/global/docker-compose.milvus.yml @@ -5,9 +5,9 @@ # - 建议修改账密后再运行 # plugin auth token -x-plugin-auth-token: &x-plugin-auth-token token +x-plugin-auth-token: &x-plugin-auth-token 'token' # aiproxy token -x-aiproxy-token: &x-aiproxy-token token +x-aiproxy-token: &x-aiproxy-token 'token' # 数据库连接相关配置 x-share-db-config: &x-share-db-config MONGODB_URI: mongodb://username:password@mongo:27017/fastgpt?authSource=admin diff --git a/deploy/docker/global/docker-compose.oceanbase.yml b/deploy/docker/global/docker-compose.oceanbase.yml index d9da84d9f..4c0675d34 100644 --- a/deploy/docker/global/docker-compose.oceanbase.yml +++ b/deploy/docker/global/docker-compose.oceanbase.yml @@ -5,9 +5,9 @@ # - 建议修改账密后再运行 # plugin auth token -x-plugin-auth-token: &x-plugin-auth-token token +x-plugin-auth-token: &x-plugin-auth-token 'token' # aiproxy token -x-aiproxy-token: &x-aiproxy-token token +x-aiproxy-token: &x-aiproxy-token 'token' # 数据库连接相关配置 x-share-db-config: &x-share-db-config MONGODB_URI: mongodb://username:password@mongo:27017/fastgpt?authSource=admin diff --git a/deploy/docker/global/docker-compose.pg.yml b/deploy/docker/global/docker-compose.pg.yml index f82d675fb..314b5f72e 100644 --- a/deploy/docker/global/docker-compose.pg.yml +++ b/deploy/docker/global/docker-compose.pg.yml @@ -5,9 +5,9 @@ # - 建议修改账密后再运行 # plugin auth token -x-plugin-auth-token: &x-plugin-auth-token token +x-plugin-auth-token: &x-plugin-auth-token 'token' # aiproxy token -x-aiproxy-token: &x-aiproxy-token token +x-aiproxy-token: &x-aiproxy-token 'token' # 数据库连接相关配置 x-share-db-config: &x-share-db-config MONGODB_URI: mongodb://username:password@mongo:27017/fastgpt?authSource=admin diff --git a/deploy/docker/global/docker-compose.ziliiz.yml b/deploy/docker/global/docker-compose.ziliiz.yml index f6717a9cf..22a43ea25 100644 --- a/deploy/docker/global/docker-compose.ziliiz.yml +++ b/deploy/docker/global/docker-compose.ziliiz.yml @@ -5,9 +5,9 @@ # - 建议修改账密后再运行 # plugin auth token -x-plugin-auth-token: &x-plugin-auth-token token +x-plugin-auth-token: &x-plugin-auth-token 'token' # aiproxy token -x-aiproxy-token: &x-aiproxy-token token +x-aiproxy-token: &x-aiproxy-token 'token' # 数据库连接相关配置 x-share-db-config: &x-share-db-config MONGODB_URI: mongodb://username:password@mongo:27017/fastgpt?authSource=admin diff --git a/deploy/templates/docker-compose.prod.yml b/deploy/templates/docker-compose.prod.yml index 534db773a..c5d7afb8f 100644 --- a/deploy/templates/docker-compose.prod.yml +++ b/deploy/templates/docker-compose.prod.yml @@ -5,9 +5,9 @@ # - 建议修改账密后再运行 # plugin auth token -x-plugin-auth-token: &x-plugin-auth-token token +x-plugin-auth-token: &x-plugin-auth-token 'token' # aiproxy token -x-aiproxy-token: &x-aiproxy-token token +x-aiproxy-token: &x-aiproxy-token 'token' # 数据库连接相关配置 x-share-db-config: &x-share-db-config MONGODB_URI: mongodb://username:password@mongo:27017/fastgpt?authSource=admin diff --git a/document/public/deploy/docker/cn/docker-compose.milvus.yml b/document/public/deploy/docker/cn/docker-compose.milvus.yml index de3234d3c..caf521d30 100644 --- a/document/public/deploy/docker/cn/docker-compose.milvus.yml +++ b/document/public/deploy/docker/cn/docker-compose.milvus.yml @@ -5,9 +5,9 @@ # - 建议修改账密后再运行 # plugin auth token -x-plugin-auth-token: &x-plugin-auth-token token +x-plugin-auth-token: &x-plugin-auth-token 'token' # aiproxy token -x-aiproxy-token: &x-aiproxy-token token +x-aiproxy-token: &x-aiproxy-token 'token' # 数据库连接相关配置 x-share-db-config: &x-share-db-config MONGODB_URI: mongodb://username:password@mongo:27017/fastgpt?authSource=admin diff --git a/document/public/deploy/docker/cn/docker-compose.oceanbase.yml b/document/public/deploy/docker/cn/docker-compose.oceanbase.yml index 3c0b89e89..f580bb875 100644 --- a/document/public/deploy/docker/cn/docker-compose.oceanbase.yml +++ b/document/public/deploy/docker/cn/docker-compose.oceanbase.yml @@ -5,9 +5,9 @@ # - 建议修改账密后再运行 # plugin auth token -x-plugin-auth-token: &x-plugin-auth-token token +x-plugin-auth-token: &x-plugin-auth-token 'token' # aiproxy token -x-aiproxy-token: &x-aiproxy-token token +x-aiproxy-token: &x-aiproxy-token 'token' # 数据库连接相关配置 x-share-db-config: &x-share-db-config MONGODB_URI: mongodb://username:password@mongo:27017/fastgpt?authSource=admin diff --git a/document/public/deploy/docker/cn/docker-compose.pg.yml b/document/public/deploy/docker/cn/docker-compose.pg.yml index 62fe58e75..fd027b5bd 100644 --- a/document/public/deploy/docker/cn/docker-compose.pg.yml +++ b/document/public/deploy/docker/cn/docker-compose.pg.yml @@ -5,9 +5,9 @@ # - 建议修改账密后再运行 # plugin auth token -x-plugin-auth-token: &x-plugin-auth-token token +x-plugin-auth-token: &x-plugin-auth-token 'token' # aiproxy token -x-aiproxy-token: &x-aiproxy-token token +x-aiproxy-token: &x-aiproxy-token 'token' # 数据库连接相关配置 x-share-db-config: &x-share-db-config MONGODB_URI: mongodb://username:password@mongo:27017/fastgpt?authSource=admin diff --git a/document/public/deploy/docker/cn/docker-compose.zilliz.yml b/document/public/deploy/docker/cn/docker-compose.zilliz.yml index c9798ed9f..78930fda1 100644 --- a/document/public/deploy/docker/cn/docker-compose.zilliz.yml +++ b/document/public/deploy/docker/cn/docker-compose.zilliz.yml @@ -5,9 +5,9 @@ # - 建议修改账密后再运行 # plugin auth token -x-plugin-auth-token: &x-plugin-auth-token token +x-plugin-auth-token: &x-plugin-auth-token 'token' # aiproxy token -x-aiproxy-token: &x-aiproxy-token token +x-aiproxy-token: &x-aiproxy-token 'token' # 数据库连接相关配置 x-share-db-config: &x-share-db-config MONGODB_URI: mongodb://username:password@mongo:27017/fastgpt?authSource=admin diff --git a/document/public/deploy/docker/global/docker-compose.milvus.yml b/document/public/deploy/docker/global/docker-compose.milvus.yml index de06bce03..e459bcec8 100644 --- a/document/public/deploy/docker/global/docker-compose.milvus.yml +++ b/document/public/deploy/docker/global/docker-compose.milvus.yml @@ -5,9 +5,9 @@ # - 建议修改账密后再运行 # plugin auth token -x-plugin-auth-token: &x-plugin-auth-token token +x-plugin-auth-token: &x-plugin-auth-token 'token' # aiproxy token -x-aiproxy-token: &x-aiproxy-token token +x-aiproxy-token: &x-aiproxy-token 'token' # 数据库连接相关配置 x-share-db-config: &x-share-db-config MONGODB_URI: mongodb://username:password@mongo:27017/fastgpt?authSource=admin diff --git a/document/public/deploy/docker/global/docker-compose.oceanbase.yml b/document/public/deploy/docker/global/docker-compose.oceanbase.yml index d9da84d9f..4c0675d34 100644 --- a/document/public/deploy/docker/global/docker-compose.oceanbase.yml +++ b/document/public/deploy/docker/global/docker-compose.oceanbase.yml @@ -5,9 +5,9 @@ # - 建议修改账密后再运行 # plugin auth token -x-plugin-auth-token: &x-plugin-auth-token token +x-plugin-auth-token: &x-plugin-auth-token 'token' # aiproxy token -x-aiproxy-token: &x-aiproxy-token token +x-aiproxy-token: &x-aiproxy-token 'token' # 数据库连接相关配置 x-share-db-config: &x-share-db-config MONGODB_URI: mongodb://username:password@mongo:27017/fastgpt?authSource=admin diff --git a/document/public/deploy/docker/global/docker-compose.pg.yml b/document/public/deploy/docker/global/docker-compose.pg.yml index f82d675fb..314b5f72e 100644 --- a/document/public/deploy/docker/global/docker-compose.pg.yml +++ b/document/public/deploy/docker/global/docker-compose.pg.yml @@ -5,9 +5,9 @@ # - 建议修改账密后再运行 # plugin auth token -x-plugin-auth-token: &x-plugin-auth-token token +x-plugin-auth-token: &x-plugin-auth-token 'token' # aiproxy token -x-aiproxy-token: &x-aiproxy-token token +x-aiproxy-token: &x-aiproxy-token 'token' # 数据库连接相关配置 x-share-db-config: &x-share-db-config MONGODB_URI: mongodb://username:password@mongo:27017/fastgpt?authSource=admin diff --git a/document/public/deploy/docker/global/docker-compose.ziliiz.yml b/document/public/deploy/docker/global/docker-compose.ziliiz.yml index f6717a9cf..22a43ea25 100644 --- a/document/public/deploy/docker/global/docker-compose.ziliiz.yml +++ b/document/public/deploy/docker/global/docker-compose.ziliiz.yml @@ -5,9 +5,9 @@ # - 建议修改账密后再运行 # plugin auth token -x-plugin-auth-token: &x-plugin-auth-token token +x-plugin-auth-token: &x-plugin-auth-token 'token' # aiproxy token -x-aiproxy-token: &x-aiproxy-token token +x-aiproxy-token: &x-aiproxy-token 'token' # 数据库连接相关配置 x-share-db-config: &x-share-db-config MONGODB_URI: mongodb://username:password@mongo:27017/fastgpt?authSource=admin