MaxKB

https://maxkb.cn/docs/v2
Admin
MaxKB is an enterprise-grade AI agent platform that enables rapid deployment of intelligent...
Tokens:62,395
Snippets:866
Trust Score:7.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Execute MaxKB Installation Script

Source: https://maxkb.cn/docs/v2/installation/offline_installtion.html?q=

Navigate to the extracted installation directory and run the 'install.sh' script to begin the MaxKB installation process. This command should be executed after configuring 'install.conf'.

```bash
# 进入安装包解压缩后目录  
cd maxkb-v2.0.0-x86_64-offline-installer

# 执行安装命令
bash install.sh

```

--------------------------------

### Configure MaxKB Installation Settings

Source: https://maxkb.cn/docs/v2/installation/offline_installtion.html?q=

Edit the 'install.conf' file after extracting the installation package to customize installation directory, service ports, database, and Redis configurations. Changes made here apply to the initial installation.

```bash
# 基础配置
## 安装目录
MAXKB_BASE=/opt
## 服务端口
MAXKB_PORT=8080
## docker 网段设置
MAXKB_DOCKER_SUBNET=172.31.250.192/26

# 数据库配置
## 是否使用外部数据库
MAXKB_EXTERNAL_PGSQL=false
## 数据库地址
MAXKB_PGSQL_HOST=pgsql
## 数据库端口
MAXKB_PGSQL_PORT=5432
## 数据库库名
MAXKB_PGSQL_DB=maxkb
## 数据库用户名
MAXKB_PGSQL_USER=root
## 数据库密码
MAXKB_PGSQL_PASSWORD=Password123@postgres

# Redis配置
## 是否使用外部Redis
MAXKB_EXTERNAL_REDIS=false
## Redis地址
REDIS_HOST=redis
## Redis端口
REDIS_PORT=6379
## Redis数据库
REDIS_DB=0
## Redis密码
REDIS_PASSWORD=Password123@redis

# 镜像配置
## 镜像仓库
MAXKB_IMAGE_REPOSITORY=registry.fit2cloud.com/maxkb
## 镜像名称
MAXKB_IMAGE=maxkb
## 版本号
MAXKB_VERSION=v2.0.0

```

--------------------------------

### Install MaxKB on Linux

Source: https://maxkb.cn/docs/v2/installation/online_installtion.html?q=

Run this command on a Linux system with Docker installed to quickly deploy MaxKB. Ensure Docker is up-to-date.

```bash
# Linux 操作系统
docker run -d --name=maxkb --restart=always -p 8080:8080 -v ~/.maxkb:/opt/maxkb registry.fit2cloud.com/maxkb/maxkb

```

--------------------------------

### Install MaxKB on Linux

Source: https://maxkb.cn/docs/v2/installation/online_installtion.html

Run this command on a Linux system with Docker installed to quickly deploy MaxKB. Ensure Docker is up-to-date.

```bash
docker run -d --name=maxkb --restart=always -p 8080:8080 -v ~/.maxkb:/opt/maxkb registry.fit2cloud.com/maxkb/maxkb
```

--------------------------------

### Install Third-Party Dependencies

Source: https://maxkb.cn/docs/v2/faq/function_library.html?q=

Install necessary Python libraries, such as pymysql, within the MaxKB container to resolve missing dependency errors.

```bash
pip install pymysql

```

--------------------------------

### Install MaxKB on Windows

Source: https://maxkb.cn/docs/v2/installation/online_installtion.html

Execute this command on a Windows system with Docker to deploy MaxKB. Verify Docker version compatibility.

```bash
docker run -d --name=maxkb --restart=always -p 8080:8080 -v C:/maxkb:/opt/maxkb registry.fit2cloud.com/maxkb/maxkb
```

--------------------------------

### Install MaxKB on Windows

Source: https://maxkb.cn/docs/v2/installation/online_installtion.html?q=

Execute this command on a Windows system with Docker to deploy MaxKB. Verify Docker version compatibility.

```bash
# Windows 操作系统
docker run -d --name=maxkb --restart=always -p 8080:8080 -v C:/maxkb:/opt/maxkb registry.fit2cloud.com/maxkb/maxkb

```

--------------------------------

### Configure apt Source for NVIDIA Container Toolkit

Source: https://maxkb.cn/docs/v2/faq/GPU_runOllama.html?q=

Add the NVIDIA Container Toolkit repository to your system's apt sources. This is a prerequisite for installing the toolkit.

```bash
curl -fsSL https://nvidia.github.io/libnvidia-container/gpgkey | sudo gpg --dearmor -o /usr/share/keyrings/nvidia-container-toolkit-keyring.gpg && curl -s -L https://nvidia.github.io/libnvidia-container/stable/deb/nvidia-container-toolkit.list | 
    sed 's#deb https://#deb [signed-by=/usr/share/keyrings/nvidia-container-toolkit-keyring.gpg] https://#g' | 
    sudo tee /etc/apt/sources.list.d/nvidia-container-toolkit.list

```

--------------------------------

### Run New MaxKB Container After Upgrade

Source: https://maxkb.cn/docs/v2/installation/online_installtion.html?q=

Start a new MaxKB container with the updated image. It is critical to use the same data persistence volume mapping as identified in the inspection step to retain all existing data.

```bash
docker run -d --name=maxkb --restart=always -p 8080:8080 -v ~/.maxkb:/opt/maxkb registry.fit2cloud.com/maxkb/maxkb

```

--------------------------------

### Configure NVIDIA Container Toolkit Apt Repository

Source: https://maxkb.cn/docs/v2/faq/GPU_runOllama.html

Adds the NVIDIA container toolkit GPG key and repository to your system's apt sources. This is a prerequisite for installing the toolkit.

```bash
curl -fsSL https://nvidia.github.io/libnvidia-container/gpgkey | sudo gpg --dearmor -o /usr/share/keyrings/nvidia-container-toolkit-keyring.gpg 
&& curl -s -L https://nvidia.github.io/libnvidia-container/stable/deb/nvidia-container-toolkit.list | 
    sed 's#deb https://#deb [signed-by=/usr/share/keyrings/nvidia-container-toolkit-keyring.gpg] https://#g' | 
    sudo tee /etc/apt/sources.list.d/nvidia-container-toolkit.list

```

--------------------------------

### Install NVIDIA Container Toolkit

Source: https://maxkb.cn/docs/v2/faq/GPU_runOllama.html

Installs the NVIDIA container toolkit package, which enables Docker containers to access NVIDIA GPUs. This is essential for GPU acceleration.

```bash
sudo apt-get install -y nvidia-container-toolkit

```

--------------------------------

### Enter MaxKB Container

Source: https://maxkb.cn/docs/v2/faq/system_management.html

Use this command to enter the MaxKB container for database operations. For offline installations, enter the pgsql container instead.

```bash
docker exec -it maxkb bash

```

--------------------------------

### mkctl Command Usage and Help

Source: https://maxkb.cn/docs/v2/installation/cli.html

View available commands and their descriptions for the mkctl CLI tool. This command is only available in offline installations.

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

Commands: 
status              查看 MaxKB 服务运行状态
start               启动 MaxKB 服务
stop                停止 MaxKB 服务
restart             重启 MaxKB 服务
reload              重新加载 MaxKB 服务
uninstall           卸载 MaxKB 服务（不会删除数据）
version             查看 MaxKB 版本信息
clear-images        清理 MaxKB 旧版本的相关镜像

```

--------------------------------

### Download and Run Ollama Model

Source: https://maxkb.cn/docs/v2/faq/GPU_runOllama.html

Executes a command within the running Ollama Docker container to download and start a specified LLM model (e.g., qwen:7b). This allows you to interact with the model.

```bash
# 在线下载并运行模型
docker exec -it ollama ollama run qwen:7b

```

--------------------------------

### Extract MaxKB Installation Package

Source: https://maxkb.cn/docs/v2/installation/offline_installtion.html?q=

Use this command to extract the MaxKB offline installer package on the deployment server. Ensure you are logged in as the root user.

```bash
tar -zxvf maxkb-v2.0.0-x86_64-offline-installer.tar.gz

```

--------------------------------

### Install Third-Party Dependencies in MaxKB Container

Source: https://maxkb.cn/docs/v2/user_manual/tool/tool.html

Use pip to install necessary Python packages within the MaxKB Docker container. This is required if your custom tools depend on external libraries.

```bash
# Enter the MaxKB container
docker exec -it maxkb bash

# Install third-party dependencies, such as pymysql, by executing the following command
pip install pymysql
```

--------------------------------

### Enter MaxKB Container

Source: https://maxkb.cn/docs/v2/faq/function_library.html?q=

Access the MaxKB container to manage dependencies and configurations.

```bash
docker exec -it maxkb bash 

```

--------------------------------

### mkctl Command Usage

Source: https://maxkb.cn/docs/v2/installation/cli.html?q=

View available commands and their descriptions for the mkctl tool. This command is available when MaxKB is installed via the offline package.

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

Commands: 
status              查看 MaxKB 服务运行状态
start               启动 MaxKB 服务
stop                停止 MaxKB 服务
restart             重启 MaxKB 服务
reload              重新加载 MaxKB 服务
uninstall           卸载 MaxKB 服务（不会删除数据）
version             查看 MaxKB 版本信息
clear-images        清理 MaxKB 旧版本的相关镜像
```

--------------------------------

### MaxKB Professional/Enterprise Edition Configuration (Token)

Source: https://maxkb.cn/docs/v2/Skills/MaxKB_Skills.html?q=

Configure environment variables for MaxKB Professional or Enterprise Edition using a Bearer Token for authentication.

```bash
MAXKB_DOMAIN=<你的 MaxKB 服务地址>
MAXKB_WORKSPACE_ID=default
MAXKB_TOKEN=<Bearer Token>
```

--------------------------------

### MaxKB Professional/Enterprise Edition Configuration (Username/Password)

Source: https://maxkb.cn/docs/v2/Skills/MaxKB_Skills.html?q=

Configure environment variables for MaxKB Professional or Enterprise Edition using username and password for authentication.

```bash
MAXKB_DOMAIN=<你的 MaxKB 服务地址>
MAXKB_WORKSPACE_ID=default
MAXKB_USERNAME=<用户名>
MAXKB_PASSWORD=<密码>
```

--------------------------------

### Remove Old MaxKB Container

Source: https://maxkb.cn/docs/v2/installation/online_installtion.html?q=

Stop and remove the currently running MaxKB container before starting the new version. This command forcefully removes the container.

```bash
docker rm -f maxkb

```

--------------------------------

### MaxKB Community Edition Configuration

Source: https://maxkb.cn/docs/v2/Skills/MaxKB_Skills.html?q=

Configure environment variables for MaxKB Community Edition to connect to the MaxKB service using username and password.

```bash
MAXKB_DOMAIN=<你的 MaxKB 服务地址>
MAXKB_USERNAME=<用户名>
MAXKB_PASSWORD=<密码>
MAXKB_WORKSPACE_ID=default
```

--------------------------------

### Docker 容器部署语言包

Source: https://maxkb.cn/docs/v2/user_manual/Customlanguage.html?q=

通过目录挂载方式将语言包同步至 Docker 容器内。

```text
1、在宿主机创建语言包目录（可自定义路径），放入自定义语言包 ZIP 文件

2、启动/重启容器时，添加目录挂载参数，将宿主机目录映射至容器内： 容器固定语言包路径：/opt/maxkb/local/locales

3、若容器内无 /opt/maxkb/local/locales 目录，可进入容器手动创建
```

--------------------------------

### Image Understanding Component Prompt

Source: https://maxkb.cn/docs/v2/faq/maxkb_multimodal_workflow.html?q=

This prompt guides an AI model to analyze and describe an image, extracting text, identifying the core theme, and explaining its purpose, formatted for a Markdown output.

```text
请严格遵循以下步骤，分析并描述提供的图片：

**第一步：全面解析图片视觉信息**
*   **图片内容**：仔细识别并完整、一字不差地提取图片中的所有可见文字。不得进行任何概括、总结或删减，内容格式易读。

**第二步：基于解析生成总结**
*   **归纳核心主题**：根据提取的文字和视觉元素，用一句话精准概括图片的核心主题。此句话将作为你最终回复的标题。
*   **说明图片目的**：结合文字与视觉内容，综合分析这张图片旨在传达的主要信息、目的或功能。

**第三步：格式化输出**
请将你的全部回答内容置于**一个Markdown分段**中，格式要求如下：
*   将第二步中生成的“核心主题”句子，作为该分段的**一级标题**（使用一个 `#`）。
*   在标题下方，依次呈现“图片内容”和“图片目的说明”作为正文内容。

```
Tokens:
Raw