|
3 | 3 | !!! Abstract "" |
4 | 4 | 部署服务器要求: |
5 | 5 |
|
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 | + |
9 | 10 | 提示:Docker 版本太老可能会导致安装失败,建议使用安装包内的 Docker,或者使用 v23.0.5 版本及以上的 Docker。 |
10 | 11 |
|
11 | 12 | ## 2 下载离线安装包 |
|
26 | 27 |
|
27 | 28 |
|
28 | 29 |
|
29 | | -## 4 4 安装部署 |
| 30 | +## 4 安装部署 |
30 | 31 |
|
31 | 32 | ### 4.1 解压安装包 |
32 | 33 |
|
|
37 | 38 | tar -zxvf SQLBot-v1.0.0-x86_64-offline-installer.tar.gz |
38 | 39 | ``` |
39 | 40 |
|
40 | | -### 4.2 安装配置(可选) |
| 41 | +### 4.2 设置安装参数(可选) |
41 | 42 |
|
42 | 43 | !!! Abstract "" |
43 | 44 |
|
|
46 | 47 | ``` |
47 | 48 | # 基础配置 |
48 | 49 | ## 安装目录 |
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 | + |
55 | 55 | # 数据库配置 |
56 | 56 | ## 是否使用外部数据库 |
57 | | - MAXKB_EXTERNAL_PGSQL=false |
| 57 | + SQLBOT_EXTERNAL_DB=false |
58 | 58 | ## 数据库地址 |
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 |
64 | 64 | ## 数据库用户名 |
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/ |
88 | 82 | ``` |
89 | 83 |
|
90 | | - **注意**:首次安装之前可以在 install.conf文件中的修改参数,安装时则根据修改后的参数执行安装。安装后如需再次修改配置参数,则需要在 ${MAXKB_BASE}/maxkb/.env(默认是 /opt/maxkb/.env)文件中进行修改,并且在修改完后需执行 `mkctl reload` 命令重新加载配置文件。 |
91 | | - |
92 | 84 |
|
93 | 85 |
|
94 | 86 | ### 4.3 执行安装脚本 |
|
103 | 95 | bash install.sh |
104 | 96 | ``` |
105 | 97 |
|
106 | | - |
107 | | - |
108 | 98 | ## 5 登录访问 |
109 | 99 |
|
110 | 100 | !!! Abstract "" |
111 | 101 |
|
112 | | - 待所有容器状态显示为`healthy`后,即可通过浏览器访问地址 `http://目标服务器 IP 地址:8000`,并使用默认的管理员用户和密码登录 MaxKB。 |
| 102 | + 安装成功后即可通过浏览器访问地址 `http://目标服务器 IP 地址:8000`,并使用默认的管理员用户和密码登录 SQLBot。 |
113 | 103 |
|
114 | 104 | ``` |
115 | 105 | 用户名:admin |
116 | 106 | 默认密码:SQLBot@123456 |
117 | 107 | ``` |
118 | | - |
119 | | - |
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 | + |
0 commit comments