Skip to content

Commit 8a29b0d

Browse files
docs: add readme
1 parent 0bf9747 commit 8a29b0d

File tree

1 file changed

+89
-0
lines changed

1 file changed

+89
-0
lines changed

docs/README.en.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
<p align="center"><img src="https://resource-fit2cloud-com.oss-cn-hangzhou.aliyuncs.com/sqlbot/sqlbot.png" alt="SQLBot" width="300" /></p>
2+
<h3 align="center">Intelligent Questioning System Based on Large Models and RAGs</h3>
3+
<p align="center">
4+
<a href="https://github.com/dataease/SQLBot/releases/latest"><img src="https://img.shields.io/github/v/release/dataease/SQLBot" alt="Latest release"></a>
5+
<a href="https://github.com/dataease/SQLBot"><img src="https://img.shields.io/github/stars/dataease/SQLBot?color=%231890FF&style=flat-square" alt="Stars"></a>
6+
<a href="https://hub.docker.com/r/dataease/SQLbot"><img src="https://img.shields.io/docker/pulls/dataease/sqlbot?label=downloads" alt="Download"></a><br/>
7+
</p>
8+
<p align="center">
9+
<a href="https://trendshift.io/repositories/14540" target="_blank"><img src="https://trendshift.io/api/badge/repositories/14540" alt="dataease%2FSQLBot | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
10+
<hr/>
11+
12+
13+
SQLBot is an intelligent data query system based on large language models and RAGs, meticulously crafted by the DataEase open-source project team. With SQLBot, users can perform conversational data analysis (ChatBI), quickly extracting the necessary data information and visualizations, and supporting further intelligent analysis.
14+
15+
## Working principle
16+
17+
<img width="1153" height="563" alt="image" src="https://github.com/user-attachments/assets/8bc40db1-2602-4b68-9802-b9be36281967" />
18+
19+
## Core advantages
20+
21+
- **Out-of-the-Box Functionality:** Simply configure the large model and data source; no complex development is required to quickly enable intelligent data collection. Leveraging the large model's natural language understanding and SQL generation capabilities, combined with RAG technology, it achieves high-quality Text-to-SQL conversion.
22+
- **Secure and Controllable:** Provides a workspace-level resource isolation mechanism, building clear data boundaries and ensuring data access security. Supports fine-grained data permission configuration, strengthening permission control capabilities and ensuring compliance and controllability during use.
23+
- **Easy Integration:** Supports multiple integration methods, providing capabilities such as web embedding, pop-up embedding, and MCP invocation. It can be quickly embedded into applications such as n8n, Dify, MaxKB, and DataEase, allowing various applications to quickly acquire intelligent data collection capabilities.
24+
- **Increasingly Accurate with Use:** Supports customizable prompts and terminology library configurations, maintainable SQL example calibration logic, and accurate matching of business scenarios. Efficient operation, based on continuous iteration and optimization using user interaction data, the data collection effect gradually improves with use, becoming more accurate with each use.
25+
26+
## Quick Start
27+
28+
### Installation and Deployment
29+
30+
Prepare a Linux server, install [Docker](https://docs.docker.com/get-docker/), and execute the following one-click installation script:
31+
32+
```bash
33+
docker run -d \
34+
--name sqlbot \
35+
--restart unless-stopped \
36+
-p 8000:8000 \
37+
-p 8001:8001 \
38+
-v ./data/sqlbot/excel:/opt/sqlbot/data/excel \
39+
-v ./data/sqlbot/file:/opt/sqlbot/data/file \
40+
-v ./data/sqlbot/images:/opt/sqlbot/images \
41+
-v ./data/sqlbot/logs:/opt/sqlbot/app/logs \
42+
-v ./data/postgresql:/var/lib/postgresql/data \
43+
--privileged=true \
44+
dataease/sqlbot
45+
```
46+
47+
You can also quickly deploy SQLBot through the [1Panel app store](https://apps.fit2cloud.com/1panel).
48+
49+
If you are in an intranet environment, you can deploy SQLBot via the [offline installation package](https://community.fit2cloud.com/#/products/sqlbot/downloads).
50+
51+
52+
### Access methods
53+
54+
- Open in your browser: http://<your server IP>:8000/
55+
- Username: admin
56+
- Password: SQLBot@123456
57+
58+
59+
## UI Display
60+
61+
<tr>
62+
<img alt="q&a" src="https://github.com/user-attachments/assets/55526514-52f3-4cfe-98ec-08a986259280" />
63+
</tr>
64+
65+
## Star History
66+
67+
[![Star History Chart](https://api.star-history.com/svg?repos=dataease/sqlbot&type=Date)](https://www.star-history.com/#dataease/sqlbot&Date)
68+
69+
## Other star projects under FIT2CLOUD
70+
71+
- [DataEase](https://github.com/dataease/dataease/) - Open source BI tools
72+
- [1Panel](https://github.com/1panel-dev/1panel/) - A modern, open-source Linux server operation and maintenance management panel
73+
- [MaxKB](https://github.com/1panel-dev/MaxKB/) - Powerful and easy-to-use enterprise-grade intelligent agent platform
74+
- [JumpServer](https://github.com/jumpserver/jumpserver/) - Popular open source bastion hosts
75+
- [Cordys CRM](https://github.com/1Panel-dev/CordysCRM) - A new generation of open-source AI CRM systems
76+
- [Halo](https://github.com/halo-dev/halo/) - Powerful and easy-to-use open-source website building tools
77+
- [MeterSphere](https://github.com/metersphere/metersphere/) - Next-generation open-source continuous testing tools
78+
79+
## License
80+
81+
This repository is licensed under the [FIT2CLOUD Open Source License](LICENSE), which is essentially GPLv3 but with some additional restrictions.
82+
83+
You can perform secondary development based on the SQLBot source code, but you must adhere to the following:
84+
85+
- You cannot replace or modify the SQLBot logo and copyright information;
86+
87+
- Derivative works resulting from secondary development must comply with the open-source obligations of GPL v3.
88+
89+
For commercial licensing, please contact [email protected].

0 commit comments

Comments
 (0)