MaxKB 是一款基于 LLM 大语言模型的知识库问答系统。MaxKB = Max Knowledge Base，旨在成为企业的最强大脑。
开箱即用：支持直接上传文档、自动爬取在线文档，支持文本自动拆分、向量化、RAG（检索增强生成），智能问答交互体验好；
无缝嵌入：支持零编码快速嵌入到第三方业务系统； 多模型支持：支持对接主流的大模型，包括 Ollama 本地私有大模型（如 Meta
Llama 3、qwen 等）、通义千问、OpenAI、Azure OpenAI、Kimi、智谱 AI、讯飞星火和百度千帆大模型等。
项目的官方地址
源码方式部署的官方文件指导
获取官方的源码
首先需要获取一下官方的源代码，这里建议直接就使用官方的最新发行版就可以。
Pycharm中的个性化配置
这里需要注意的一点是你的本地python环境需要是3.11.x的版本，这里我使用的是python3.11.9
pycharm集成开发环境中配置python环境地址
这里使用虚拟环境便于后期的依赖包管理，这里按照这样子配置就可以。
根目录下执行安装poetry包管理器
pip install poetry
配置连接数据库文件信息
准备配置文件
# 文件名：config_example.yml
# 数据库配置
DB_NAME: maxkb
DB_HOST: localhost
DB_PORT: 5433
DB_USER: root
DB_PASSWORD: shuyixiao
DB_ENGINE: django.db.backends.postgresql_psycopg2
# 模型相关配置
# 模型路径 如果EMBEDDING_MODEL_NAME是绝对路径则无效,反之则会从https://huggingface.co/下载模型到当前目录
EMBEDDING_MODEL_PATH: /opt/maxkb/model/
# 模型名称 如果模型名称是绝对路径 则会加载目录下的模型,如果是模型名称,则会在https://huggingface.co/下载模型 模型的下载位置为EMBEDDING_MODEL_PATH
EMBEDDING_MODEL_NAME: /opt/maxkb/model/shibing624_text2vec-base-chinese
配置数据库
这里是重点一定要注意，由于数据库使用的是postgresql，这里真心不建议使用安装包安装，踩坑踩了很久，最后还是使用Docker的方式进行安装的，所以也希望大家别白嫖我给我点个关注，可以欢迎大家加入我的社区与我进行交流
编写postgresql打包文件
# Use the official PostgreSQL 15 image as a base
FROM postgres:15
# Install necessary packages and clone the pgvector repository
RUN apt-get update && \
apt-get install -y \
postgresql-server-dev-15 \
build-essential \
git && \
git clone https://github.com/pgvector/pgvector.git
# Build and install the pgvector extension
RUN cd pgvector && \
make && \
make install
# Clean up
RUN apt-get remove --purge -y \
build-essential \
git && \
apt-get autoremove -y && \
apt-get clean && \
rm -rf /var/lib/apt/lists/* /pgvector
# Set the default command to run when starting the container
CMD ["postgres"]
执行打包命令打包
一定要在文件所在目录下执行不然会报错
docker build --no-cache -t postgres-with-vector .
运行容器
由于我本地已经使用安装包的方式装了postgresql，所以这里使用5433端口
docker run --name my-postgres -e POSTGRES_USER=root -e POSTGRES_PASSWORD=shuyixiao -e POSTGRES_DB=maxkb -p 5433:5432 -d postgres-with-vector
验证安装：检查 pgvector 扩展文件是否安装正确
此命令应列出所有可用的扩展。专门查找 pgvector.control .
docker exec -it my-postgres ls /usr/share/postgresql/15/extension/
创建扩展：
docker exec -it my-postgres psql -U root -d maxkb -c "CREATE EXTENSION vector;"
验证扩展：
docker exec -it my-postgres psql -U root -d maxkb -c "\dx"
配置数据库信息
CREATE DATABASE "maxkb";
\c "maxkb";
CREATE EXTENSION "vector";
启动后端项目
需要注意一点就是要在跟目录下面执行
创建venv
这一步要是上面配置过pycharm的环境就不需要走这一步了
#win
python -m venv venv
#linux/mac
python3 -m venv venv
激活venv
#win
.\venv\Scripts\activate
#linux/mac
source venv/bin/activate
安装后端需要的依赖
poetry install
这里由于之前安装过，所以执行起来就很快
启动项目
python main.py start
启动前端项目
这里启动前端项目就比较简单，由于这个项目是使用vue3开发的，所以就是本地的node.js版本不能太低不然会报错
要是大家不知道如何动态切换本机的node版本可以查看我的另外一篇文章 如何使用 nvm-windows 这个工具来管理你电脑上的Node.js版本
先在ui执行安装前端需要的依赖
npm install
启动项目
最后就是效果的展示
初始的账号admin 密码 MaxKB@123… 登录之后会提示你修改密码
踩坑与总结
- 首先部署时候一定要看官网的配置要求，数据库和python版本一定要对应上，不要太高或者太低。
- 数据库这块真心推荐使用docker的方式运行不然真的有的依赖真心难装。下面这个截图就是我之前本地部署时候总是出现的报错，
好在最后通过docker方式部署数据库解决了
最后说一句(求关注，别白嫖我)
如果这篇文章对您有所帮助，或者有所启发的话，帮忙扫描下发二维码关注一下，您的支持是我坚持写作最大的动力。
求一键三连：点赞、转发、在看。
关注公众号：【舒一笑的架构笔记】，在公众号中回复：面试、代码神器、开发手册、时间管理有超赞的粉丝福利，另外回复：加群，可以跟很多BAT大厂的前辈交流和学习。
