bear/KnowFlow

Fetch the repository succeeded.

Scan WeChat QR to Pay

Cancel

Complete

richgiteeai

Watch

Unwatch Watching Releases Only Ignoring

1 Star 0 Fork 0

bear/KnowFlow

Code Issues 0 Pull Requests 0 Wiki Insights Pipelines

Service

Tencent Cloud Serverless

Create your Gitee Account

Explore and code with more than 14 million developers,Free private repositories !:)

Already have an account? Sign in

Clone or Download

Clone/Download

HTTPS SSH SVN SVN+SSH Download ZIP

Prompt

To download the code, please copy the following command and execute it in the terminal

To ensure that your submitted code identity is correctly recognized by Gitee, please execute the following command.

git config --global user.name userName 
git config --global user.email userEmail

When using the SSH protocol for the first time to clone or push code, follow the prompts below to complete the SSH configuration.

1 Generate RSA keys.

2 Obtain the content of the RSA public key and configure it in SSH Public Keys

To use SVN on Gitee, please visit the usage guide

When using the HTTPS protocol, the command line will prompt for account and password verification as follows. For security reasons, Gitee recommends configure and use personal access tokens instead of login passwords for cloning, pushing, and other operations.

Username for 'https://gitee.com': userName

Password for 'https://userName@gitee.com': # Private Token

New file Create Diagram file

New submodule

Upload file

Branches 4

Tags 16

contribute

Sync branch

Create Pull Request

known more

See difference Through Pull Request Sync

Sync branch

Through Pull Request Sync

A Pull Request will be created to the current
branch and will be merged in to complete the sync

zxwei Update README.md 3c7b640

4046 commits

.github

.vercel

agent

agentic_reasoning

api

conf

deepdoc

docker

docs

example

graphrag

helm

intergrations

knowflow

mcp

plugin

rag

sandbox

sdk/python

test

web

.gitattributes

.gitignore

.pre-commit-config.yaml

.trivyignore

Dockerfile

Dockerfile.deps

Dockerfile.scratch.oc9

LICENSE

README.md

README_id.md

README_ja.md

README_ko.md

README_pt_br.md

README_tzh.md

README_zh.md

SECURITY.md

download_deps.py

local_entrypoint.sh

project.md

pyproject.toml

show_env.sh

uv.lock

README

unknown license

# KnowFlow - 企业级智能知识库解决方案

🌐 **官方网站**: [https://www.knowflowchat.cn](https://knowflowchat.cn)

📺 **B站视频**: [https://www.bilibili.com/video/BV1Vfg8zDEUf/](https://www.bilibili.com/video/BV1Vfg8zDEUf/)

🌐 **微信公众号**:KnowFlow 企业知识库

---

## 🚀 什么是 KnowFlow

**KnowFlow** 是一个基于 RAGFlow 的企业级开源知识库解决方案,专注于为企业提供真正落地的最后一公里服务。我们持续兼容 RAGFlow 官方版本(当前适配 RAGFlow v0.20.1),同时将社区最佳实践整合进来,为企业知识管理提供更加完善的解决方案。

### 🎯 产品定位

- **RAGFlow 企业落地的最后一公里**:解决从开源到生产的关键差距
- **插件化增强平台**:通过独立服务方式扩展 RAGFlow 功能
- **企业级知识管理系统**:提供完整的用户权限、团队协作、数据安全保障

## 📦 版本差异

### 社区版 vs 商业版

| 功能特性 | 社区版 (开源) | 商业版 |
|---------|-------------|--------|
| **基础功能** | ✅ | ✅ |
| **MinerU 解析** | ✅ 支持老版本 | ✅ 支持 MinerU 最新版本镜像 |
| **小红书 Dots 解析** | ❌ | ✅ |
| **PaddleOCR-VL 解析** | ❌ | ✅ |
| **多模态图片理解** | ❌ | ✅ |
| **RAG 评估系统** | ❌ | ✅ |
| **权限管理** | RBAC 简略版 | ✅ RBAC 完整版本,额外作用于agent、聊天助手、文件等 |
| **分块策略** | 正则、语义、标题、父子分块 | ✅ 解析分块全面优化,新增标题层级切割以及标题自动补充、父子分块支持编辑 |
| **版本兼容** | 适配 v0.20.1 | ✅ 适配 RAGFlow v0.20.5 |
| **企业集成** | ✅ 企业微信集成 | ✅ Dify 深度集成 |
| **高级分析** | ❌ | ✅ 使用统计分析 |
| **技术支持** | 🔧 社区支持 | 🔧 专业技术支持 |
| **商业授权** | ❌ | ✅ 商业使用许可 |

### 商业版增强特性

- **RBAC 权限管理**:基于角色的访问控制,精细化权限分配
- **Markdown**:智能分块策略,含图片理解,分块标题补充,提升检索精度和问答质量
- **版本兼容**:适配最新 RAGFlow v0.20.5,持续更新支持
- **企业级安全**:数据加密、审计日志、合规性管理
- **性能优化**:专业性能调优,支持大规模并发
- **定制开发**:根据企业需求定制功能模块
- **专业支持**:根据企业需要,提供增值技术支持,快速响应

> 💡 **获取商业版**:微信联系 `skycode007`(备注"商业版咨询")

### 🏗️ 系统架构

KnowFlow 采用分布式微服务架构,通过独立的服务组件为 RAGFlow 提供增强功能:

```mermaid
graph TB
 subgraph "用户端"
 User[👤 用户]
 Browser[🌐 浏览器]
 User --> Browser
 end

subgraph "RAGFlow 生态系统"
 direction TB
 subgraph "RAGFlow 核心服务"
 RF_Frontend[RAGFlow 前端<br/>端口: 80/443]
 RF_Backend[RAGFlow 后端<br/>端口: 9380]
 RF_DB[(RAGFlow 数据库<br/>MySQL)]
 RF_ES[(Elasticsearch<br/>端口: 9200)]
 RF_Minio[(MinIO 存储<br/>端口: 9000)]
 RF_Redis[(Redis 缓存<br/>端口: 6379)]
 end
 
 subgraph "KnowFlow 扩展服务"
 direction TB
 KF_Backend[KnowFlow 后端<br/>端口: 5000<br/>• 用户管理<br/>• 团队协作<br/>• MinerU集成<br/>• API Token管理]
 KF_Gotenberg[Gotenberg 文档转换<br/>端口: 3000<br/>• PPT/Word/Excel转PDF<br/>• 文档格式标准化]
 
 subgraph "MinerU 解析引擎"
 MinerU_API[MinerU API 服务<br/>端口: 8888<br/>• OCR 文字识别<br/>• 图像提取<br/>• 文档结构分析]
 MinerU_VLM[VLM 视觉模型<br/>端口: 30000<br/>• 图像理解<br/>• 多模态分析]
 end
 end
 end

%% 用户访问流程
 Browser --> RF_Frontend
 
 %% RAGFlow 内部服务通信
 RF_Frontend --> RF_Backend
 RF_Backend --> RF_DB
 RF_Backend --> RF_ES
 RF_Backend --> RF_Minio
 RF_Backend --> RF_Redis
 
 %% RAGFlow 与 KnowFlow 集成
 RF_Frontend -.->|API 调用| KF_Backend
 RF_Backend -.->|共享数据库| RF_DB
 
 %% KnowFlow 内部服务通信
 KF_Backend --> KF_Gotenberg
 KF_Backend --> MinerU_API
 MinerU_API --> MinerU_VLM
 
 %% KnowFlow 与 RAGFlow 数据层集成
 KF_Backend --> RF_DB
 KF_Backend --> RF_ES
 KF_Backend --> RF_Minio
 KF_Backend --> RF_Redis
```

**架构特点:**
- **🔌 独立服务**:KnowFlow 作为独立微服务运行,不修改 RAGFlow 核心代码
- **🔗 API 集成**:通过 RESTful API 与 RAGFlow 前端无缝集成
- **💾 共享数据层**:复用 RAGFlow 的数据库、存储等基础设施
- **⚡ 高性能解析**:集成 MinerU 2.x 引擎,支持 GPU 加速
- **📄 格式转换**:内置 Gotenberg 服务,支持多种文档格式转换

### 💡 核心功能

| 📚 **智能文档解析** | 🧠 **增强检索问答** | 👥 **企业级管理** | 🔌 **开放集成** |
|-------------------|-------------------|------------------|----------------|
| • MinerU2.x OCR引擎<br>• 图文混排输出<br>• 多种分块策略<br>• 20+文档格式支持 | • 精准语义检索<br>• 上下文感知问答<br>• 多模态内容理解<br>• 实时知识更新 | • RBAC权限管理<br>• 团队协作空间<br>• 纯离线部署<br>• 企业微信集成<br>• LDAP/SSO支持 | • 插件化架构<br>• API开放接口<br>• 自定义扩展<br>• 第三方系统集成 |

</div>

### 🌟 核心优势

| 🌟 | **KnowFlow 优势** |
|----|-------------------|
| 🔌 | **插件化架构**:无缝兼容 RAGFlow 任意版本,所有增强均可热插拔,升级无忧 |
| 🏗️ | **微服务设计**:通过独立服务方式增强 RAGFlow,不修改核心代码 |
| 🧩 | **分块策略丰富**:支持多种分块算法,检索更精准,适配多场景文档 |
| 🏢 | **企业级特性**:MinerU2.x OCR 引擎、RBAC权限管理、纯离线部署、企业微信、LDAP/SSO |
| 📈 | **最佳实践集成**:持续吸收社区优质方案,助力企业高效落地 |
| 🔧 | **简化部署**:一键安装脚本,Docker Compose 开箱即用 |

</div>

---

## 🚀 快速开始

### 方式一:Docker Compose 部署(推荐)

#### 前置要求
- Docker 20.10+ 
- Docker Compose 2.0+
- 至少 8GB 内存
- 可选:NVIDIA GPU + nvidia-container-toolkit(GPU加速)

#### 1. 启动文档解析服务

可以在 MinerU 和 Dots 服务中任选一种,推荐 Dots ,MarkDown 文件标题识别效果更好。

##### 1. 启动 MinerU 镜像

基于 SGLang 的 MinerU 完全离线部署方案,镜像包含所有必要的模型文件,无需运行时下载:

**SGLang 模式(推荐)- 支持所有后端模式**
```bash
docker run -d \
 --gpus all \
 -p 8888:8888 \
 -p 30000:30000 \
 -e MINERU_MODEL_SOURCE=local \
 -e SGLANG_MEM_FRACTION_STATIC=0.8 \
 --name mineru-sglang \
 zxwei/mineru-api-full:v2.1.11
```

**Pipeline 模式 - 仅支持标准 Pipeline 后端**
```bash
docker run -d \
 --gpus all \
 -p 8888:8888 \
 --name mineru-pipeline \
 -e MINERU_MODEL_SOURCE=local \
 -e INSTALL_TYPE=core \
 zxwei/mineru-api-full:v2.1.11
```

> 💡 **镜像特性:**
> - **完全离线部署**: 所有模型文件已预下载并打包在镜像中
> - **最新版本**: 使用 MinerU v2.1.11 最新版本
> - **SGLang 集成**: 基于 SGLang v0.4.7-cu124 官方镜像
> - **全功能支持**: 支持 Pipeline 和 VLM 两种模式
> - **高性能**: GPU 加速推理,支持 CUDA 12.4
> - **智能启动**: 支持环境变量配置,灵活的参数调优

##### 2. MinerU 服务地址配置

在 `/knowflow/server/services/config/settings.yaml` 配置文件中,配置 MinerU 服务地址以及解析模式:

```bash
 fastapi:
 # FastAPI 服务地址
 # 本地开发: http://localhost:8888
 # Docker部署: http://host.docker.internal:8888 (Docker Desktop)
 # 或 http://宿主机IP:8888 (Linux Docker)
 url: "http://宿主机IP:8888"
 
 # HTTP 请求超时时间(秒)
 timeout: 30000

# VLM 后端配置
 vlm:
 sglang:
 # SGLang 服务器地址(vlm-sglang-client 后端需要)
 # Docker部署时同样需要使用宿主机IP或容器网络地址
 server_url: "http://宿主机IP:30000"
```

##### 1. 启动 Dots 镜像

进入到 `knowflow/dots` 目录下, 执行拉取 Dots 镜像脚本,该脚本可以自动下载模型以及下载 Dots 镜像。

```bash
cd knowflow/dots
./deploy.sh
```

默认端口是 8000,如有冲突,可以手动调整 compose 文件。

##### 2. Dots 服务地址配置

在 `/knowflow/server/services/config/settings.yaml` 配置文件中,配置 Dots 服务地址以及解析模式:

```bash
dots:
 # VLLM 服务配置
 vllm:
 # DOTS OCR 服务地址
 # 远程服务示例: http://{ip}:8000
 # 本地服务示例: http://localhost:8000
 url: "http://localhost:8000"
 
 # 模型名称(根据部署配置调整)
 model_name: "dotsocr-model"
 
 # 请求超时时间(秒)
 timeout: 300
 
 # 生成参数
 temperature: 0.1
 top_p: 1.0
 max_completion_tokens: 16384
 
```

#### 2. 启动 KnowFlow 容器,开始使用

1. 拉取本项目代码:

```bash
git clone https://github.com/weizxfree/KnowFlow.git
```

2. 进入到 `docker` 目录执行(此步骤和 RAGFlow 官方一致):

如有 GPU 则选择:
```bash
docker compose -f docker-compose-gpu.yml up -d
```

无 GPU 则选择:
```bash
docker compose -f docker-compose.yml up -d
```

访问地址:`http://服务器IP:80`,进入 KnowFlow 首页

#### 3. 默认管理员账户

系统启动后,请使用以下默认超级管理员账户登录:

```
邮箱:admin@gmail.com
密码:admin
```

> 💡 **安全提示:** 首次登录后,请及时修改默认密码以确保系统安全。

### 方式二:源码部署

#### 前置要求
- Python 3.9+
- Node.js 16+ 
- pnpm
- MinerU 服务(参考上述步骤)

#### KnowFlow 后端部署

1. **安装 Python 依赖**
```bash
cd knowflow/server
python3 -m venv venv
source venv/bin/activate # Windows: venv\Scripts\activate
pip install -r requirements.txt
```

2. **启动文件转换服务(可选)**
```bash
# 支持 PDF 以外文件格式需要启动此服务
docker run -d -p 3000:3000 gotenberg/gotenberg:8
```

3. **执行 install 脚本,初始化环境变量**

```bash
cd knowflow/
./scripts/install.sh --local
```

4. **启动 knowflow 后端服务**
```bash
python3 app.py
```

#### RAGFlow 后端部署

1. **修改 docker/entrypoint.sh 文件**
```bash
# 注释掉 nginx 行
# /usr/sbin/nginx
```

2. **激活 Python 虚拟环境**
```bash
source .venv/bin/activate
export PYTHONPATH=$(pwd)
```

3. **配置 HuggingFace 镜像(可选)**
```bash
# 如果无法访问 HuggingFace,设置镜像站点
export HF_ENDPOINT=https://hf-mirror.com
```

4. **检查配置文件**
确保 `conf/service_conf.yaml` 中所有主机和端口配置正确。

5. **启动后端服务**

方案一:

```bash
# 设置内存分配器和启动任务执行器
JEMALLOC_PATH=$(pkg-config --variable=libdir jemalloc)/libjemalloc.so
LD_PRELOAD=$JEMALLOC_PATH python rag/svr/task_executor.py 1

# 启动 API 服务器
python api/ragflow_server.py
```

方案二:

```bash
./local_entrypoint.sh
```

#### RAGFlow 前端部署

1. **安装 Node.js 依赖**
```bash
cd web
pnpm install
```

2. **启动开发服务器**
```bash
pnpm dev
```

浏览器访问启动后的地址,即可进入系统。

---

## 📋 功能详解

### 🎨 全新 UI 界面

基于 RAGFlow v0.20.1 二次开发,提供更加现代化的用户界面:

### 👥 用户后台管理系统

管理员可以进行统一的管理:

**核心特性:**
- **RBAC权限管理**:基于角色的访问控制,精细化权限分配
- **纯离线部署**:支持完全离线环境部署,满足高安全性要求
- 移除前端用户注册通道,管理员统一管理用户
- 用户管理、团队管理、模型配置管理
- 新用户自动加入创建时间最早用户的团队
- 继承团队模型配置,降低配置复杂度

### 📄 图文混排输出

**支持格式:** PPT、PNG、Word、DOC、Excel 等 20+ 种常见文件格式

**分块策略:**
1. **文档结构分块**:基于文档原生结构进行智能分块
2. **按标题分块**:根据标题层级自动划分内容块
3. **RAGFlow 原分块**:保持与官方完全一致的分块规则
4. **父子分块**:父块较大用于补充上下文,子块用于向量检索
5. **DOTS 解析**:先进的文档智能解析引擎,支持复杂版式和多模态内容

### 💼 企业微信集成

支持企业微信应用,可将企业微信作为聊天机器人入口:

详细配置方式参照 `server/services/knowflow/README.md`

---

## ⚙️ 高级配置

### 🔧 MinerU 高级配置

#### 环境变量配置

通过环境变量自定义 MinerU 启动行为:

```bash
# 自定义 SGLang 服务器参数
docker run -d \
 --gpus all \
 -p 8888:8888 \
 -p 30000:30000 \
 -e MINERU_MODEL_SOURCE=local \
 -e SGLANG_TP_SIZE=2 \
 -e SGLANG_MEM_FRACTION_STATIC=0.9 \
 -e SGLANG_ENABLE_TORCH_COMPILE=true \
 --name mineru-sglang-custom \
 zxwei/mineru-api-full:v2.1.11
```

#### 配置文件挂载

**方法一:环境变量文件**
```bash
# 创建本地 .env 文件
cp .env.example .env
vim .env

# 挂载配置文件
docker run -d \
 --gpus all \
 -p 8888:8888 \
 -p 30000:30000 \
 -v $(pwd)/.env:/app/.env \
 -v $(pwd)/mineru.json:/root/mineru.json \
 -e MINERU_MODEL_SOURCE=local \
 --name mineru-sglang \
 zxwei/mineru-api-full:v2.1.11
```

**方法二:完整配置挂载(生产环境推荐)**
```bash
# 创建配置目录
mkdir -p config
cp .env config/
cp mineru.json config/

# 挂载整个配置目录
docker run -d \
 --gpus all \
 -p 8888:8888 \
 -p 30000:30000 \
 -v $(pwd)/config/.env:/app/.env \
 -v $(pwd)/config/mineru.json:/root/mineru.json \
 -v $(pwd)/data:/app/data \
 -v $(pwd)/output:/app/output \
 -e MINERU_MODEL_SOURCE=local \
 --name mineru-sglang \
 zxwei/mineru-api-full:v2.1.11
```

#### 环境变量配置示例

**.env 文件配置**:
```bash
# 基础配置
INSTALL_TYPE=all
MINERU_MODEL_SOURCE=local
API_PORT=8888
SGLANG_PORT=30000

# SGLang 性能参数
SGLANG_TP_SIZE=2 # 张量并行大小
SGLANG_DP_SIZE=1 # 数据并行大小
SGLANG_MEM_FRACTION_STATIC=0.8 # 内存分配比例
SGLANG_ENABLE_TORCH_COMPILE=true # 启用编译优化
SGLANG_MAX_SEQ_LEN=8192 # 最大序列长度
SGLANG_BATCH_SIZE=64 # 批处理大小

# 高级配置
STARTUP_WAIT_TIME=20 # 启动等待时间
LOG_LEVEL=INFO # 日志级别
VERBOSE=true # 详细日志
```

#### 常见配置场景

**高性能配置(多 GPU)**
```bash
SGLANG_TP_SIZE=4
SGLANG_MEM_FRACTION_STATIC=0.85
SGLANG_ENABLE_TORCH_COMPILE=true
SGLANG_MAX_SEQ_LEN=16384
SGLANG_BATCH_SIZE=128
```

**内存受限环境**
```bash
SGLANG_TP_SIZE=1
SGLANG_MEM_FRACTION_STATIC=0.7
SGLANG_MAX_SEQ_LEN=4096
SGLANG_BATCH_SIZE=32
```

**仅 API 服务(不启动 SGLang)**
```bash
INSTALL_TYPE=core
```

#### MinerU 本地调试(开发环境)

如果需要在本地环境进行开发调试:

```bash
# 1. 安装 Python 依赖(注意:zsh 需要用引号包围方括号)
pip install "mineru[core]" fastapi uvicorn python-multipart

# 2. 设置环境变量
export MINERU_DEVICE_MODE=cpu
export MINERU_MODEL_SOURCE=modelscope

# 3. 进入项目目录
cd knowflow/web_api

# 4. 启动本地服务
python app.py
```

**配置 settings.yaml:**
```yaml
mineru:
 fastapi:
 # 本地开发服务地址
 url: "http://localhost:8888"
 
 vlm:
 sglang:
 # 本地SGLang服务地址(如果使用vlm-sglang-client后端)
 server_url: "http://localhost:30000"
```

#### DOTS 解析使用

**配置 DOTS 解析**
1. 在知识库设置中选择"DOTS"解析方式
2. 支持复杂文档版式和多模态内容理解
3. 提供更准确的文档结构识别

**使用步骤**
```bash
# 1. 创建知识库时选择 DOTS 解析器
# 2. 上传文档自动使用 DOTS 解析
# 3. 获得更精准的图文混排输出
```

#### API 使用示例

**健康检查**
```bash
curl http://localhost:8888/health
```

**文档解析 API**
```bash
# 上传文档进行解析
curl -X POST "http://localhost:8888/file_parse" \
 -F "file=@document.pdf" \
 -F "backend=pipeline"
```

---

## 🔧 编译 Docker(开发者)

### 编译 KnowFlow-Server 镜像

```bash
# 后端镜像
docker buildx build --platform linux/amd64 --target backend -t zxwei/knowflow-server:v0.3.0 --push .

# 前端镜像
docker buildx build --platform linux/amd64 --target frontend -t zxwei/knowflow-web:v0.3.0 --push .
```

### 编译 KnowFlow 全镜像

```bash
# 安装 uv
sudo snap install astral-uv --classic

# 安装 libicu
sudo apt-get update
sudo apt-get install -y python3.12-dev build-essential pkg-config libicu-dev

uv run download_deps.py
docker build -f Dockerfile.deps -t infiniflow/ragflow_deps .
docker build --build-arg LIGHTEN=1 -f Dockerfile -t infiniflow/ragflow:nightly-slim .

docker tag infiniflow/ragflow:nightly-slim zxwei/knowflow:v2.0.2
docker push zxwei/knowflow:v2.0.2

vim docker/.env 
RAGFLOW_IMAGE=infiniflow/ragflow:nightly-slim

```

---

## 开启管理员管理功能

默认注册的账号不具备管理员权限,如需使用管理功能,需要对账号进行授权。

运行 KnowFlow 之后,执行 `docker/set_superuser.sh` 脚本:

```bash
 ./set_superuser.sh set xxxx@xxx.com 
```

---

## 📋 TODO 清单

- [x] 支持更多文档格式的 MinerU 解析
- [x] 增强 MarkDown 文件的分块规则
- [x] 优化 Excel 文件分块
- [x] MinerU 2.0 接入
- [x] RAGFlow 前端 UI 源码开源
- [x] API Token 自动生成机制
- [x] MinerU 支持自动问题,自动关键词,Raptor,知识图谱 
- [ ] 文档审批工作流

---

## ❓ 常见问题

### 1. MinerU 镜像选择与特性

**zxwei/mineru-api-full:v2.1.11(推荐):**
- ✅ **完全离线部署**: 所有模型文件已预下载并打包在镜像中
- ✅ **最新版本**: 使用 MinerU v2.1.11 最新版本
- ✅ **SGLang 集成**: 基于 SGLang v0.4.7-cu124 官方镜像
- ✅ **全功能支持**: 支持 Pipeline 和 VLM 两种模式
- ✅ **高性能**: GPU 加速推理,支持 CUDA 12.4
- ✅ **智能启动**: 默认支持环境变量配置,灵活的参数调优

### 2. 如何启用 GPU 加速?

1. **安装 nvidia-container-toolkit**
```bash
# 添加源
distribution=$(. /etc/os-release;echo $ID$VERSION_ID)
curl -s -L https://nvidia.github.io/libnvidia-container/gpgkey | sudo apt-key add -
curl -s -L https://nvidia.github.io/libnvidia-container/$distribution/libnvidia-container.list | \
 sudo tee /etc/apt/sources.list.d/nvidia-container-toolkit.list

# 安装组件
sudo apt-get update
sudo apt-get install -y nvidia-container-toolkit

# 重启 Docker
sudo systemctl restart docker
```

2. **启动容器时使用 GPU**
确保启动命令包含 `--gpus=all` 参数

3. **配置 GPU 后端**
```yaml
mineru:
 default_backend: "vlm-sglang-client" # 使用 VLM 后端
```

### 3. MinerU 故障排除

#### 常见问题

**1. 构建时间过长**
- 模型下载需要时间,请耐心等待
- 建议使用 ModelScope 源(国内网络更快)

**2. 内存不足**
- 确保 Docker 有足够内存(建议 8GB+)
- 调整 `SGLANG_MEM_FRACTION_STATIC` 参数
- 可以分阶段构建或使用更大的机器

**3. GPU 不可用**
- 确保安装了 nvidia-docker2
- 检查 CUDA 驱动版本兼容性

**4. SGLang 服务启动失败**
- 检查 GPU 内存是否足够
- 调整 `SGLANG_TP_SIZE` 和 `SGLANG_MEM_FRACTION_STATIC`
- 增加 `STARTUP_WAIT_TIME` 等待时间

**5. 环境变量不生效**
- 确保 `.env` 文件格式正确(无空格、正确的键值对)
- 检查文件挂载路径是否正确
- 使用 `docker exec` 进入容器检查环境变量

**6. 端口冲突**
- 修改 `API_PORT` 和 `SGLANG_PORT` 环境变量
- 确保宿主机端口未被占用:
 - MinerU API 服务:8888
 - SGLang 服务:30000
 - KnowFlow 前端:8081
 - KnowFlow 后端:5000

**7. 配置文件挂载问题**
- 确保配置文件路径正确且文件存在
- 检查文件权限(建议 644 权限)
- 验证 JSON 格式是否正确(使用 `jq` 工具验证)
- 确保挂载路径与容器内路径匹配

**8. 模型路径配置错误**
- 检查 `mineru.json` 中的 `models-dir` 配置
- 确保模型文件在指定路径存在
- 验证模型文件完整性

#### 日志查看与调试

```bash
# 查看容器日志
docker logs mineru-sglang

# 实时查看日志
docker logs -f mineru-sglang

# 进入容器检查配置
docker exec -it mineru-sglang bash

# 检查环境变量
docker exec mineru-sglang env | grep -E "(SGLANG|API|MINERU)"

# 验证配置文件
docker exec mineru-sglang cat /app/.env
docker exec mineru-sglang cat /root/mineru.json

# 检查模型文件
docker exec mineru-sglang ls -la /app/models/

# 验证 JSON 配置格式
docker exec mineru-sglang jq . /root/mineru.json
```

**网络连接问题:**
检查防火墙设置和容器网络配置

**图片显示问题:**
确保聊天助手提示词包含图片显示指令:

> 请参考{knowledge}内容回答用户问题。<br>
> 如果知识库内容包含图片,请在回答中包含图片URL。<br>
> 注意这个 html 格式的 URL 是来自知识库本身,URL 不能做任何改动。<br>
> 请确保回答简洁、专业,将图片自然地融入回答内容中。

### 4. 性能优化建议

1. **使用 GPU**: 启用 GPU 加速可显著提升处理速度
2. **内存配置**: 为容器分配足够内存(推荐 8GB+)
3. **存储优化**: 使用 SSD 存储可提升 I/O 性能
4. **网络配置**: 如需外网访问,配置适当的防火墙规则

---

## 📄 许可证

**KnowFlow** 采用 [GNU Affero General Public License v3.0 (AGPL-3.0)](LICENSE) 开源许可证。

### ✅ 您可以自由地:
- **使用**:个人学习、研究、开发和部署
- **修改**:根据需要修改源代码 
- **分发**:分享给他人使用
- **贡献**:提交 PR 和 Issue,参与开源协作

### ⚠️ 重要限制条件:
- **源码开放**:如果您修改了 KnowFlow 并通过网络提供服务,必须向用户提供修改后的完整源代码
- **相同许可**:基于 KnowFlow 的衍生作品必须同样采用 AGPL-3.0 许可证
- **版权保留**:保留原始版权声明和许可证信息

### 🏢 商业使用说明
AGPL-3.0 允许商业使用,但有重要约束:
- 如果您将修改版本作为网络服务提供,必须开源所有修改
- 如果这不符合您的商业需求,请联系获取商业许可

### 📞 商业许可咨询
- 💬 微信:skycode007(备注"商业授权咨询")

> **注意**:AGPL-3.0 是一个严格的 copyleft 许可证,特别适用于网络服务。使用前请仔细阅读 [完整许可证条款](LICENSE)。

---

## 🤝 社区与支持

### 💬 交流群

如有需求或问题建议,可加入交流群讨论。

加微信 `skycode007`,备注"加群"即可。

### 📢 更新信息

项目持续更新中,更新日志会在微信公众号 **[KnowFlow 企业知识库]** 发布,欢迎关注。

[![Star History Chart](https://api.star-history.com/svg?repos=weizxfree/KnowFlow&type=Date)](https://star-history.com/#weizxfree/KnowFlow&Date)

### 🙏 鸣谢

本项目基于以下开源项目开发:

- [ragflow](https://github.com/infiniflow/ragflow) - 核心 RAG 框架

---

<div align="center">
 <p>⭐ 如果这个项目对您有帮助,请不要忘记点个 Star!</p>
 <p>🚀 让我们一起构建更好的企业知识库解决方案!</p>
</div>

GNU AFFERO GENERAL PUBLIC LICENSE Version 3 Copyright (C) 2007 Free Software Foundation, Inc. This project is licensed under the GNU Affero General Public License v3.0 (AGPL v3). For the complete license text, please visit: https://www.gnu.org/licenses/agpl-3.0.txt Key points of AGPL v3: - You can use, modify, and distribute this software - If you modify and distribute, you must make source code available - If you run this software as a network service, you must provide source code to users - All derivative works must also be licensed under AGPL v3