MaxKB

MaxKB（Max Knowledge Brain）是一款基于 LLM 大语言模型的知识库问答系统。其核心目标是通过结合大模型的生成能力与结构化知识库的检索功能，提升问答的准确性和实用性。

MaxKB 中默认集成了 PostgreSQL 15，并借助开源向量插件 pgvector 兼顾了关系数据和向量数据的存储。本文介绍了使用 VexDB 作为 MaxKB 数据存储并构建 RAG 的工作流程。

说明

当前仅支持 MaxKB V1 版本。

前提条件

在部署 MaxKB 之前，请确保已经参考 安装 VexDB 的内容完成了数据库的安装，并部署了 Python3 环境。

安装 MaxKB

1. 从工程师处获取适配了 VexDB 的 MaxKB 镜像文件压缩包，参考以下命令加载到本地环境。

   docker load -i vexdb.maxkb_{version}.tar.gz
   

2. 手动在宿主机创建映射目录，并参考以下步骤分配目录权限：

   # 在 docker-compose.yaml 文件目录下执行
   mkdir vexdb
   chown 1000:1000 vexdb
   cd vexdb
   mkdir lic
   chown 1000:1000 lic
   mkdir data
   chown 1000:1000 data
   mkdir backup
   chown 1000:1000 backup
   mkdir backup_log
   chown 1000:1000 backup_log
   

3. 编辑 docker-compse.yaml，填写 VexDB 连接信息。
   Docker-Compose.yaml 是 Docker Compose 的配置文件，用于定义和启动多容器 Docker 应用，可以使用相关命令一键启动文件中定义的所有服务。

   services:
   # 无需同时安装vexdb 则注释下面的配置
   #db:
   #    image: vexdb/vexdb-vector:3.0.8.25159
   #    container_name: vexdb
   #    restart: always
   #    environment:
   #    - VB_DB=maxkb
   #    - VB_USERNAME=maxkb
   #    - VB_PASSWORD=Maxkb@123456
   #    ports:
   #    - '5434:5432'
   #    volumes:
   #    - ./vexdb/lic:/home/vexdb/vexdb/lic
   #    - ./vexdb/data:/home/vexdb/data
   #    - ./vexdb/backup:/home/vexdb/backup
   #    - ./vexdb/backup_log:/home/vexdb/backup_log
   #    healthcheck:
   #    test: ["CMD-SHELL", "pg_isready"]
   #    interval: 10s
   #    timeout: 5s
   #    retries: 5
   
   app:
       image: vexdb/maxkb:v1.0.1
       container_name: maxkb
       restart: always
       # depends_on:
       #   db:
       #     condition: service_healthy
       environment:
       - MAXKB_CONFIG_TYPE=ENV
       - MAXKB_VECTOR_STORE_NAME=vexdb
       - MAXKB_DB_ENGINE=django_vexdb_backend
       - MAXKB_DB_NAME=maxkb
       - MAXKB_DB_HOST=vexdb
       - MAXKB_DB_PORT=5432
       - MAXKB_DB_USER=maxkb
       - MAXKB_DB_PASSWORD=Maxkb@123456
       - MAXKB_DB_MAX_OVERFLOW=80
       - MAXKB_EMBEDDING_MODEL_NAME=/opt/maxkb/model/embedding/shibing624_text2vec-base-chinese
       - MAXKB_EMBEDDING_MODEL_PATH=/opt/maxkb/model/embedding
       - MAXKB_SANDBOX=1
       - LANG=en_US.UTF-8
       - PIP_TARGET=/opt/maxkb/app/sandbox/python-packages
       - PYTHONPATH=/opt/maxkb/app/sandbox/python-packages
       - PYTHONUNBUFFERED=1
       ports:
       - "8080:8080"
       volumes:
       - ./maxkb/data:/opt/maxkb/app/data
   

4. Docker Compose 一键启动。

   docker compose up -d
   

访问 MaxKB

可以通过服务器ip+8080端口号直接访问 MaxKB。8080 是 MaxKB 的默认端口，请注意防火墙配置。

使用默认的管理员用户名 admin 和默认密码 MaxKB@123.. 即可登录 MaxKB。

更多使用方法和指导，请查阅 MaxKB 官方文档。