Skip to content

Commit 48def90

Browse files
authored
chore: Update README.md
1 parent 3c55883 commit 48def90

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

README.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="center"><img src= "TBD" alt="SQLBot" width="300" /></p>
2-
<h3 align="center">Chat with your SQL database</h3>
2+
<h3 align="center">基于大模型和 RAG 的智能问数系统</h3>
33
<p align="center">
44
<a href="https://www.gnu.org/licenses/gpl-3.0.html#license-text"><img src="https://img.shields.io/github/license/1Panel-dev/SQLBot?color=%231890FF" alt="License: GPL v3"></a>
55
<a href="https://github.com/1Panel-dev/SQLBot/releases/latest"><img src="https://img.shields.io/github/v/release/1Panel-dev/SQLBot" alt="Latest release"></a>
@@ -8,31 +8,33 @@
88
</p>
99
<hr/>
1010

11-
SQLBot allows you to interact with your SQL database through advanced Text-to-SQL technology. This capability is powered by Large Language Models (LLMs) and Retrieval-Augmented Generation (RAG).
11+
SQLBot 是一款基于大模型和 RAG 的智能问数系统。SQLBot 的优势包括:
1212

13-
- **Easy to use**: TBD.
14-
- **Accurate text-to-sql generation**: TBD.
15-
- **Easy to integrate**: TBD.
16-
- **Supported databases**: MySQL, PostgreSQL, Oracle, Microsoft SQL Server, PrestoDB, Apache Hive, Apache Doris, ClickHouse,etc.
13+
- **开箱即用**: 只需配置大模型和数据源即可开启问数之旅,通过大模型和 RAG 的结合来实现高质量的 NL2SQL/Text-to-SQL;
14+
- **易于集成**: 不仅可以嵌入 n8n、MaxKB、Dify 、Coze 等 AI 应用开发平台,也可以直接嵌入到第三方业务系统,让业务系统快速拥有智能问数能力;
15+
- **安全可控**: 提供基于工作空间的资源隔离机制,能够实现细粒度的数据权限控制。
1716

18-
## How SQLBot works
17+
## 快速开始
1918

20-
TBD
21-
22-
## Quick Start
19+
```
20+
# Linux 机器
21+
docker run -d --name=sqlbot --restart=always -p 8080:8080 -v ~/.sqlbot:/var/lib/postgresql/data -v ~/.python-packages:/opt/sqlbot/app/sandbox/python-packages registry.fit2cloud.com/sqlbot/sqlbot
2322
24-
Execute the script below to start a SQLBot container using Docker:
23+
# Windows 机器
24+
docker run -d --name=sqlbot --restart=always -p 8080:8080 -v C:/sqlbot:/var/lib/postgresql/data -v C:/python-packages:/opt/sqlbot/app/sandbox/python-packages registry.fit2cloud.com/sqlbot/sqlbot
2525
26-
```bash
27-
docker run -d --name=sqlbot --restart=always -p 8080:8080 -v ~/.sqlbot:/var/lib/postgresql/data 1panel/sqlbot
26+
# 用户名: admin
27+
# 密码: SQLBot@123..
2828
```
2929

30-
Access SQLBot web interface at `http://your_server_ip:8080` with default admin credentials:
30+
- 你也可以通过 [1Panel 应用商店](https://apps.fit2cloud.com/1panel) 快速部署 SQLBot;
31+
- 如果是内网环境,推荐使用 [离线安装包](https://community.fit2cloud.com/#/products/sqlbot/downloads) 进行安装部署;
3132

32-
- username: admin
33-
- password: SQLBot@123..
33+
如你有更多问题,可以加入我们的技术交流群与我们交流。
34+
35+
TBD
3436

35-
## Screenshots
37+
## UI 展示
3638

3739
<table style="border-collapse: collapse; border: 1px solid black;">
3840
<tr>
@@ -45,7 +47,7 @@ Access SQLBot web interface at `http://your_server_ip:8080` with default admin c
4547
</tr>
4648
</table>
4749

48-
## Technical Stack
50+
## 技术栈
4951

5052
- Frontend:[Vue.js](https://vuejs.org/)
5153
- Backend:[Python / Django](https://www.djangoproject.com/)

0 commit comments

Comments
 (0)