Committed by
GitHub
Merge pull request #189 from 666ghj/dev
Docker Compose tutorial
Showing
3 changed files
with
77 additions
and
5 deletions
| @@ -206,6 +206,42 @@ Weibo_PublicOpinion_AnalysisSystem/ | @@ -206,6 +206,42 @@ Weibo_PublicOpinion_AnalysisSystem/ | ||
| 206 | 206 | ||
| 207 | ## 🚀 Quick Start | 207 | ## 🚀 Quick Start |
| 208 | 208 | ||
| 209 | +### 1. Starting the Project | ||
| 210 | + | ||
| 211 | +**Run Command:** Execute the following command to start all services in the **background**: | ||
| 212 | + | ||
| 213 | +```bash | ||
| 214 | +docker compose up -d | ||
| 215 | +``` | ||
| 216 | + | ||
| 217 | +> **⚠️ Note: Slow Image Pull** | ||
| 218 | + | ||
| 219 | +> In the original `docker-compose.yml` file, we have provided alternative (mirror) image addresses as **comments** for you to replace with. | ||
| 220 | + | ||
| 221 | +### 2. Configuration Instructions | ||
| 222 | + | ||
| 223 | +#### Database Configuration | ||
| 224 | + | ||
| 225 | +Please configure the database connection information with the following parameters: | ||
| 226 | + | ||
| 227 | +| Configuration Item | Value to Use | Description | | ||
| 228 | +| :--- | :--- | :--- | | ||
| 229 | +| `DB_HOST` | `db` | Database service name (as defined in `docker-compose.yml`) | | ||
| 230 | +| `DB_PORT` | `5432` | Default PostgreSQL port | | ||
| 231 | +| `DB_USER` | `bettafish` | Database username | | ||
| 232 | +| `DB_PASSWORD` | `bettafish` | Database password | | ||
| 233 | +| `DB_NAME` | `bettafish` | Database name | | ||
| 234 | +| **Others** | **Keep Default** | Please keep other parameters, such as database connection pool settings, at their default values. | | ||
| 235 | + | ||
| 236 | +### Large Language Model (LLM) Configuration | ||
| 237 | + | ||
| 238 | +After completing the database configuration, please proceed to configure **all Large Language Model related parameters** to ensure the system can connect to your chosen LLM service. | ||
| 239 | + | ||
| 240 | +Upon completing and saving all the configurations above, the system should be ready to run normally. | ||
| 241 | + | ||
| 242 | + | ||
| 243 | +## 💻 ⚙️ Source Code Startup Guide | ||
| 244 | + | ||
| 209 | > If you are new to building Agent systems, you can start with a very simple demo: [Deep Search Agent Demo](https://github.com/666ghj/DeepSearchAgent-Demo) | 245 | > If you are new to building Agent systems, you can start with a very simple demo: [Deep Search Agent Demo](https://github.com/666ghj/DeepSearchAgent-Demo) |
| 210 | 246 | ||
| 211 | ### System Requirements | 247 | ### System Requirements |
| @@ -204,7 +204,44 @@ Weibo_PublicOpinion_AnalysisSystem/ | @@ -204,7 +204,44 @@ Weibo_PublicOpinion_AnalysisSystem/ | ||
| 204 | └── requirements.txt # Python依赖包清单 | 204 | └── requirements.txt # Python依赖包清单 |
| 205 | ``` | 205 | ``` |
| 206 | 206 | ||
| 207 | -## 🚀 快速开始 | 207 | +## 🚀 快速开始(docker) |
| 208 | + | ||
| 209 | +### 1. 启动项目 | ||
| 210 | + | ||
| 211 | +**运行命令:** 执行以下命令在**后台**启动所有服务: | ||
| 212 | + | ||
| 213 | +```bash | ||
| 214 | +docker compose up -d | ||
| 215 | +``` | ||
| 216 | + | ||
| 217 | +> **⚠️ 注意:镜像拉取速度慢** | ||
| 218 | + | ||
| 219 | +> 在原 `docker-compose.yml` 文件中,我们已经通过**注释**的方式提供了备用镜像地址供您替换。 | ||
| 220 | + | ||
| 221 | +### 2. 配置说明 | ||
| 222 | + | ||
| 223 | +#### 数据库配置 (Database Configuration) | ||
| 224 | + | ||
| 225 | +请按照以下参数配置数据库连接信息: | ||
| 226 | + | ||
| 227 | +| 配置项 | 填写值 | 说明 | | ||
| 228 | +| :--- | :--- | :--- | | ||
| 229 | +| `DB_HOST` | `db` | 数据库服务名称 (对应 `docker-compose.yml` 中的服务名) | | ||
| 230 | +| `DB_PORT` | `5432` | 默认 PostgreSQL 端口 | | ||
| 231 | +| `DB_USER` | `bettafish` | 数据库用户名 | | ||
| 232 | +| `DB_PASSWORD` | `bettafish` | 数据库密码 | | ||
| 233 | +| `DB_NAME` | `bettafish` | 数据库名称 | | ||
| 234 | +| **其他** | **保持默认** | 数据库连接池等其他参数请保持默认设置。 | | ||
| 235 | + | ||
| 236 | +#### 大模型配置 | ||
| 237 | + | ||
| 238 | +在完成数据库配置后,请正常配置**所有大模型相关的参数**,确保系统能够连接到您选择的大模型服务。 | ||
| 239 | + | ||
| 240 | +完成上述所有配置并保存后,系统即可正常运行。 | ||
| 241 | + | ||
| 242 | +------ | ||
| 243 | + | ||
| 244 | +## 💻 🔧 源码启动指南 | ||
| 208 | 245 | ||
| 209 | > 如果你是初次学习一个Agent系统的搭建,可以从一个非常简单的demo开始:[Deep Search Agent Demo](https://github.com/666ghj/DeepSearchAgent-Demo) | 246 | > 如果你是初次学习一个Agent系统的搭建,可以从一个非常简单的demo开始:[Deep Search Agent Demo](https://github.com/666ghj/DeepSearchAgent-Demo) |
| 210 | 247 |
| @@ -2,10 +2,9 @@ version: "3.9" | @@ -2,10 +2,9 @@ version: "3.9" | ||
| 2 | 2 | ||
| 3 | services: | 3 | services: |
| 4 | bettafish: | 4 | bettafish: |
| 5 | - build: | ||
| 6 | - context: . | ||
| 7 | - dockerfile: Dockerfile | ||
| 8 | - image: bettafish:latest | 5 | + image: ghcr.io/666ghj/bettafish:latest |
| 6 | + # Speed up mirror | ||
| 7 | + # image: ghcr.nju.edu.cn/666ghj/bettafish:latest | ||
| 9 | container_name: bettafish | 8 | container_name: bettafish |
| 10 | restart: unless-stopped | 9 | restart: unless-stopped |
| 11 | environment: | 10 | environment: |
-
Please register or login to post a comment