简介

MaxKB4j = Max Knowledge Base for Java，是一款基于Java语言开发的LLM工作流应用和 RAG 的开源LLMOps平台，项目主要借鉴了MaxKB和FastGPT,并将两个的优势结合到一个项目上，使用高性能、高稳定性以及安全可靠的JAVA语言重新设计开发。MaxKB4j广泛应用于 智能客服、企业内部知识库、数据分析、学术研究与教育等场景 。V2新版在V1版本基础上做了大量的优化与重构，修复大量bug，完善大量接口，尤其是工作流方面的代码，相比V1版本代码更加健壮，运行更加稳定，性能更加快速，功能更加丰富！,欢迎大家部署体验！

• 开源地址 ：https://gitee.com/taisan/MaxKB4j

前置知识

1.基础的网络知识：端口，防火墙……
2.Docker 和 Docker Compose 基础知识
3.大模型相关接口和参数
4.RAG 相关知识：向量模型，向量数据库，向量检索

部署架构图

• MongoDB：用于存储全文检索数据
• PostgreSQL：用于存储业务数据和存储向量数据

推荐配置

前置工作

1. 确保网络环境

如果使用OpenAI等国外模型接口，请确保可以正常访问，否则会报错：Connection error 等。

2. 准备 Docker 环境

Linux

# 安装 Docker
curl -fsSL https://get.docker.com | bash -s docker --mirror Aliyun
systemctl enable --now docker
# 安装 docker-compose
curl -L https://github.com/docker/compose/releases/download/v2.20.3/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose
# 验证安装
docker -v
docker-compose -v
# 如失效，自行百度~

Windows

我们建议将源代码和其他数据绑定到 Linux 容器中时，将其存储在 Linux 文件系统中，而不是 Windows 文件系统中。

可以选择直接使用 WSL 2 后端在 Windows 中安装 Docker Desktop。

也可以直接在 WSL 2 中安装命令行版本的 Docker。

开始部署

1. 下载 docker-compose.yml

非 Linux 环境或无法访问外网环境，可手动创建一个目录文件夹（如maxkb4j文件夹），并下载配置文件docker-compose.yml，在这个文件夹下，依据下载的配置文件运行docker。

• 点击下载 docker-compose.yml

2.启动容器

在 docker-compose.yml 同级目录下执行。请确保docker-compose版本最好在2.17以上，否则可能无法执行自动化命令。

# 启动容器
docker-compose up -d

3.访问 MaxKB4J

目前可以通过 ip:8080 直接访问(注意开放防火墙)。登录用户名为 admin，默认密码为 tarzan@123456. 。

如果需要域名访问，请自行安装并配置 Nginx。