MaxKb 源码启动环境部署教程

1、环境准备

• python >= 3.11.0 （必须！！！）
• poetry

这里使用 conda 管理，这里默认已经有了 conda

本项目目录在 D://project/MaxKB

【注意】：main 分支为开发分支，本项目基于此分支作为部署，建议不要使用此分支，使用他们的发布分支

可以使用这些发布的分支，开发分支他们有bug也照样会上传的，他们的开发环境应该是mac ，对Windows用户不是很友好

2、前期准备工作

在当前磁盘目录创建 opt和 tmp两个目录，如我现在的项目在 D盘，那么就创建在 D盘目录下。

创建配置文件：opt/maxkb/conf/config.yml

# 数据库链接信息
DB_NAME: maxkb
DB_HOST: 127.0.0.1
DB_PORT: 5432  # 填写你 postgres 的端口，默认 5432
DB_USER: postgres 
DB_PASSWORD: 123456 # 填写 postgres 的密码，安装时设置
DB_ENGINE: django.db.backends.postgresql_psycopg2

DEBUG: false

TIME_ZONE: Asia/Shanghai

# 模型相关配置
# 可以不下，如果想要下载本地模型，就在显目根目录下运行 python installer/install_model.py
# 如果缺少依赖就安装 poetry add pycrawlers transformers （缺少哪个装哪个）

# 模型路径:如果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

3、创建虚拟环境

conda create -n <虚拟环境名称> python=3.11

# 例子
conda create -n maxkb python=3.11

4、切换到虚拟环境

conda activate <虚拟环境名称>