的右上角点个⭐ Star 和 Fork，您的支持是 Chat2DB 变得更好最大的动力
的右上角点个⭐ Star 和 Fork，您的支持是 Chat2DB 变得更好最大的动力
### 数据源管理
### SQL 控制台 及 AI 智能助手
#### 使用前需要配置 OpenAI 的 Api Key 及本地代理配置
## 🔥 AI 配置
### 使用 ChatGPT
方式一（推荐）：使用 OPENAI 的 ChatSql 功能需要满足两个条件
- 1、需要有一个 openAI 的 key：OPENAI_API_KEY
- 2、客户端网络可以连接到 OPENAI 官网，国内需要科学上网。注意：如果本地 VPN 未能全局生效，可以通过在客户端中设置网络代理 HOST 和 PORT 来保证网络连通性
- 
方式二（推荐）：使用我们提供了一个统一的代理服务。
- 1、不需要 openAI 的 key
- 2、不需要代理，不需要 VPN 只要可以联网即可使用。
为了方便大家更快速的使用 AI 的能力，可以关注微信公众号，回复"AI" 获得我们的自定义 API_KEY，申请完成之后参考下图进行配置即可进行使用
## 📦 Docker 部署
```bash
// 拉取最新客户端,然后运行docker,名字是 `chat2db` , 并且将 `/root/.chat2db` 挂载到 `~/.chat2db-docker`
docker run --name=chat2db -ti -p 10824:10824 -v ~/.chat2db-docker:/root/.chat2db chat2db/chat2db:latest
// 这里正常会提示`Tomcat started on port(s): 10824 (http) with context path` 就可以结束了
// 如果这里提示 `The container name "/chat2db" is already in use by container`, 代表已经存在容器了 运行
docker start chat2db
// 如果想更新chat2db 则需要先rm
docker rm chat2db
```
## 🎯 运行环境
注意：
如果需要本地调试
- java 运行 Open JDK 17
- Node 运行环境 Node16 Node.js.
## 💻 本地调试
- git clone 到本地
```bash
$ git clone git@github.com:chat2db/Chat2DB.git
```
- 前端调试
```bash
node版本必须为16及以上
一定要用yarn
$ cd Chat2DB/chat2db-client
$ yarn
$ yarn run start:web
```
- 后端调试
```bash
$ cd ../chat2db-server
$ mvn clean install # 需要安装maven 3.8以上版本
$ cd chat2db-server/chat2db-server-start/target/
$ java -jar -Dloader.path=/lib -Dchatgpt.apiKey=xxxxx chat2db-server-start.jar # 启动应用 chatgpt.apiKey 需要输入ChatGPT的key,如果不输入无法使用AIGC功能
```
## 📑 文档
- 官方文档
- Issue
## 常见问题
### 1、无法获取数据源驱动:getJDBCDriver error: null
问题原因：无法联网导致下载数据库驱动包失败。
解决办法：手动下载相关驱动放入到 ~/.chat2db/jdbc-lib 目录下
下载链接 参考：Application jdbc-jar-downLoad-urls
- https://oss-chat2db.alibaba.com/lib/mysql-connector-java-8.0.30.jar
- https://oss-chat2db.alibaba.com/lib/mysql-connector-java-5.1.47.jar
- https://oss-chat2db.alibaba.com/lib/clickhouse-jdbc-0.3.2-patch8-http.jar
- https://oss-chat2db.alibaba.com/lib/mariadb-java-client-3.0.8.jar
- https://oss-chat2db.alibaba.com/lib/mssql-jdbc-11.2.1.jre17.jar
- https://oss-chat2db.alibaba.com/lib/oceanbase-client-2.4.2.jar
- https://oss-chat2db.alibaba.com/lib/postgresql-42.5.1.jar
- https://oss-chat2db.alibaba.com/lib/sqlite-jdbc-3.39.3.0.jar
- https://oss-chat2db.alibaba.com/lib/ojdbc11.jar
## Stargazers
[](https://github.com/chat2db/Chat2DB/stargazers)
## Forkers
[](https://github.com/chat2db/Chat2DB/network/members)
## ☎️ 联系我们
加群前请先 Star 和 Fork，谢谢~关注微信公众号可加入微信、钉钉、QQ 群一起讨论，并可以获取 Chat2DB 最新动态和更新。