ghmark675
Committed by GitHub

Merge pull request #189 from 666ghj/dev

Docker Compose tutorial
... ... @@ -206,6 +206,42 @@ Weibo_PublicOpinion_AnalysisSystem/
## 🚀 Quick Start
### 1. Starting the Project
**Run Command:** Execute the following command to start all services in the **background**:
```bash
docker compose up -d
```
> **⚠️ Note: Slow Image Pull**
> In the original `docker-compose.yml` file, we have provided alternative (mirror) image addresses as **comments** for you to replace with.
### 2. Configuration Instructions
#### Database Configuration
Please configure the database connection information with the following parameters:
| Configuration Item | Value to Use | Description |
| :--- | :--- | :--- |
| `DB_HOST` | `db` | Database service name (as defined in `docker-compose.yml`) |
| `DB_PORT` | `5432` | Default PostgreSQL port |
| `DB_USER` | `bettafish` | Database username |
| `DB_PASSWORD` | `bettafish` | Database password |
| `DB_NAME` | `bettafish` | Database name |
| **Others** | **Keep Default** | Please keep other parameters, such as database connection pool settings, at their default values. |
### Large Language Model (LLM) Configuration
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.
Upon completing and saving all the configurations above, the system should be ready to run normally.
## 💻 ⚙️ Source Code Startup Guide
> 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)
### System Requirements
... ...
... ... @@ -204,7 +204,44 @@ Weibo_PublicOpinion_AnalysisSystem/
└── requirements.txt # Python依赖包清单
```
## 🚀 快速开始
## 🚀 快速开始(docker)
### 1. 启动项目
**运行命令:** 执行以下命令在**后台**启动所有服务:
```bash
docker compose up -d
```
> **⚠️ 注意:镜像拉取速度慢**
> 在原 `docker-compose.yml` 文件中,我们已经通过**注释**的方式提供了备用镜像地址供您替换。
### 2. 配置说明
#### 数据库配置 (Database Configuration)
请按照以下参数配置数据库连接信息:
| 配置项 | 填写值 | 说明 |
| :--- | :--- | :--- |
| `DB_HOST` | `db` | 数据库服务名称 (对应 `docker-compose.yml` 中的服务名) |
| `DB_PORT` | `5432` | 默认 PostgreSQL 端口 |
| `DB_USER` | `bettafish` | 数据库用户名 |
| `DB_PASSWORD` | `bettafish` | 数据库密码 |
| `DB_NAME` | `bettafish` | 数据库名称 |
| **其他** | **保持默认** | 数据库连接池等其他参数请保持默认设置。 |
#### 大模型配置
在完成数据库配置后,请正常配置**所有大模型相关的参数**,确保系统能够连接到您选择的大模型服务。
完成上述所有配置并保存后,系统即可正常运行。
------
## 💻 🔧 源码启动指南
> 如果你是初次学习一个Agent系统的搭建,可以从一个非常简单的demo开始:[Deep Search Agent Demo](https://github.com/666ghj/DeepSearchAgent-Demo)
... ...
... ... @@ -2,10 +2,9 @@ version: "3.9"
services:
bettafish:
build:
context: .
dockerfile: Dockerfile
image: bettafish:latest
image: ghcr.io/666ghj/bettafish:latest
# Speed up mirror
# image: ghcr.nju.edu.cn/666ghj/bettafish:latest
container_name: bettafish
restart: unless-stopped
environment:
... ...