ghmark675

docs(README): add one-click docker tutorial

Showing 1 changed file with 122 additions and 1 deletions
@@ -204,7 +204,128 @@ Weibo_PublicOpinion_AnalysisSystem/ @@ -204,7 +204,128 @@ Weibo_PublicOpinion_AnalysisSystem/
204 └── requirements.txt # Python依赖包清单 204 └── requirements.txt # Python依赖包清单
205 ``` 205 ```
206 206
207 -## 🚀 快速开始 207 +## 🚀 快速开始(docker)
  208 +
  209 +### 1. 🐳 拉取 Docker 镜像
  210 +
  211 +
  212 +
  213 +您可以从 GitHub Container Registry (GHCR) 查看所有可用的 BettaFish Docker 镜像版本,请访问:
  214 +
  215 +https://github.com/666ghj/BettaFish/pkgs/container/bettafish
  216 +
  217 +使用以下命令拉取镜像:
  218 +
  219 +Bash
  220 +
  221 +```
  222 +docker pull ghcr.io/666ghj/bettafish:latest
  223 +```
  224 +
  225 +> ⚠️ **注意:** 如果拉取速度较慢,您可以尝试将镜像仓库地址 `ghcr.io` 替换为 `ghcr.nju.edu.cn` 进行加速:
  226 +>
  227 +> Bash
  228 +>
  229 +> ```
  230 +> docker pull ghcr.nju.edu.cn/666ghj/bettafish:latest
  231 +> ```
  232 +
  233 +
  234 +
  235 +### 2. 🚀 使用 Docker Compose 运行
  236 +
  237 +
  238 +
  239 +拉取镜像后,您需要使用项目代码中提供的 `docker-compose.yml` 文件来启动服务。
  240 +
  241 +
  242 +
  243 +#### A. 修改 `docker-compose.yml`
  244 +
  245 +
  246 +
  247 +打开项目中的 `docker-compose.yml` 文件,并修改 `bettafish` 服务下的 `image` 字段。将其值替换为您刚才拉取的**完整镜像名称**
  248 +
  249 +**示例:**
  250 +
  251 +将原始配置:
  252 +
  253 +YAML
  254 +
  255 +```
  256 +services:
  257 + bettafish:
  258 + build:
  259 + context: .
  260 + dockerfile: Dockerfile
  261 + image: bettafish:latest # <-- 将此处的镜像名称替换为你拉取的名称
  262 + container_name: bettafish
  263 +# ... 其他配置
  264 +```
  265 +
  266 +修改为(以 `ghcr.io/666ghj/bettafish:latest` 为例):
  267 +
  268 +YAML
  269 +
  270 +```
  271 +services:
  272 + bettafish:
  273 + image: ghcr.io/666ghj/bettafish:latest # <-- 替换为你拉取的镜像名称
  274 + container_name: bettafish
  275 +# ... 其他配置
  276 +```
  277 +
  278 +
  279 +
  280 +#### B. 启动服务
  281 +
  282 +
  283 +
  284 +在包含修改后的 `docker-compose.yml` 文件的目录下,执行以下命令启动服务:
  285 +
  286 +Bash
  287 +
  288 +```
  289 +docker compose up -d
  290 +```
  291 +
  292 +
  293 +
  294 +### 3. ⚙️ 系统配置(数据库与模型)
  295 +
  296 +
  297 +
  298 +服务启动后,您需要进入系统进行配置。
  299 +
  300 +
  301 +
  302 +#### A. 数据库配置
  303 +
  304 +
  305 +
  306 +请按照以下参数配置数据库连接:
  307 +
  308 +| **参数** | **值** | **说明** |
  309 +| --------------- | ----------- | -------------------------------------------- |
  310 +| **DB_HOST** | `db` | 数据库服务名称(在 `docker-compose` 网络中) |
  311 +| **DB_PORT** | `5432` | 数据库端口(PostgreSQL 默认) |
  312 +| **DB_USER** | `bettafish` | 数据库用户名 |
  313 +| **DB_PASSWORD** | `bettafish` | 数据库密码 |
  314 +| **DB_NAME** | `bettafish` | 数据库名称 |
  315 +
  316 +> **提示:** 除上述参数外,其他数据库相关配置请**保留默认值**。
  317 +
  318 +
  319 +
  320 +#### B. 大模型配置
  321 +
  322 +完成数据库配置后,请正常配置所有您需要使用的大模型相关参数。
  323 +
  324 +配置完成后,系统即可启动并正常运行。
  325 +
  326 +------
  327 +
  328 +## 💻 🔧 源码启动指南
208 329
209 > 如果你是初次学习一个Agent系统的搭建,可以从一个非常简单的demo开始:[Deep Search Agent Demo](https://github.com/666ghj/DeepSearchAgent-Demo) 330 > 如果你是初次学习一个Agent系统的搭建,可以从一个非常简单的demo开始:[Deep Search Agent Demo](https://github.com/666ghj/DeepSearchAgent-Demo)
210 331