Skip to content

Commit f79b9f1

Browse files
committed
docs:更新智能问数
1 parent b6db653 commit f79b9f1

15 files changed

Lines changed: 141 additions & 130 deletions
374 KB
Loading
429 KB
Loading
359 KB
Loading
395 KB
Loading
345 KB
Loading
389 KB
Loading
372 KB
Loading
355 KB
Loading

docs/installation/cli.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## 1 SQLBot Service
2+
3+
!!! Abstract ""
4+
SQLBot 在安装的时候默认向系统中添加了相应的 SQLBot Service,支持的 Service 命令有:
5+
6+
- start : 启动 SQLBot 服务
7+
- stop : 停止 SQLBot 服务,并删除相关的运行容器、docker 网络等资源
8+
- restart : 停止后启动 SQLBot 服务,相当于先执行 stop,再执行 start 命令
9+
- status : 查看 SQLBot 服务当前各容器运行状态
10+
11+
## 2 sctl
12+
13+
!!! Abstract ""
14+
SQLBot 默认内置了命令行运维工具(sctl),通过执行 sctl help 命令,可以查看相关的帮助文档。
15+
16+
```
17+
Usage:
18+
./sctl [COMMAND] [ARGS...]
19+
./sctl --help
20+
21+
Commands:
22+
status 查看 SQLBot 服务运行状态
23+
start 启动 SQLBot 服务
24+
stop 停止 SQLBot 服务
25+
restart 重启 SQLBot 服务
26+
reload 重载 SQLBot 服务
27+
clear-images 清理 SQLBot 旧版本的相关镜像
28+
clear-logs 清理 SQLBot 历史日志
29+
version 查看 SQLBot 版本
30+
```

docs/installation/offline_installtion.md

Lines changed: 36 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@
33
!!! Abstract ""
44
部署服务器要求:
55

6-
操作系统: Ubuntu 22.04 / CentOS 7.6 64 位系统
7-
CPU/内存: 4 核8 G
8-
磁盘空间: 1 00G
6+
- 操作系统: Ubuntu 22.04 / CentOS 7.6 64 位系统
7+
- CPU/内存: 4 核 8 G
8+
- 磁盘空间: 100G
9+
910
提示:Docker 版本太老可能会导致安装失败,建议使用安装包内的 Docker,或者使用 v23.0.5 版本及以上的 Docker。
1011

1112
## 2 下载离线安装包
@@ -26,7 +27,7 @@
2627

2728

2829

29-
## 4 4 安装部署
30+
## 4 安装部署
3031

3132
### 4.1 解压安装包
3233

@@ -37,7 +38,7 @@
3738
tar -zxvf SQLBot-v1.0.0-x86_64-offline-installer.tar.gz
3839
```
3940

40-
### 4.2 安装配置(可选)
41+
### 4.2 设置安装参数(可选)
4142

4243
!!! Abstract ""
4344

@@ -46,49 +47,40 @@
4647
```
4748
# 基础配置
4849
## 安装目录
49-
MAXKB_BASE=/opt
50-
## 服务端口
51-
MAXKB_PORT=8000
52-
## docker 网段设置
53-
MAXKB_DOCKER_SUBNET=172.31.250.192/26
54-
50+
SQLBOT_BASE=/opt
51+
## SQLBot 端口
52+
SQLBOT_WEB_PORT=8000
53+
SQLBOT_MCP_PORT=8001
54+
5555
# 数据库配置
5656
## 是否使用外部数据库
57-
MAXKB_EXTERNAL_PGSQL=false
57+
SQLBOT_EXTERNAL_DB=false
5858
## 数据库地址
59-
MAXKB_PGSQL_HOST=pgsql
60-
## 数据库端口
61-
MAXKB_PGSQL_PORT=5432
62-
## 数据库库名
63-
MAXKB_PGSQL_DB=maxkb
59+
SQLBOT_DB_HOST=sqlbot-db
60+
## 数据库端口 (仅使用外部数据库时才生效)
61+
SQLBOT_DB_PORT=5432
62+
## SQLBot 数据库库名
63+
SQLBOT_DB_DB=sqlbot
6464
## 数据库用户名
65-
MAXKB_PGSQL_USER=root
66-
## 数据库密码
67-
MAXKB_PGSQL_PASSWORD=Password123@postgres
68-
69-
# Redis配置
70-
## 是否使用外部Redis
71-
MAXKB_EXTERNAL_REDIS=false
72-
## Redis地址
73-
REDIS_HOST=redis
74-
## Redis端口
75-
REDIS_PORT=6379
76-
## Redis数据库
77-
REDIS_DB=0
78-
## Redis密码
79-
REDIS_PASSWORD=Password123@redis
80-
81-
# 镜像配置
82-
## 镜像仓库
83-
MAXKB_IMAGE_REPOSITORY=registry.fit2cloud.com/maxkb
84-
## 镜像名称
85-
MAXKB_IMAGE=maxkb
86-
## 版本号
87-
SQLBot_VERSION=v2.0.0
65+
SQLBOT_DB_USER=root
66+
## 数据库密码,密码如包含特殊字符,请用双引号引起来,例如 SQLBOT_DB_PASSWORD="Test@4&^%*^"
67+
SQLBOT_DB_PASSWORD=Password123@pg
68+
69+
# 其他配置
70+
## 普通用户默认密码
71+
SQLBOT_DEFAULT_PWD=SQLBot@123456
72+
## SQLBot Secret Key
73+
SQLBOT_SECRET_KEY=y5txe1mRmS_JpOrUzFzHEu-kIQn3lf7ll0AOv9DQh0s
74+
## Cross-Origin Resource Sharing (CORS) 设置
75+
SQLBOT_CORS_ORIGINS=http://localhost,http://localhost:5173,https://localhost,https://localhost:5173
76+
## 日志级别 DEBUG, INFO, WARNING, ERROR
77+
SQLBOT_LOG_LEVEL="INFO"
78+
## 缓存类型
79+
SQLBOT_CACHE_TYPE="memory"
80+
## MCP 图片存储路径
81+
SQLBOT_SERVER_IMAGE_HOST=https://YOUR_SERVER_IP:MCP_PORT/images/
8882
```
8983

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

9385

9486
### 4.3 执行安装脚本
@@ -103,36 +95,14 @@
10395
bash install.sh
10496
```
10597

106-
![安装](../img/index/install.png)
107-
10898
## 5 登录访问
10999

110100
!!! Abstract ""
111101

112-
待所有容器状态显示为`healthy`后,即可通过浏览器访问地址 `http://目标服务器 IP 地址:8000`,并使用默认的管理员用户和密码登录 MaxKB
102+
安装成功后即可通过浏览器访问地址 `http://目标服务器 IP 地址:8000`,并使用默认的管理员用户和密码登录 SQLBot
113103

114104
```
115105
用户名:admin
116106
默认密码:SQLBot@123456
117107
```
118-
119-
![登录](../img/index/login.jpg)
120-
121-
## 6 离线升级
122-
123-
!!! Abstract ""
124-
125-
离线升级与安装操作过程基本一样,即下载新版本安装包上传并解压后,再次执行安装命令进行升级。
126-
127-
```
128-
# 进入新版本目录
129-
cd sqlbot-v1.x.y-offline
130-
131-
# 运行安装脚本
132-
bash install.sh
133-
134-
# 查看 SQLBot 运行状态
135-
sbctl status
136-
```
137-
138-
**注意:** 升级前请先对数据库进行备份。
108+
![访问SQLBot](../img/installation/login_sqlbot.png)

0 commit comments

Comments
 (0)