Skip to content

Commit a1cf0f8

Browse files
committed
更新v2安装部署说明
1 parent 6c20d6c commit a1cf0f8

File tree

5 files changed

+40
-25
lines changed

5 files changed

+40
-25
lines changed

docs/img/index/maxkb_v2_arch.png

562 KB
Loading

docs/installation/cli.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
MaxKB 离线安装包默认内置了命令行运维工具 mkctl,通过执行 `mkctl help`,可以查看相关的命令说明。
55

66
**说明**:
7-
8-
- 1.5.0 之前版本请使用 kbctl 命令。
97
- 通过在线安装、1Panel方式安装,并没有内置 mkctl 命令。
108

119
```
@@ -20,7 +18,6 @@
2018
restart 重启 MaxKB 服务
2119
reload 重新加载 MaxKB 服务
2220
uninstall 卸载 MaxKB 服务
23-
upgrade 升级 MaxKB 服务
2421
version 查看 MaxKB 版本信息
2522
clean-images 清理 MaxKB 旧版本的相关镜像
2623
```

docs/installation/offline_installtion.md

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
**部署服务器要求:**
1111

12-
* 操作系统:Ubuntu 22.04 / CentOS 7.6 64 位系统
12+
* 操作系统:Ubuntu 22.04 / CentOS 7(内核版本要求 ≥ 3.10)
1313
* CPU/内存:4C/8GB 以上
1414
* 磁盘空间:100GB
1515

@@ -28,7 +28,7 @@
2828
## 2 安装包下载
2929

3030
!!! Abstract ""
31-
打开 [飞致云开源社区 MaxKB 社区版下载](https://community.fit2cloud.com/#/products/maxkb/downloads) 页面下载最新版本安装包,并上传至部署服务器(以 v1.2.0 为例说明安装部署过程)。
31+
打开 [飞致云开源社区 MaxKB 社区版下载](https://community.fit2cloud.com/#/products/maxkb/downloads) 页面下载最新版本安装包,并上传至部署服务器(以 v2.0.0 为例说明安装部署过程)。
3232

3333
## 3 安装部署
3434

@@ -38,7 +38,7 @@
3838

3939
以 root 用户通过 ssh 协议登录到部署服务器, 对安装包进行解压:
4040
```
41-
tar -zxvf maxkb-v1.2.0-offline.tar.gz
41+
tar -zxvf maxkb--ce-v2.0.0-offline.tar.gz
4242
```
4343

4444
### 3.2 安装配置(可选)
@@ -48,12 +48,14 @@
4848
MaxKB 安装目录、服务运行端口、数据库配置等信息可在安装包解压后中的 install.conf 文件进行配置。
4949

5050
```
51+
# 基础配置
5152
## 安装目录
5253
MAXKB_BASE=/opt
53-
## Service 端口
54+
## 服务端口
5455
MAXKB_PORT=8080
5556
## docker 网段设置
5657
MAXKB_DOCKER_SUBNET=172.19.0.0/16
58+
5759
# 数据库配置
5860
## 是否使用外部数据库
5961
MAXKB_EXTERNAL_PGSQL=false
@@ -67,9 +69,29 @@
6769
MAXKB_PGSQL_USER=root
6870
## 数据库密码
6971
MAXKB_PGSQL_PASSWORD=Password123@postgres
72+
73+
# Redis配置
74+
## 是否使用外部Redis
75+
MAXKB_EXTERNAL_REDIS=false
76+
## Redis地址
77+
REDIS_HOST=redis
78+
## Redis端口
79+
REDIS_PORT=6379
80+
## Redis数据库
81+
REDIS_DB=0
82+
## Redis密码
83+
REDIS_PASSWORD=Password123@redis
84+
85+
# 镜像配置
86+
## 镜像仓库
87+
MAXKB_IMAGE_REPOSITORY=registry.fit2cloud.com/maxkb
88+
## 镜像名称
89+
MAXKB_IMAGE=maxkb-ce
90+
## 版本号
91+
MAXKB_VERSION=v2.0.0:;q
7092
```
7193

72-
**注意**:首次安装之前可在 install.conf 文件中的修改参数,安装时则根据修改后的参数执行安装。完成安装后如需再次修改配置参数,则需要在 ${MAXKB_BASE}/maxkb/.env(默认是 /opt/maxkb/.env)文件中进行修改,并且在修改完后需执行 `mkctl reload` 命令重新加载配置文件。
94+
**注意**:首次安装之前可以在 install.conf文件中的修改参数,安装时则根据修改后的参数执行安装。安装后如需再次修改配置参数,则需要在 ${MAXKB_BASE}/maxkb/.env(默认是 /opt/maxkb/.env)文件中进行修改,并且在修改完后需执行 `mkctl reload` 命令重新加载配置文件。
7395

7496

7597
### 3.3 执行安装脚本
@@ -78,7 +100,7 @@
78100

79101
```
80102
# 进入安装包解压缩后目录
81-
cd maxkb-v1.2.0-offline
103+
cd maxkb-ee-v2.0.0-offline
82104

83105
# 执行安装命令
84106
bash install.sh
@@ -103,11 +125,11 @@
103125

104126
!!! Abstract ""
105127

106-
离线升级与安装操作过程基本一样,即下载新版本安装包上传解压后,再次执行安装命令进行升级。
128+
离线升级与安装操作过程基本一样,即下载新版本安装包上传并解压后,再次执行安装命令进行升级。
107129

108130
```
109131
# 进入新版本目录
110-
cd maxkb-v1.x.y-offline
132+
cd maxkb-v2.x.y-offline
111133

112134
# 运行安装脚本
113135
bash install.sh

docs/installation/online_installtion.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
**部署服务器要求:**
88

9-
* 操作系统:Ubuntu 22.04 / CentOS 7.6 64 位系统
9+
* 操作系统:Ubuntu 22.04 / CentOS 7(内核版本要求 ≥ 3.10)
1010
* CPU/内存:4C/8GB 以上
1111
* 磁盘空间:100GB
1212

@@ -29,10 +29,10 @@
2929
MaxKB 支持一键启动,仅需执行以下命令:
3030
```
3131
# Linux 操作系统
32-
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
32+
docker run -d --name=maxkb --restart=always -p 8080:8080 -v ~/.maxkb:/opt/maxkb registry.fit2cloud.com/maxkb/maxkb:v2
3333

3434
# Windows 操作系统
35-
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
35+
docker run -d --name=maxkb --restart=always -p 8080:8080 -v C:/maxkb:/opt/maxkb registry.fit2cloud.com/maxkb/maxkb:v2
3636
```
3737
3838
待所有容器状态显示为`healthy`后,可通过浏览器访问 MaxKB:
@@ -52,7 +52,7 @@
5252

5353
(1) 下载最新镜像
5454
```
55-
docker pull registry.fit2cloud.com/maxkb/maxkb
55+
docker pull registry.fit2cloud.com/maxkb/maxkb:v2
5656
```
5757
(2)查看并确认上一次数据持久化目录,复制保存
5858
```
@@ -74,5 +74,5 @@
7474
**注意:** 务必确认数据持久化目录(即命令行中 -v后的目录)要跟第 (2) 步查看目录保持一致,否则启动后整个系统的数据为空。
7575

7676
```
77-
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
77+
docker run -d --name=maxkb --restart=always -p 8080:8080 -v ~/.maxkb:/opt/maxkb registry.fit2cloud.com/maxkb/maxkb:v2
7878
```

docs/system_arch.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,12 @@
22

33
## 1 整体架构
44

5-
![架构图](img/index/arch.jpg){width="950px"}
5+
![架构图](img/index/maxkb_v2_arch.png)
66

7-
## 2 实现原理
8-
9-
![实现原理](img/index/Implementation principle.jpg)
10-
11-
## 3 技术栈
7+
## 2 技术栈
128

139
!!! Abstract ""
14-
- 前端:[vue.js](https://cn.vuejs.org/)[LogicFlow](https://github.com/didi/LogicFlow)
10+
- 前端:[Vue.js](https://cn.vuejs.org/)[LogicFlow](https://github.com/didi/LogicFlow)
1511
- 后端:[Python / Django](https://www.djangoproject.com/)[langchain](https://www.langchain.com/)
16-
- 向量数据库:[PostgreSQL / pgvector](https://www.postgresql.org/)
17-
- 大模型:[Ollama](https://github.com/ollama/ollama)、Azure OpenAI、OpenAI、Anthropic、Gemini、DeepSeek、通义千问、Kimi、百度千帆、讯飞星火等
12+
- 向量数据库:[PostgreSQL / pgvector](https://www.postgresql.org/)、Redis
13+
- 大模型:DeepSeek、通义千问、Kimi、百度千帆、讯飞星火、智谱AI、OpenAI、Azure OpenAI、Anthropic、Gemini、Ollama等

0 commit comments

Comments
 (0)