From 861efe5f5befe0cfb5b33c4eae01449d6b60e15a Mon Sep 17 00:00:00 2001 From: inter Date: Mon, 8 Sep 2025 16:35:35 +0800 Subject: [PATCH] Add File Signed-off-by: inter --- README.md | 120 ++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 84 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index d493519..11fbef7 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,85 @@ -# SQLBot +

SQLBot

+

基于大模型和 RAG 的智能问数系统

+

+ Latest release + Stars + Download
-# Git 仓库初始化与推送指南 - ## 1. Git账号、密码 - ```bash - Git 账号和密码信息请在“工程实践项目管理” - “我的项目”模块中的“我的信息”处查看。 - ``` - ## 2. 创建新的 Git 仓库并推送 - ```bash - # 创建项目目录并进入 - mkdir SQLBot - cd SQLBot - # 初始化本地 Git 仓库 - git init - # 创建一个 info 文件（可选） - touch info.md - # 将文件添加到暂存区 - git add info.md - # 提交到本地仓库 - git commit -m 'first commit' - # 创建本地分支admin - git branch admin - # 设置admin为当前分支 - git checkout admin - # 添加远程仓库地址（别名为 origin） - git remote add origin http://college.ithyxy.com:21147/inter/SQLBot.git - # 先拉取远程admin分支的内容，并合并到本地 - git pull origin admin --allow-unrelated-histories - # 推送到远程仓库的 admin 分支，并设置上游跟踪 - git push -u origin 'admin' - ``` - ## 3. 已有仓库? - ```bash - cd existing_git_repo - git remote add origin http://college.ithyxy.com:21147/inter/SQLBot.git - git push -u origin 'admin' - ``` \ No newline at end of file +

+
+ +SQLBot 是一款基于大模型和 RAG 的智能问数系统。SQLBot 的优势包括： + +- **开箱即用**: 只需配置大模型和数据源即可开启问数之旅，通过大模型和 RAG 的结合来实现高质量的 text2sql； +- **易于集成**: 支持快速嵌入到第三方业务系统，也支持被 n8n、MaxKB、Dify、Coze 等 AI 应用开发平台集成调用，让各类应用快速拥有智能问数能力； +- **安全可控**: 提供基于工作空间的资源隔离机制，能够实现细粒度的数据权限控制。 + +## 快速开始 + +### 安装部署 + +准备一台 Linux 服务器，安装好 [Docker](https://docs.docker.com/get-docker/)，执行以下一键安装脚本： + +```bash +docker run -d \ + --name sqlbot \ + --restart unless-stopped \ + -p 8000:8000 \ + -p 8001:8001 \ + -v ./data/sqlbot/excel:/opt/sqlbot/data/excel \ + -v ./data/sqlbot/images:/opt/sqlbot/images \ + -v ./data/sqlbot/logs:/opt/sqlbot/logs \ + -v ./data/postgresql:/var/lib/postgresql/data \ + dataease/sqlbot:v1.1.1 +``` + +你也可以通过 [1Panel 应用商店](https://apps.fit2cloud.com/1panel) 快速部署 SQLBot。 + +如果是内网环境，你可以通过 [离线安装包方式](https://community.fit2cloud.com/#/products/sqlbot/downloads) 部署 SQLBot。 + +### 访问方式 + +- 在浏览器中打开: http://<你的服务器IP>:8000/ +- 用户名: admin +- 密码: SQLBot@123456 + +### 联系我们 + +如你有更多问题，可以加入我们的技术交流群与我们交流。 + +contact_me_qr + +## UI 展示 + + + q&a + + +## Roadmap + +- SQL 示例库：开发中... +- 自定义提示词：开发中... + +## Star History + +[![Star History Chart](https://api.star-history.com/svg?repos=dataease/sqlbot&type=Date)](https://www.star-history.com/#dataease/sqlbot&Date) + +## 飞致云旗下的其他明星项目 + +- [DataEase](https://github.com/dataease/dataease/) - 人人可用的开源 BI 工具 +- [1Panel](https://github.com/1panel-dev/1panel/) - 现代化、开源的 Linux 服务器运维管理面板 +- [MaxKB](https://github.com/1panel-dev/MaxKB/) - 强大易用的企业级智能体平台 +- [JumpServer](https://github.com/jumpserver/jumpserver/) - 广受欢迎的开源堡垒机 +- [Halo](https://github.com/halo-dev/halo/) - 强大易用的开源建站工具 +- [MeterSphere](https://github.com/metersphere/metersphere/) - 新一代的开源持续测试工具 + +## License + +本仓库遵循 [FIT2CLOUD Open Source License](LICENSE) 开源协议，该许可证本质上是 GPLv3，但有一些额外的限制。 + +你可以基于 SQLBot 的源代码进行二次开发，但是需要遵守以下规定： + +- 不能替换和修改 SQLBot 的 Logo 和版权信息； +- 二次开发后的衍生作品必须遵守 GPL V3 的开源义务。 + +如需商业授权，请联系 support@fit2cloud.com 。