Explorar el Código

Update:更新readme

XieXing hace 3 meses
padre
commit
15cfdc7c32
Se han modificado 4 ficheros con 44 adiciones y 352 borrados
  1. 0 1
      .gitignore
  2. 0 71
      DEPLOY.md
  3. 44 153
      README.md
  4. 0 127
      shudao-go-backend/conf/app.conf.example

+ 0 - 1
.gitignore

@@ -35,7 +35,6 @@ shudao-go-backend/views/index.html
 
 #config file
 shudao-go-backend/conf
-shudao-vue-frontend\vite.config.js
 
 #IDE file
 .kiro

+ 0 - 71
DEPLOY.md

@@ -1,71 +0,0 @@
-# 蜀道安全管理AI智能助手 - 部署指南
-
-## 1. 环境准备
-
-### 1.1 配置文件
-本项目使用 `conf/app.conf` 进行配置管理。该文件未包含在版本控制中,部署时需要手动创建。
-
-**步骤:**
-1. 进入项目根目录 `shudao-go-backend`。
-2. 复制配置模板:
-   ```bash
-   cp conf/app.conf.example conf/app.conf
-   ```
-3. 编辑 `conf/app.conf`,根据当前环境(本地/测试/生产)修改配置项。
-
-### 1.2 关键配置项说明
-- **base_url**: 系统基础URL,用于生成OSS代理链接等。
-- **mysql_***: 数据库连接信息。
-- **oss_***: 对象存储配置(MinIO/S3)。
-- **deepseek_api_key**: AI模型API密钥。
-- **yolo_base_url**: 隐患识别服务地址。
-
-## 2. 部署流程
-
-### 2.1 本地开发 (Local Development)
-支持热重载,适合开发调试。
-
-```bash
-# 确保已安装 bee 工具
-go install github.com/beego/bee/v2@latest
-
-# 启动服务
-cd shudao-go-backend
-bee run
-```
-
-### 2.2 测试/生产环境部署 (Production Deployment)
-
-**编译:**
-```bash
-cd shudao-go-backend
-go build -o shudao-chat-go main.go
-```
-
-**运行:**
-```bash
-# 赋予执行权限
-chmod +x shudao-chat-go
-
-# 启动服务 (建议使用 nohup 或 supervisor 管理进程)
-nohup ./shudao-chat-go &
-```
-
-## 3. 验证部署
-
-1. **检查日志**: 查看 `nohup.out` 或控制台输出,确认没有配置加载错误。
-2. **健康检查**: 访问 `/api/health` (如果已实现) 或尝试调用基础接口。
-3. **功能验证**:
-   - 上传一张图片,验证OSS配置是否正确。
-   - 发起一次AI对话,验证模型服务配置。
-
-## 4. 常见问题
-
-**Q: 启动时报错 "配置项 xxx 未设置或为空"**
-A: 检查 `conf/app.conf` 是否包含该配置项,且值不为空。
-
-**Q: 数据库连接失败**
-A: 检查 `mysql_urls` 和 `mysql_port` 是否正确,以及防火墙是否允许连接。
-
-**Q: 图片无法预览**
-A: 检查 `base_url` 是否配置为当前环境的可访问地址(如 `https://aqai.shudaodsj.com:22000`)。

+ 44 - 153
README.md

@@ -1,180 +1,71 @@
-# 部署与上线指南
-
-本文档详细说明如何在服务器的 `/tmp/tmp` 目录下拉取 `dev` 分支代码,并完成前后端的编译与生产环境部署。
+# 蜀道安全管理AI智能助手 - 部署指南
 
 ## 1. 环境准备
 
-### 方案A:服务器直接编译(需要安装 Go)
-
-确保服务器已安装以下环境:
+### 1.1 配置文件
+本项目使用 `conf/app.conf` 进行配置管理。该文件未包含在版本控制中,部署时需要手动创建。
 
-- **Git**: 用于拉取代码
-- **Node.js** (≥ 20.19) & **npm**: 用于前端打包
-- **Go** (≥ 1.24): 用于后端编译
+**步骤:**
+1. 进入项目根目录 `shudao-go-backend`。
+2. 复制配置模板:
+   ```bash
+   cp conf/app.conf.example conf/app.conf
+   ```
+3. 编辑 `conf/app.conf`,根据当前环境(本地/测试/生产)修改配置项。
 
-#### 安装 Go 1.24+
-
-```bash
-# 1. 下载 Go 1.24
-wget https://go.dev/dl/go1.24.0.linux-amd64.tar.gz
+### 1.2 关键配置项说明
+- **base_url**: 系统基础URL,用于生成OSS代理链接等。
+- **mysql_***: 数据库连接信息。
+- **oss_***: 对象存储配置(MinIO/S3)。
+- **deepseek_api_key**: AI模型API密钥。
+- **yolo_base_url**: 隐患识别服务地址。
 
-# 2. 解压到 /usr/local
-sudo rm -rf /usr/local/go
-sudo tar -C /usr/local -xzf go1.24.0.linux-amd64.tar.gz
-
-# 3. 配置环境变量
-echo 'export PATH=$PATH:/usr/local/go/bin' >> ~/.bashrc
-echo 'export GOPATH=$HOME/go' >> ~/.bashrc
-echo 'export GOPROXY=https://goproxy.cn,direct' >> ~/.bashrc
-source ~/.bashrc
-
-# 4. 验证安装
-go version
-```
+## 2. 部署流程
 
-### 方案B:本地编译上传(推荐,无需服务器安装 Go)
-
-在本地 Windows 环境编译好二进制文件,然后上传到服务器。详见后续步骤。
-
-## 2. 拉取代码
-
-进入目标目录并拉取远程 `dev` 分支代码:
+### 2.1 本地开发 (Local Development)
+支持热重载,适合开发调试。
 
 ```bash
-# 1. 创建并进入目录
-mkdir -p /tmp/tmp
-cd /tmp/tmp
-
-# 2. 拉取代码
-# 情况A:如果是首次部署(目录为空)
-git clone -b dev http://192.168.0.3:3000/ShuDao-SafeAI/ShuDaoMAIN.git .
-
-# 情况B:如果目录已存在且已有仓库
-# git checkout dev
-# git pull origin dev
-```
-
-> **注意**:请根据实际情况替换 git 仓库地址。
-
-## 3. 前端编译 (shudao-vue-frontend)
-
-进入前端目录,安装依赖并打包:
-
-```bash
-# 1. 进入前端目录
-cd shudao-vue-frontend
-
-# 2. 安装依赖
-npm install --registry=https://registry.npmmirror.com
-
-# 3. 执行构建
-npm run build
-```
-
-构建完成后,会在 `shudao-vue-frontend/dist` 目录下生成静态资源(包含 `assets` 目录和 `index.html`)。
-
-## 4. 整合产物到后端
-
-将前端生成的静态资源复制到后端对应的目录中:
-
-```bash
-# 1. 回到项目根目录
-cd ..
+# 确保已安装 bee 工具
+go install github.com/beego/bee/v2@latest
 
-# 2. 进入后端目录
+# 启动服务
 cd shudao-go-backend
-
-# 3. 清理旧资源(可选,建议执行以避免缓存问题)
-rm -rf assets
-rm -f views/index.html
-
-# 4. 复制新资源
-# 复制静态资源目录 assets
-cp -r ../shudao-vue-frontend/dist/assets .
-
-# 复制入口文件 index.html 到 views 目录
-cp ../shudao-vue-frontend/dist/index.html views/
+bee run
 ```
 
-> **说明**:
->
-> - `assets/` 目录存放 JS/CSS/图片等静态资源,后端通过 `beego.SetStaticPath("/assets", "assets")` 进行映射。
-> - `views/index.html` 是前端入口页面,后端控制器会渲染此模板。
-
-## 5. 后端编译与打包 (shudao-go-backend)
-
-### 方法1:使用 Beego bee 工具打包(推荐)
+### 2.2 测试/生产环境部署 (Production Deployment)
 
+**编译:**
 ```bash
-# 1. 进入后端目录
 cd shudao-go-backend
-
-# 2. 安装 bee 工具(如果未安装)
-go install github.com/beego/bee/v2@latest
-
-# 3. 使用 bee pack 打包(会自动交叉编译为 Linux 并打包所有资源)
-bee pack -be GOOS=linux -be GOARCH=amd64
-
-# 4. 生成的压缩包:shudao-go-backend.tar.gz
-# 将此文件上传到服务器 /tmp/tmp 目录
+go build -o shudao-chat-go main.go
 ```
 
-### 方法2:直接使用 go build 编译
-
+**运行:**
 ```bash
-# 1. 进入后端目录
-cd shudao-go-backend
-
-# 2. 整理依赖
-go mod tidy
-
-# 3. 交叉编译为 Linux 可执行文件
-# Windows PowerShell:
-$env:GOOS="linux"; $env:GOARCH="amd64"; go build -o shudao-go-backend main.go
+# 赋予执行权限
+chmod +x shudao-chat-go
 
-# Linux/Mac:
-GOOS=linux GOARCH=amd64 go build -o shudao-go-backend main.go
+# 启动服务 (建议使用 nohup 或 supervisor 管理进程)
+nohup ./shudao-chat-go &
 ```
 
-### 服务器部署
-
-```bash
-# 1. 进入部署目录
-cd /tmp/tmp
-
-# 2. 解压(如果使用 bee pack)
-tar -xzf shudao-go-backend.tar.gz
-
-# 3. 进入后端目录
-cd shudao-go-backend
-
-# 4. 赋予执行权限
-chmod +x shudao-go-backend
-
-# 5. 停止旧服务(如果存在)
-ps -ef | grep shudao-go-backend
-# 找到进程ID后执行:kill -9 <PID>
-
-# 6. 启动新服务 (后台运行)
-nohup ./shudao-go-backend > nohup.out 2>&1 &tail -f nohup.out
-```
+## 3. 验证部署
 
-## 6. 验证部署
+1. **检查日志**: 查看 `nohup.out` 或控制台输出,确认没有配置加载错误。
+2. **健康检查**: 访问 `/api/health` (如果已实现) 或尝试调用基础接口。
+3. **功能验证**:
+   - 上传一张图片,验证OSS配置是否正确。
+   - 发起一次AI对话,验证模型服务配置。
 
-- 检查进程是否存在:
-  ```bash
-  ps -ef | grep shudao-go-backend
-  ```
-- 访问服务地址,确认页面加载正常且 API 调用成功。
+## 4. 常见问题
 
----
+**Q: 启动时报错 "配置项 xxx 未设置或为空"**
+A: 检查 `conf/app.conf` 是否包含该配置项,且值不为空。
 
-### 目录结构说明 (重构后)
+**Q: 数据库连接失败**
+A: 检查 `mysql_urls` 和 `mysql_port` 是否正确,以及防火墙是否允许连接。
 
-- `/shudao-vue-frontend`: Vue 3 前端项目源码
-- `/shudao-go-backend`: Beego 后端项目源码
-  - `/controllers`: 控制器逻辑
-  - `/models`: 数据模型
-  - `/views`: 存放前端入口 HTML 模板
-  - `/assets`: (编译部署时生成) 存放前端静态资源
-  - `/static`: 其他静态文件
+**Q: 图片无法预览**
+A: 检查 `base_url` 是否配置为当前环境的可访问地址(如 `https://aqai.shudaodsj.com:22000`)。

+ 0 - 127
shudao-go-backend/conf/app.conf.example

@@ -1,127 +0,0 @@
-# ==========================================
-# 蜀道安全管理系统 - 配置文件模板
-# ==========================================
-# 使用说明:
-# 1. 复制此文件为 app.conf (cp app.conf.example app.conf)
-# 2. 根据部署环境填写对应的配置值
-# 3. app.conf 已加入 .gitignore,不会被提交到版本控制
-# ==========================================
-
-appname = shudao-chat-go
-httpport = 22001
-runmode = dev
-
-# ==========================================
-# 基础配置 (Base Configuration)
-# ==========================================
-# 说明: 系统的基础URL,用于生成OSS代理链接等
-# 本地环境: http://127.0.0.1:22000 或 http://localhost:22000
-# 测试环境: https://aqai.shudaodsj.com:22000
-# 生产环境: https://aqai.shudaodsj.com:22000
-base_url = "https://aqai.shudaodsj.com:22000"
-
-# ==========================================
-# 数据库配置 (MySQL Database)
-# ==========================================
-# 本地环境: 使用测试环境数据库 172.16.29.101:21000
-# 测试环境: 172.16.29.101:21000
-# 生产环境: 172.16.35.57:21000
-mysql_user = "root"
-mysql_pass = "your_password_here"
-mysql_urls = "172.16.29.101"
-mysql_port = "21000"
-mysql_db = "shudao"
-
-# ==========================================
-# 认证服务配置 (Authentication Service)
-# ==========================================
-# 说明: Token验证API地址
-# 生产环境: https://aqai.shudaodsj.com:22000/api/auth/verify
-# auth_api_url = "http://127.0.0.1:28004/api/auth/verify"
-
-# ==========================================
-# 本地登录配置 (Local Login - 仅本地/测试环境)
-# ==========================================
-# 说明: 本地登录功能开关,仅在本地和测试环境启用
-# 生产环境必须设置为 false
-enable_local_login = true
-
-# JWT密钥 (用于本地token签名)
-# 请修改为随机字符串,建议32位以上
-jwt_secret = "shudao-local-jwt-secret-key-please-change-this-in-production"
-
-# ==========================================
-# OSS对象存储配置 (Object Storage Service)
-# ==========================================
-# 说明: MinIO或兼容S3的对象存储服务
-# 本地环境: http://localhost:9000
-# 测试/生产环境: http://172.16.17.52:8060
-oss_endpoint = "http://172.16.17.52:8060"
-oss_access_key_id = "your_access_key_here"
-oss_access_key_secret = "your_secret_key_here"
-oss_bucket = "gdsc-ai-aqzs"
-oss_parse_encrypt_key = "your_encrypt_key_here"
-
-# ==========================================
-# AI模型服务配置 (AI Model Services)
-# ==========================================
-
-# DeepSeek API配置
-# 生产环境: https://api.deepseek.com
-deepseek_api_key = "sk-your-deepseek-api-key"
-deepseek_api_url = "https://api.deepseek.com"
-
-# 阿里通义千问模型配置
-# 本地环境: http://localhost:8000
-# 测试/生产环境: http://172.16.35.50:8000
-qwen3_api_url = "http://172.16.35.50:8000"
-qwen3_model = "Qwen3-30B-A3B-Instruct-2507"
-
-# 意图识别模型配置
-# 本地环境: http://localhost:8000
-# 测试/生产环境: http://172.16.35.50:8000
-intent_api_url = "http://172.16.35.50:8000"
-intent_model = "Qwen2.5-1.5B-Instruct"
-
-# ==========================================
-# YOLO隐患识别服务配置 (YOLO Detection Service)
-# ==========================================
-# 说明: YOLO模型API服务地址
-# 本地环境: http://localhost:18080
-# 测试/生产环境: http://172.16.35.50:18080
-yolo_base_url = "http://172.16.35.50:18080"
-
-# ==========================================
-# 搜索服务配置 (Search Service)
-# ==========================================
-# 说明: 内部搜索引擎API地址
-# 本地环境: http://localhost:24000/api/search
-# 测试/生产环境: 根据实际部署调整
-search_api_url = "http://localhost:24000/api/search"
-heartbeat_api_url = "http://localhost:24000/api/health"
-
-# ==========================================
-# 知识库服务配置 (Knowledge Base Service)
-# ==========================================
-# 说明: 高级搜索API地址
-# 本地环境: http://localhost:22000/admin/api/v1/knowledge/files/advanced-search
-# 生产环境: https://aqai.shudaodsj.com:22000/admin/api/v1/knowledge/files/advanced-search
-knowledge_search_url = "https://aqai.shudaodsj.com:22000/admin/api/v1/knowledge/files/advanced-search"
-
-# ==========================================
-# Dify工作流配置 (Dify Workflow Service)
-# ==========================================
-# 说明: Dify工作流运行API地址
-# 本地环境: http://localhost:8000/v1/workflows/run
-# 测试/生产环境: http://172.16.35.50:8000/v1/workflows/run
-dify_workflow_url = "http://172.16.35.50:8000/v1/workflows/run"
-
-# Chroma向量数据库配置 (已弃用)
-# ==========================================
-# 注意: 此配置已被知识库服务替代,保留仅供参考
-# 本地环境: 使用测试环境 172.16.29.101:23000
-# 测试环境: 172.16.29.101:23000
-# 生产环境: 172.16.35.57:23000
-# chroma_host = "172.16.29.101"
-# chroma_port = "23000"
-# chroma_collection_name = "my_rag_collection"