MaxKB 开源项目安装与使用教程

【免费下载链接】MaxKB 💬 基于 LLM 大语言模型的知识库问答系统。开箱即用，支持快速嵌入到第三方业务系统，1Panel 官方出品。 项目地址: https://gitcode.com/GitHub_Trending/ma/MaxKB

项目概述

MaxKB（Max Knowledge Brain）是一个强大易用的企业级智能体平台，致力于解决企业AI落地面临的技术门槛高、部署成本高、迭代周期长等问题。该项目由1Panel官方出品，支持快速嵌入到第三方业务系统，为企业提供从基础问答到智能体的渐进式升级路径。

技术架构

MaxKB采用现代化的技术栈构建：

• 前端：Vue.js框架
• 后端：Python/Django框架
• AI框架：LangChain
• 数据库：PostgreSQL + pgvector
• 部署方式：Docker容器化部署

安装准备

环境要求

• Docker环境
• 至少4GB内存
• 支持的操作系统：Linux、Windows、macOS

获取项目代码

git clone https://gitcode.com/GitHub_Trending/ma/MaxKB
cd MaxKB

Docker部署方式

快速启动

使用以下命令快速启动MaxKB容器：

docker run -d --name=maxkb --restart=always -p 8080:8080 -v ~/.maxkb:/opt/maxkb 1panel/maxkb

详细配置

对于Windows系统，使用以下命令：

docker run -d --name=maxkb --restart=always -p 8080:8080 -v C:/maxkb:/opt/maxkb 1panel/maxkb

参数说明

• -p 8080:8080：将容器的8080端口映射到主机的8080端口
• -v ~/.maxkb:/opt/maxkb：将数据目录挂载到本地
• --restart=always：容器异常退出时自动重启

访问系统

1. 启动完成后，打开浏览器访问 http://your_server_ip:8080
2. 使用默认管理员账号登录：
   • 用户名：admin
   • 密码：MaxKB@123..

项目结构解析

核心目录结构

MaxKB/
├── apps/                    # Django应用目录
│   ├── application/        # 应用管理模块
│   ├── chat/              # 聊天功能模块
│   ├── common/            # 公共组件
│   ├── knowledge/         # 知识库管理
│   ├── models_provider/   # 模型提供者
│   ├── system_manage/     # 系统管理
│   └── users/            # 用户管理
├── installer/             # 安装脚本
│   ├── Dockerfile        # Docker构建文件
│   ├── start-all.sh      # 启动脚本
│   └── init.sql         # 数据库初始化脚本
├── ui/                   # 前端界面
│   ├── src/             # Vue源码
│   └── package.json     # 前端依赖配置
└── pyproject.toml       # Python项目配置

主要功能模块

1. 知识库管理：支持文档上传、文本拆分、向量化处理
2. 智能问答：基于RAG技术的问答系统
3. 工作流引擎：支持复杂业务流程编排
4. 模型管理：支持多种大语言模型接入
5. 系统监控：提供系统运行状态监控

配置说明

数据库配置

项目默认使用PostgreSQL数据库，配置位于apps/maxkb/settings/目录中。如果需要修改数据库配置，可以编辑相应的配置文件。

模型配置

支持多种大语言模型接入，包括：

• 本地私有大模型（DeepSeek、Qwen等）
• 国内公共大模型（通义千问、腾讯混元等）
• 国外公共大模型（OpenAI、Claude等）

使用指南

创建知识库

1. 登录系统后，进入"知识库管理"
2. 点击"新建知识库"
3. 上传文档或输入文本内容
4. 系统会自动进行文本处理和向量化

配置问答模型

1. 进入"模型管理"
2. 选择或添加合适的语言模型
3. 配置模型参数和API密钥
4. 测试模型连接状态

构建工作流

1. 进入"工作流管理"
2. 使用可视化编辑器创建流程
3. 配置各个节点的参数
4. 测试并发布工作流

常见问题

端口冲突

如果8080端口已被占用，可以修改映射端口：

docker run -d --name=maxkb -p 9090:8080 -v ~/.maxkb:/opt/maxkb 1panel/maxkb

数据持久化

确保数据目录挂载正确，避免容器重启后数据丢失。

性能优化

对于大规模应用，建议：

• 增加内存分配
• 使用更高性能的硬件
• 优化数据库配置

开发扩展

自定义模型接入

可以参考apps/models_provider/目录中的实现，创建新的模型提供者。

功能扩展

项目采用模块化设计，可以在相应的应用目录中添加新功能。

技术支持

• 官方文档：查看项目中的README文件
• 社区支持：通过技术交流群获取帮助
• 问题反馈：在代码仓库提交Issue

MaxKB作为一个开源的企业级智能体平台，为企业提供了快速构建AI应用的能力，通过简单的部署和配置，即可拥有强大的知识库问答系统。

【免费下载链接】MaxKB 💬 基于 LLM 大语言模型的知识库问答系统。开箱即用，支持快速嵌入到第三方业务系统，1Panel 官方出品。 项目地址: https://gitcode.com/GitHub_Trending/ma/MaxKB