Chat2DB

环境要求

• Docker 19.03.0 及以上
• Docker Compose 2.0.0 及以上（仅使用 Compose 方式时需要，要求 Compose V2）
• 2 核及以上 CPU
• 4 GiB 及以上内存
• 能访问 GitHub 与 Docker 镜像仓库（用于克隆仓库和拉取 chat2db/chat2db:latest）

安装与启动步骤

1. 1克隆仓库

   从 GitHub 拉取 Chat2DB 源码并进入项目目录，加密密钥脚本就在仓库的 script 目录中。

   git clone https://github.com/OtterMind/Chat2DB.git && cd Chat2DB

   复制

2. 2生成加密密钥

   在仓库目录下运行脚本生成社区版加密密钥，重复执行会复用同一个有效密钥，无需重复生成。

   ./script/security/init-community-encryption-key.sh

   复制

3. 3启动容器

   后台启动官方镜像，映射 127.0.0.1:10825 端口，挂载数据目录并只读挂载加密密钥文件。

   docker run --detach 
     --name chat2db-community 
     --restart unless-stopped 
     --publish 127.0.0.1:10825:10825 
     --volume "$HOME/.chat2db-community-docker:/root/.chat2db-community" 
     --env CHAT2DB_COMMUNITY_ENCRYPTION_KEY_FILE=/run/secrets/chat2db-community-encryption.key 
     --volume "$HOME/.config/chat2db-community/encryption.key:/run/secrets/chat2db-community-encryption.key:ro" 
     chat2db/chat2db:latest

   复制

4. 4打开 Web 界面

   在浏览器访问 http://localhost:10825，即可使用 SQL 工作台连接自己的数据库并配置 AI 模型。

5. 5可选：Compose 启动

   用仓库自带的 compose 文件启动，数据存放在 chat2db-community-data 命名卷，与 docker run 方式数据不共享。

   ./script/security/init-community-encryption-key.sh
   docker compose --file docker/docker-compose.yml up --detach

   复制

6. 6可选：构建本地镜像

   如需自行构建镜像，脚本第一个参数是版本号，第二个参数是镜像标签，版本号需保持一致。

   ./docker/docker-build.sh 5.3.0 chat2db/chat2db:5.3.0

   复制

关键配置

如何确认成功

执行 docker ps 能看到 chat2db-community 容器处于运行状态，浏览器打开 http://localhost:10825 能正常显示界面即成功。

常见问题

注意事项

• 必须先执行 init-community-encryption-key.sh 生成密钥，再启动容器。
• 容器默认只绑定 127.0.0.1，如需外部访问要自行调整端口映射并注意安全风险。
• README 的 Quick Start 只给出了 Docker 方式，桌面端与 Web 端其他安装方式未在节选中说明。
• 构建本地镜像时镜像标签中的版本号需与脚本第一个参数保持一致。