docs

2025-07-24 22:03:54 +00:00 · 2023-08-08 16:14:03 +08:00
parent 6531af6c3a
commit 5116bf7d25
70 changed files with 617 additions and 411 deletions
--- a/docSite/docs/develop/deploy/docker.md
+++ b/docSite/docs/develop/deploy/docker.md
@@ -0,0 +1,180 @@
+# docker-compose 快速部署
+
+## 一、预先准备
+
+### 准备好代理环境（国外服务器可忽略）
+
+确保可访问到 OpenAI，方案可参考：[sealos nginx 中转](../proxy/sealos)
+
+### OneAPI (可选，需要多模型和 key 轮询时使用)
+
+推荐使用 [one-api](https://github.com/songquanpeng/one-api) 项目来管理 key 池，兼容 openai 、微软和国内主流模型等。
+
+部署可以看该项目的 [README.md](https://github.com/songquanpeng/one-api)，也可以看 [在 Sealos 1 分钟部署 one-api](../oneapi)
+
+## 二、安装 docker 和 docker-compose
+
+这个不同系统略有区别，百度安装下。验证安装成功后进行下一步。下面给出 centos 一个例子：
+
+```bash
+# 安装docker
+curl -L https://get.daocloud.io/docker | sh
+sudo systemctl start docker
+# 安装 docker-compose
+curl -L https://github.com/docker/compose/releases/download/1.23.2/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
+sudo chmod +x /usr/local/bin/docker-compose
+# 验证安装
+docker -v
+docker-compose -v
+```
+
+## 三、创建 docker-compose.yml 文件
+
+```yml
+# 非 host 版本, 不使用本机代理
+version: '3.3'
+services:
+  pg:
+    image: ghcr.io/c121914yu/fastgpt:latest # git
+    # image: registry.cn-hangzhou.aliyuncs.com/fastgpt/pgvector:v0.4.2 # 阿里云
+    container_name: pg
+    restart: always
+    ports: # 生产环境建议不要暴露
+      - 5432:5432
+    networks:
+      - fastgpt
+    environment:
+      # 这里的配置只有首次运行生效。修改后，重启镜像是不会生效的。需要把持久化数据删除再重启，才有效果
+      - POSTGRES_USER=username
+      - POSTGRES_PASSWORD=password
+      - POSTGRES_DB=postgres
+    volumes:
+      - ./pg/data:/var/lib/postgresql/data
+  mongo:
+    image: mongo:5.0.18
+    # image: registry.cn-hangzhou.aliyuncs.com/fastgpt/mongo:5.0.18 # 阿里云
+    container_name: mongo
+    restart: always
+    ports: # 生产环境建议不要暴露
+      - 27017:27017
+    networks:
+      - fastgpt
+    environment:
+      # 这里的配置只有首次运行生效。修改后，重启镜像是不会生效的。需要把持久化数据删除再重启，才有效果
+      - MONGO_INITDB_ROOT_USERNAME=username
+      - MONGO_INITDB_ROOT_PASSWORD=password
+    volumes:
+      - ./mongo/data:/data/db
+  fastgpt:
+    container_name: fastgpt
+    # image: c121914yu/fast-gpt:latest # docker hub
+    image: registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt:latest # 阿里云
+    ports:
+      - 3000:3000
+    networks:
+      - fastgpt
+    depends_on:
+      - mongo
+      - pg
+    restart: always
+    environment:
+      - DEFAULT_ROOT_PSW=1234
+      - DB_MAX_LINK=5 # database max link
+      # token加密凭证（随便填，作为登录凭证）
+      - TOKEN_KEY=any
+      # root key, 最高权限，可以内部接口互相调用
+      - ROOT_KEY=root_key
+      # mongo 配置，不需要改
+      - MONGODB_URI=mongodb://username:password@mongo:27017/?authSource=admin
+      - MONGODB_NAME=fastgpt
+      # pg配置.
+      - PG_HOST=pg
+      - PG_PORT=5432
+      - PG_USER=username
+      - PG_PASSWORD=password
+      - PG_DB_NAME=postgres
+      # 用了中转的话，需要修改这个变量
+      - OPENAI_BASE_URL=https://api.openai.com/v1
+      # 用了 ONEAPI 则填写该地址
+      # - ONEAPI_URL=https://xxxx.cloud.sealos.io/v1
+      # OpenAI 的 key 或者 ONEAPI 的key，填了 ONEAPI_URL 则填写 ONEAPI 的 key
+      - CHAT_API_KEY=sk-xxxx
+networks:
+  fastgpt:
+```
+
+```yml
+# host 版本, 不推荐。
+version: '3.3'
+services:
+pg:
+image: ankane/pgvector:v0.4.2 # dockerhub
+# image: registry.cn-hangzhou.aliyuncs.com/fastgpt/pgvector:v0.4.2 # 阿里云
+container_name: pg
+restart: always
+ports: # 生产环境建议不要暴露
+    - 5432:5432
+environment:
+    # 这里的配置只有首次运行生效。修改后，重启镜像是不会生效的。需要把持久化数据删除再重启，才有效果
+    - POSTGRES_USER=username
+    - POSTGRES_PASSWORD=password
+    - POSTGRES_DB=postgres
+volumes:
+    - ./pg/data:/var/lib/postgresql/data
+mongo:
+image: mongo:5.0.18
+# image: registry.cn-hangzhou.aliyuncs.com/fastgpt/mongo:5.0.18 # 阿里云
+container_name: mongo
+restart: always
+ports: # 生产环境建议不要暴露
+    - 27017:27017
+environment:
+    # 这里的配置只有首次运行生效。修改后，重启镜像是不会生效的。需要把持久化数据删除再重启，才有效果
+    - MONGO_INITDB_ROOT_USERNAME=username
+    - MONGO_INITDB_ROOT_PASSWORD=password
+volumes:
+    - ./mongo/data:/data/db
+    - ./mongo/logs:/var/log/mongodb
+fastgpt:
+# image: ghcr.io/c121914yu/fastgpt:latest # github
+# image: c121914yu/fast-gpt:latest # docker hub
+image: registry.cn-hangzhou.aliyuncs.com/fastgpt/fastgpt:latest # 阿里云
+network_mode: host
+restart: always
+container_name: fastgpt
+environment: # 可选的变量，不需要的话需要去掉
+    - DEFAULT_ROOT_PSW=1234
+    - DB_MAX_LINK=5 # database max link
+    # token加密凭证（随便填，作为登录凭证）
+    - TOKEN_KEY=any
+    # root key, 最高权限，可以内部接口互相调用
+    - ROOT_KEY=root_key
+    # mongo 配置，不需要改
+    - MONGODB_URI=mongodb://username:password@0.0.0.0:27017/?authSource=admin
+    - MONGODB_NAME=fastgpt
+    # pg 配置
+    - PG_HOST=0.0.0.0
+    - PG_PORT=5432
+    - PG_USER=username
+    - PG_PASSWORD=password
+    - PG_DB_NAME=postgres
+    # 用了中转的话，需要修改这个变量
+    - OPENAI_BASE_URL=https://api.openai.com/v1
+    # 用了 ONEAPI 则填写该地址
+    # - ONEAPI_URL=https://xxxx.cloud.sealos.io/v1
+    # OpenAI 的 key 或者 ONEAPI 的key，填了 ONEAPI_URL 则填写 ONEAPI 的 key
+    - CHAT_API_KEY=sk-xxxx
+```
+
+## 四、运行 docker-compose
+
+```bash
+# 在 docker-compose.yml 同级目录下执行
+docker-compose up -d
+```
+
+## 五、访问
+
+如果需要域名访问，自行安装 Nginx。目前可以通过: `ip:3000` 直接访问(注意防火墙)。登录用户名为 root，密码为刚刚环境变量里设置的 `DEFAULT_ROOT_PSW`
+
+## 一些问题
--- a/docSite/docs/develop/deploy/mac.md
+++ b/docSite/docs/develop/deploy/mac.md
@@ -0,0 +1,101 @@
+# Mac 上部署可能遇到的问题(旧版)
+
+### 前置条件
+
+1、可以 curl api.openai.com
+
+2、有 openai key
+
+3、有邮箱 MAILE_CODE
+
+4、有 docker
+
+```
+docker -v
+```
+
+5、有 pnpm ，可以使用`brew install pnpm`安装
+
+6、需要创建一个放置 pg 和 mongo 数据的文件夹，这里创建在`~/fastgpt`目录中,里面有`pg` 和`mongo `两个文件夹
+
+```
+➜  fastgpt pwd
+/Users/jie/fastgpt
+➜  fastgpt ls
+mongo pg
+```
+
+### docker 部署方式
+
+这种方式主要是为了方便调试，可以使用`pnpm dev ` 运行 fastgpt 项目
+
+**1、.env.local 文件**
+
+```
+# proxy
+AXIOS_PROXY_HOST=127.0.0.1
+AXIOS_PROXY_PORT_FAST=7890
+AXIOS_PROXY_PORT_NORMAL=7890
+# email
+MY_MAIL= {Your Mail}
+MAILE_CODE={Yoir Mail code}
+# ali ems
+aliAccessKeyId=xxx
+aliAccessKeySecret=xxx
+aliSignName=xxx
+aliTemplateCode=SMS_xxx
+# token
+TOKEN_KEY=sswada
+# 使用 oneapi
+ONEAPI_URL=[https://api.xyz.com/v1](https://xxxxx.cloud.sealos.io/v1)
+ONEAPI_KEY=sk-xxxxxx
+# openai
+OPENAIKEY=sk-xxx # 对话用的key
+OPENAI_TRAINING_KEY=sk-xxx # 训练用的key
+# db
+MONGODB_URI=mongodb://username:password@0.0.0.0:27017/test?authSource=admin
+PG_HOST=0.0.0.0
+PG_PORT=8100
+PG_USER=xxx
+PG_PASSWORD=xxx
+PG_DB_NAME=fastgpt
+```
+
+**2、部署 mongo**
+
+```
+docker run --name mongo -p 27017:27017 -e MONGO_INITDB_ROOT_USERNAME=username -e MONGO_INITDB_ROOT_PASSWORD=password -v ~/fastgpt/mongo/data:/data/db -d mongo:4.0.1
+```
+
+**3、部署 pgsql**
+
+```
+docker run -it --name pg -e "POSTGRES_DB=fastgpt" -e "POSTGRES_PASSWORD=xxx" -e POSTGRES_USER=xxx -p 8100:5432 -v ~/fastgpt/pg/data:/var/lib/postgresql/data -d octoberlan/pgvector:v0.4.1
+```
+
+进 pgsql 容器运行
+
+```
+psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" --dbname "$POSTGRES_DB" <<-EOSQL
+
+CREATE EXTENSION IF NOT EXISTS vector;
+-- init table
+CREATE TABLE IF NOT EXISTS modeldata (
+    id BIGSERIAL PRIMARY KEY,
+    vector VECTOR(1536) NOT NULL,
+    user_id VARCHAR(50) NOT NULL,
+    kb_id VARCHAR(50) NOT NULL,
+    source VARCHAR(100),
+    q TEXT NOT NULL,
+    a TEXT NOT NULL
+);
+-- 索引设置，按需取
+-- CREATE INDEX IF NOT EXISTS modeldata_userId_index ON modeldata USING HASH (user_id);
+-- CREATE INDEX IF NOT EXISTS modeldata_kbId_index ON modeldata USING HASH (kb_id);
+-- CREATE INDEX IF NOT EXISTS idx_model_data_md5_q_a_user_id_kb_id ON modeldata (md5(q), md5(a), user_id, kb_id);
+-- CREATE INDEX modeldata_id_desc_idx ON modeldata (id DESC);
+-- vector 索引，可以参考 [pg vector](https://github.com/pgvector/pgvector) 去配置，根据数据量去配置
+EOSQL
+```
+
+4、**最后在 FASTGPT 项目里面运行 pnpm dev 运行项目，然后进入 localhost:3000 看项目是否跑起来了**
--- a/docSite/docs/develop/deploy/sealos.md
+++ b/docSite/docs/develop/deploy/sealos.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 1
+---
+
+# Sealos 一键部署
+
+222