Skip to content

Commit ffcf747

Browse files
greenyhsjgreenyhsj
committed
docs：更新部分在线文档
1 parent 72c7fcb commit ffcf747

100 files changed

Lines changed: 13178 additions & 1 deletion

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/compile-and-deploy.yml‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
name: 编译并部署
2+
3+
on:
4+
workflow_dispatch:
5+
6+
jobs:
7+
complie:
8+
name: 编译
9+
runs-on: ubuntu-latest
10+
strategy:
11+
max-parallel: 1
12+
matrix:
13+
version: ['v1', 'v2']
14+
steps:
15+
- uses: actions/checkout@v4
16+
with:
17+
token: ${{ secrets.GH_TOKEN }}
18+
ref: ${{ matrix.version }}
19+
- name: Set up Python
20+
uses: actions/setup-python@v3
21+
with:
22+
python-version: '3.x'
23+
- name: Install dependencies
24+
run: |
25+
python -m pip install --upgrade pip
26+
pip install -r requirements/requirements.txt
27+
pip install mike==1.1.2
28+
python -m pip install --upgrade pip setuptools wheel
29+
- name: Config Git
30+
run: |
31+
git config user.name "$(git log -n 1 --pretty=format:%an)"
32+
git config user.email "$(git log -n 1 --pretty=format:%ae)"
33+
- name: Build
34+
run: |
35+
git fetch origin deploy:deploy
36+
mike deploy --push --branch deploy --rebase ${{ matrix.version }}
37+
if [[ ${{ matrix.version }} == "v2" ]]; then
38+
mike set-default -b deploy ${{ matrix.version }}
39+
fi
40+
41+
deploy:
42+
name: 部署
43+
runs-on: ubuntu-latest
44+
needs: complie
45+
steps:
46+
- uses: actions/checkout@v4
47+
with:
48+
token: ${{ secrets.GH_TOKEN }}
49+
ref: deploy
50+
- name: tar
51+
run: |
52+
rm -rf docs.tar*
53+
tar -zcf docs.tar.gz --exclude=.git *
54+
ls -la
55+
- name: upload
56+
uses: appleboy/scp-action@v0.1.7
57+
with:
58+
host: ${{ secrets.MAXKB_DOCS_HOST }}
59+
username: ${{ secrets.MAXKB_DOCS_HOST_USERNAME }}
60+
port: 22
61+
key: ${{ secrets.MAXKB_DOCS_HOST_KEY }}
62+
source: "docs.tar.gz"
63+
target: /tmp
64+
- name: deploy
65+
uses: appleboy/ssh-action@v1.0.3
66+
with:
67+
host: ${{ secrets.MAXKB_DOCS_HOST }}
68+
username: ${{ secrets.MAXKB_DOCS_HOST_USERNAME }}
69+
key: ${{ secrets.MAXKB_DOCS_HOST_KEY }}
70+
port: 22
71+
script: |
72+
set -e
73+
cd /tmp
74+
rm -rf docs
75+
mkdir -p docs
76+
cd docs
77+
mv /tmp/docs.tar.gz ./
78+
tar -zxf docs.tar.gz
79+
rm -f docs.tar.gz
80+
rm -rf /opt/maxkb/docs/*
81+
mv /tmp/docs/* /opt/maxkb/docs/
82+
/opt/nginx/bin/reload-nginx.sh
83+
rm -rf /tmp/docs*

‎.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.idea/
2+
*.iml
3+
target/
4+
.vscode
5+
.DS_Store

‎LICENSE‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Open Source License
2+
3+
SQLBot is licensed under a modified version of the GNU General Public License version 3 (GPLv3), with the following additional conditions:
4+
5+
1. LOGO and copyright information: In the process of using SQLBot's frontend, you may not remove or modify the LOGO or copyright information in the SQLBot console or applications.
6+
7+
2. As a contributor, you should agree that:
8+
9+
a. The producer can adjust the open-source agreement to be more strict or relaxed as deemed necessary.
10+
b. Your contributed code may be used for commercial purposes, including but not limited to its cloud business operations.
11+
12+
Apart from the specific conditions mentioned above, all other rights and restrictions follow the GPLv3. Detailed information about the GPLv3 can be found at https://www.gnu.org/licenses/gpl-3.0.html.
13+
14+
© 2025 FIT2CLOUD, Inc.

‎README.md‎

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,47 @@
1-
# SQLBot-Docs
1+
本仓库保存了 [SQLBot 项目]() 的 [官方文档](https://dataease.cn/sqlbot/docs/)，该文档使用 [MkDocs]() 文档框架下的 [Material for MkDocs]() 主题进行构建。
2+
3+
## 本地开发
4+
5+
### 克隆本仓库
6+
```bash
7+
git clone git@github.com:dataease/SQLBot-Docs.git
8+
```
9+
10+
### 安装依赖
11+
```bash
12+
cd SQLBot-Docs
13+
pip install -r requirements/requirements.txt
14+
```
15+
16+
### 修改文档内容
17+
本文档的文档结构定义在 `mkdocs.yml` 文件中，文档的具体内容均在 `docs` 目录中。
18+
文档内容使用 markdown 语法编写，若要添加新的文档，需要先在 `mkdocs.yml` 文件中的 `nav` 部分增加对应章节导航。
19+
20+
### 本地调试文档
21+
```bash
22+
mkdocs serve
23+
```
24+
执行上述命令后，可通过 `http://127.0.0.1:8000` 地址查看生成的文档内容，当修改文档后，页面内容会自动更新。
25+
26+
### 构建文档
27+
```bash
28+
mkdocs build
29+
```
30+
31+
执行上述命令后，会在 `site` 目录下生成文档站点的静态文件，将目录中的内容复制到任意 HTTP 服务器上即可完成文档的部署。
32+
33+
## 帮助完善文档
34+
35+
### Fork 文档仓库
36+
点击仓库右上角的 `fork` 按钮，复制本仓库到自己的 github 账号。
37+
38+
### 克隆 fork 后的仓库
39+
```bash
40+
git clone https://github.com/your-github-account/SQLBot-Docs.git
41+
```
42+
43+
### 本地修改并调试
44+
45+
### Push 修改内容到 GitHub 仓库
46+
47+
### 提交 Pull Request 到本仓库

‎docs/changelog.md‎

Lines changed: 225 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,225 @@
1+
## 1 版本说明
2+
3+
!!! Abstract ""
4+
**版本号说明：** 像其它优秀开源项目一样，MaxKB 将保持每月发布一个新的功能版本，功能版本中如遇较为紧急或严重的 Bug，将及时推出 Bug 修复的小版本。
5+
**MaxKB 版本号命名规则为：** v 大版本.功能版本. Bug 修复版本，示例如下：
6+
7+
- v2.0.1 是 v2.0.0 之后的 Bug 修复版本
8+
- v2.1.0 是 v2.0.0 之后的功能版本
9+
10+
## 2 更新内容
11+
12+
### v1.0.0
13+
14+
2025 年 7 月 17 日
15+
16+
<table>
17+
<tr>
18+
<td bgcolor="#4B60FC" align="middle" style="font-weight:bold;color: white;width: 150px">模块</td>
19+
<td bgcolor="#4B60FC" align="middle" style="font-weight:bold;color: white;width: 150px">功能项</td>
20+
<td bgcolor="#4B60FC" align="middle" style="font-weight:bold;color: white;width: 750px">功能描述</td>
21+
</tr>
22+
<tr>
23+
<td rowspan="21">智能问数</td>
24+
<td rowspan="4">应用管理</td>
25+
<td>支持创建简单应用、高级编排应用</td>
26+
</tr>
27+
<tr>
28+
<td>支持以多级目录的方式分类管理应用</td>
29+
</tr>
30+
<tr>
31+
<td>支持控制应用访问行为，例如允许公开访问、禁止公开访问</td>
32+
</tr>
33+
<tr>
34+
<td>支持应用的导入与导出</td>
35+
</tr>
36+
<tr>
37+
<td rowspan="10">高级编排</td>
38+
<td>支持创建简单应用、高级编排应用</td>
39+
</tr>
40+
<tr>
41+
<td>
42+
工作流编排应用支持 AI 对话、知识库检索、问题优化、判断、指定回复、文档内容总结、文本转语音、语音转文本、图片理解、图片生成、表单收集、MCP 等节点
43+
</td>
44+
</tr>
45+
<tr>
46+
<td>支持提问时上传文本、图片、语音等类型文件</td>
47+
</tr>
48+
<tr>
49+
<td>支持在工作流中引用工具</td>
50+
</tr>
51+
<tr>
52+
<td>支持在工作流中嵌套其它应用</td>
53+
</tr>
54+
<tr>
55+
<td>支持多出多进和并行执行</td>
56+
</tr>
57+
<tr>
58+
<td>支持全局变量</td>
59+
</tr>
60+
<tr>
61+
<td>支持自动保存以及恢复历史版本</td>
62+
</tr>
63+
<tr>
64+
<td>支持语音输入自动发送和自动播放</td>
65+
</tr>
66+
<tr>
67+
<td>支持自定义思考过程的标签，配置是否输出思考过程</td>
68+
</tr>
69+
<tr>
70+
<td rowspan="1">问答嵌入</td>
71+
<td>支持问答嵌入第三方应用</td>
72+
</tr>
73+
<tr>
74+
<td rowspan="2">访问限制</td>
75+
<td>支持按客户端限制每天提问次数限制</td>
76+
</tr>
77+
<tr>
78+
<td>支持嵌入第三方访问白名单设置</td>
79+
</tr>
80+
<tr>
81+
<td rowspan="2">显示设置</td>
82+
<td>支持提问时显示知识来源</td>
83+
</tr>
84+
<tr>
85+
<td>支持设置中问答页面的语言设置</td>
86+
</tr>
87+
<tr>
88+
<td rowspan="2">统计看板</td>
89+
<td>支持按时间统计用户数、提问次数、Tokens 总数、用户满意度</td>
90+
</tr>
91+
<tr>
92+
<td>支持用户数、提问次数、Tokens 总数和用户满意度指标的趋势统计</td>
93+
</tr>
94+
<tr>
95+
<td rowspan="12">数据源</td>
96+
<td rowspan="1">知识库管理</td>
97+
<td>支持通用型文件知识库，Web 站点文档知识库</td>
98+
</tr>
99+
<tr>
100+
<td rowspan="6">文档管理</td>
101+
<td>支持上传文本文件文档，包括 Markdown、TXT、DOCX、PDF、HTML、XLSX、XLS、CSV 格式</td>
102+
</tr>
103+
<tr>
104+
<td>支持上传 QA 问答对，并提供 QA 问答对模板</td>
105+
</tr>
106+
<tr>
107+
<td>支持文本文件和离线图片 ZIP 格式的上传和导出</td>
108+
</tr>
109+
<tr>
110+
<td>支持知识库文档的启用状态调整，开启或关闭文档</td>
111+
</tr>
112+
<tr>
113+
<td>支持知识库文档的命令处理方式，如模型优化、直接回答</td>
114+
</tr>
115+
<tr>
116+
<td>支持知识库导出文档</td>
117+
</tr>
118+
<tr>
119+
<td rowspan="3">文档分段</td>
120+
<td>支持文档智能分段、高级分段方式</td>
121+
</tr>
122+
<tr>
123+
<td>支持自定义正则表达式分段</td>
124+
</tr>
125+
<tr>
126+
<td>支持知识库文档分段迁移</td>
127+
</tr>
128+
<tr>
129+
<td rowspan="2">问题管理</td>
130+
<td>支持问题和文档分段关联</td>
131+
</tr>
132+
<tr>
133+
<td>支持知识库自动生成关联问题</td>
134+
</tr>
135+
<tr>
136+
<td rowspan="4">仪表板</td>
137+
<td rowspan="4">工具管理</td>
138+
<td>支持通过 Python 函数，自定义工具</td>
139+
</tr>
140+
<tr>
141+
<td>支持从工具商店中导入创建</td>
142+
</tr>
143+
<tr>
144+
<td>支持工具多级目录分类管理</td>
145+
</tr>
146+
<tr>
147+
<td>支持工具的导出和导入</td>
148+
</tr>
149+
<tr>
150+
<td rowspan="4">设置</td>
151+
<td rowspan="4">模型供应商对接</td>
152+
<td>支持对接主流的大模型，包括包括本地私有大模型（Llama 3 / Qwen 2 等）、国内公共大模型（通义千问 / 智谱 AI / 百度千帆 / Kimi / DeepSeek 等）和国外公共大模型（OpenAI / Azure OpenAI / Gemini 等）</td>
153+
</tr>
154+
<tr>
155+
<td>支持大语言模型、向量化模型、重排模型、语音识别、语音合成、图片理解和图片生成模型</td>
156+
</tr>
157+
<tr>
158+
<td>支持自定义模型参数设置</td>
159+
</tr>
160+
<tr>
161+
<td>支持模型的权限</td>
162+
</tr>
163+
<tr>
164+
<td rowspan="20">系统管理</td>
165+
<td rowspan="1">系统语言</td>
166+
<td>支持简体中文、繁体中文和英文三种语言</td>
167+
</tr>
168+
<tr>
169+
<td rowspan="3">用户管理</td>
170+
<td>支持用户创建/删除、启用/禁止、密码修改</td>
171+
</tr>
172+
<tr>
173+
<td>支持 LDAP、CAS、OIDC 、OAuth2 对接（X-Pack）</td>
174+
</tr>
175+
<tr>
176+
<td>支持企业微信、钉钉、飞书扫码登录（X-Pack）</td>
177+
</tr>
178+
<tr>
179+
<td rowspan="1">工作空间</td>
180+
<td>支持按工作空间方式对用户、资源进行独立管理（X-Pack）</td>
181+
</tr>
182+
<tr>
183+
<td rowspan="2">角色管理</td>
184+
<td>支持系统管理员、工作空间管理员、普通用户内置角色</td>
185+
</tr>
186+
<tr>
187+
<td>支持自定义角色并关联权限控制以及用户成员（X-Pack）</td>
188+
</tr>
189+
<tr>
190+
<td rowspan="1">资源管理</td>
191+
<td>支持查看应用、知识库、工具和模型等所有系统资源（X-Pack）</td>
192+
</tr>
193+
<tr>
194+
<td rowspan="1">资源授权</td>
195+
<td>支持对应用、知识库、工具和模型等所有系统资源按角色或自定义授权</td>
196+
</tr>
197+
<tr>
198+
<td rowspan="1">共享资源</td>
199+
<td>支持创建和管理知识库、工具、模型等共享资源（X-Pack）</td>
200+
</tr>
201+
<tr>
202+
<td rowspan="3">对话用户</td>
203+
<td>支持创建和同步对话用户（X-Pack）</td>
204+
</tr>
205+
<tr>
206+
<td>支持对话用户组的创建和成员管理（X-Pack）</td>
207+
</tr>
208+
<tr>
209+
<td>支持通过 LDAP、CAS、OIDC、OAuth2 等方式进行对话用户的登录认证（X-Pack）</td>
210+
</tr>
211+
<tr>
212+
<td rowspan="3">系统设置</td>
213+
<td>支持对接邮箱</td>
214+
</tr>
215+
<tr>
216+
<td>支持自定义系统 Logo 、登录 Logo、主题配色、登录背景图、系统名称和欢迎语以及系统帮助链接（X-Pack）</td>
217+
</tr>
218+
<tr>
219+
<td>支持通过 LDAP、CAS、OIDC、OAuth2、扫码登录等方式进行登录认证（X-Pack）</td>
220+
</tr>
221+
<tr>
222+
<td rowspan="1">操作日志</td>
223+
<td>支持查看所有用户的操作详情（X-Pack）</td>
224+
</tr>
225+
</table>

0 commit comments

Comments
 (0)