docker部署maxkb

maxkb部署

在线安装

1 部署要求

1.1 服务器配置

部署服务器要求：

• 操作系统：Ubuntu 22.04 / CentOS 7.6 64 位系统
• CPU/内存：4C/8GB 以上
• 磁盘空间：100GB

1.2 端口要求

在线部署 MaxKB 需要开通的访问端口说明如下：

端口	作用	说明
22	SSH	安装、升级及管理使用
8080	Web 服务端口	默认 Web 服务访问端口，可根据实际情况进行更改

2 在线快速部署

MaxKB 支持一键启动，仅需执行以下命令：

# Linux 操作系统
docker run -d --name=maxkb --restart=always -p 8080:8080 -v ~/.maxkb:/var/lib/postgresql/data -v ~/.python-packages:/opt/maxkb/app/sandbox/python-packages registry.fit2cloud.com/maxkb/maxkb

# Windows 操作系统
docker run -d --name=maxkb --restart=always -p 8080:8080 -v C:/maxkb:/var/lib/postgresql/data -v C:/python-packages:/opt/maxkb/app/sandbox/python-packages registry.fit2cloud.com/maxkb/maxkb

待所有容器状态显示为healthy后，可通过浏览器访问 MaxKB：

http://目标服务器 IP 地址:8080

默认登录信息
用户名：admin
默认密码：MaxKB@123..

3 在线升级

根据以下步骤依次执行进行升级：

（1） 下载最新镜像

docker pull registry.fit2cloud.com/maxkb/maxkb

（2）查看并确认上一次数据持久化目录，复制保存

docker inspect maxkb

（3）删除正在运行的、旧版本的 MaxKB 容器

docker rm -f maxkb 

（4）启动并运行新版本的 MaxKB 容器

注意： 务必确认数据持久化目录（即命令行中 -v后的目录）要跟第 (2) 步查看目录保持一致，否则启动后整个系统的数据为空。

docker run -d --name=maxkb --restart=always -p 8080:8080 -v ~/.maxkb:/var/lib/postgresql/data -v ~/.python-packages:/opt/maxkb/app/sandbox/python-packages registry.fit2cloud.com

MaxKB 离线安装包默认内置了命令行运维工具 mkctl，通过执行 mkctl help，可以查看相关的命令说明。

说明：

• 1.5.0 之前版本请使用 kbctl 命令。
• 通过在线安装、1Panel方式安装，并没有内置 mkctl 命令。

Usage:
mkctl [COMMAND] [ARGS...]
mkctl --help

Commands: 
status              查看 MaxKB 服务运行状态
start               启动 MaxKB 服务
stop                停止 MaxKB 服务
restart             重启 MaxKB 服务
reload              重新加载 MaxKB 服务
uninstall           卸载 MaxKB 服务
upgrade             升级 MaxKB 服务
version             查看 MaxKB 版本信息
clean-images        清理 MaxKB 旧版本的相关镜像

---

函数库

MaxKB 支持用户根据自身的业务需求，通过内置函数或自定义函数对获取和查询数据，逻辑判断、信息提取或其它场景的操作。 函数创建完成后，在应用编排时以添加组件的方式调用这些函数，从而更好地满足各种复杂的业务需求。这种组件化的设计不仅提高了工作效率，还使得整个系统更加模块化，便于维护和扩展。

1.内置函数

MaxKB 支持内置函数库，目前包括数据库查询以及页面搜索两种常见的类型，具体包括如下内置函数：

• MySQL 查询
• PostgreSQL 查询
• 博查搜索
• Google Search
• LangSearch

内置函数添加到函数库后，需要配置启动参数，例如数据库连接信息、API Key等，并启用后才可以在高级编排应用中使用。

2.自定义函数¶

2.1 函数依赖包安装¶

如果函数实现需要安装第三方依赖包，可在 maxkb 容器中使用 pip 命令进行安装。

# 进入 maxkb 容器中
docker exec -it maxkb bash

# pip安装第三方依赖，如 pymysql，执行下面命令
pip install pymysql 

2.2 函数创建

点击【创建函数】，打开创建函数对话框。

• 函数名称：函数的 logo 以及函数名称，便于识别。函数 logo 在保存后可自定义上传。
• 描述：函数详细说明以及使用注意事项，会显示在高级编排应用的组件列表中。
• 启动参数：启用参数即函数运行的必要参数，例如 API Key等。将启动参数与输入参数分离，在工作流中仅关注输入参数，同时也避免关键信息的泄露。
• 输入参数：函数的输入参数，参数的数据类别包括：string、int、float、array，可自定义赋值，也可引用参数。
• 函数内容：自定义编写 Python 函数代码，可以引用输入变量。
• 输出参数：Python 代码执行返回的结果。

Python 代码编写完成后，点击【调试】进行代码功能的验证。调试完成后，点击【创建】，即完成函数的创建。

创建成功的函数，可以在【高级编排应用】的设置中，点击【添加组件】->【函数库】中，以添加组件的方式调用这些函数。

3.函数导出/导入¶

函数支持导出和导入，对应的文件后缀为 .fx。

4.复制函数¶

点击函数面板的【复制】按钮，打开复制函数对话框，对原函数内容进行编辑修改后点击【创建】即可快速创建一个新函数。

5.删除函数¶

点击函数面板的【删除】按钮，即可对函数进行删除。

注意： 函数删除后，如果应用引用了该函数，那么在编排页面将显示该函数不可用的提示信息，并且在问答时也会报错。

---

docker ps查看运行的容器

docker stop maxkb停止运行的容器

docker ps -a找到所有的容器

docker start maxkb运行容器

docker rm maxkb移除

---

镜像

是一种包含各种环境或者服务的模板，记录了需要运行某个软件所需要的所有内容。不能修改

容器

基于镜像运行的进程，可以修改。

镜像可从 dockerhub 的网站上拉去 使用 docker pull 镜像作者名字/仓库名 下载本地

docker run -d --name=maxkb -p 8080:8080 -v 容器的目录 宿主机的目录 

导出镜像为tar

docker save id > xxx.tar

导入tar为镜像

docker load < xxx.tar

dockerfile

查看所有镜像

docker image ls

操作容器

docker exec -it ID bash
###
进入容器内部，使用linux命令进行操作和修改
###