docs(README): remove redundant content
This commit is contained in:
ghmark675
+22
-102
@@ -206,124 +206,44 @@ Weibo_PublicOpinion_AnalysisSystem/
|
|||||||
|
|
||||||
## 🚀 Quick Start
|
## 🚀 Quick Start
|
||||||
|
|
||||||
### 1. 🐳 Pulling the Docker Image
|
### 1. Starting the Project
|
||||||
|
|
||||||
|
This project utilizes `docker compose` for managing and running multiple services.
|
||||||
|
|
||||||
|
1. **Locate File:** Navigate to the directory containing the provided `docker-compose.yml` file.
|
||||||
|
|
||||||
You can view all available versions of the BettaFish Docker image on the GitHub Container Registry (GHCR) here:
|
2. **Run Command:** Execute the following command to start all services in the **background**:
|
||||||
|
|
||||||
https://github.com/666ghj/BettaFish/pkgs/container/bettafish
|
```bash
|
||||||
|
|
||||||
Use the following command to pull the image:
|
|
||||||
|
|
||||||
Bash
|
|
||||||
|
|
||||||
```
|
|
||||||
docker pull ghcr.io/666ghj/bettafish:latest
|
|
||||||
```
|
|
||||||
|
|
||||||
> ⚠️ **Note:** If the pull speed is slow, you can try replacing the registry address `ghcr.io` with `ghcr.nju.edu.cn` for faster download:
|
|
||||||
>
|
|
||||||
> Bash
|
|
||||||
>
|
|
||||||
> ```
|
|
||||||
> docker pull ghcr.nju.edu.cn/666ghj/bettafish:latest
|
|
||||||
> ```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 2. 🚀 Running with Docker Compose
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
After pulling the image, you need to use the provided `docker-compose.yml` file to start the service.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### A. Modifying `docker-compose.yml`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Open the `docker-compose.yml` file in your project and modify the `image` field under the `bettafish` service. Replace its value with the **full name of the image** you just pulled.
|
|
||||||
|
|
||||||
**Example:**
|
|
||||||
|
|
||||||
Change the original configuration:
|
|
||||||
|
|
||||||
YAML
|
|
||||||
|
|
||||||
```
|
|
||||||
services:
|
|
||||||
bettafish:
|
|
||||||
build:
|
|
||||||
context: .
|
|
||||||
dockerfile: Dockerfile
|
|
||||||
image: bettafish:latest # <-- Replace this image name with the one you pulled
|
|
||||||
container_name: bettafish
|
|
||||||
# ... other configurations
|
|
||||||
```
|
|
||||||
|
|
||||||
To (using `ghcr.io/666ghj/bettafish:latest` as an example:
|
|
||||||
|
|
||||||
YAML
|
|
||||||
|
|
||||||
```
|
|
||||||
services:
|
|
||||||
bettafish:
|
|
||||||
image: ghcr.io/666ghj/bettafish:latest # <-- Replace with the image name you pulled
|
|
||||||
container_name: bettafish
|
|
||||||
# ... other configurations
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### B. Starting the Service
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
In the directory containing the modified `docker-compose.yml` file, execute the following command to start the service:
|
|
||||||
|
|
||||||
Bash
|
|
||||||
|
|
||||||
```
|
|
||||||
docker compose up -d
|
docker compose up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> **⚠️ Note: Slow Image Pull**
|
||||||
|
|
||||||
|
> If you encounter slow image pulling speeds, you can modify the `image` field under the corresponding service in the `docker-compose.yml` file to use an alternative image source.
|
||||||
|
|
||||||
### 3. ⚙️ System Configuration (Database and Models)
|
> In the original `docker-compose.yml` file, we have provided alternative (or mirror) image addresses as **comments** for you to replace with.
|
||||||
|
|
||||||
|
### 2. Configuration Instructions
|
||||||
|
|
||||||
|
#### Database Configuration
|
||||||
|
|
||||||
After the service starts, you need to configure the system.
|
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
|
||||||
|
|
||||||
#### A. Database 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.
|
||||||
|
|
||||||
Please configure the database connection with the following parameters:
|
|
||||||
|
|
||||||
| **Parameter** | **Value** | **Description** |
|
|
||||||
| --------------- | ----------- | --------------------------------------------------- |
|
|
||||||
| **DB_HOST** | `db` | Database service name (in `docker-compose` network) |
|
|
||||||
| **DB_PORT** | `5432` | Database port (PostgreSQL default) |
|
|
||||||
| **DB_USER** | `bettafish` | Database username |
|
|
||||||
| **DB_PASSWORD** | `bettafish` | Database password |
|
|
||||||
| **DB_NAME** | `bettafish` | Database name |
|
|
||||||
|
|
||||||
> **Tip:** You should **keep the default values** for any other database-related parameters.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### B. Large Language Model (LLM) Configuration
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
After completing the database configuration, proceed to configure all the Large Language Model related parameters that you intend to use.
|
|
||||||
|
|
||||||
Once the configuration is complete, the system should start and run normally.
|
|
||||||
|
|
||||||
|
|
||||||
## 💻 ⚙️ Source Code Startup Guide
|
## 💻 ⚙️ Source Code Startup Guide
|
||||||
|
|||||||
@@ -206,122 +206,44 @@ Weibo_PublicOpinion_AnalysisSystem/
|
|||||||
|
|
||||||
## 🚀 快速开始（docker）
|
## 🚀 快速开始（docker）
|
||||||
|
|
||||||
### 1. 🐳 拉取 Docker 镜像
|
### 1. 启动项目
|
||||||
|
|
||||||
|
本项目使用 `docker compose` 进行多服务管理和运行。
|
||||||
|
|
||||||
|
1. **定位文件：** 切换到包含项目提供的 `docker-compose.yml` 文件的目录下。
|
||||||
|
|
||||||
您可以从 GitHub Container Registry (GHCR) 查看所有可用的 BettaFish Docker 镜像版本，请访问：
|
2. **运行命令：** 执行以下命令在**后台**启动所有服务：
|
||||||
|
|
||||||
https://github.com/666ghj/BettaFish/pkgs/container/bettafish
|
```bash
|
||||||
|
|
||||||
使用以下命令拉取镜像：
|
|
||||||
|
|
||||||
Bash
|
|
||||||
|
|
||||||
```
|
|
||||||
docker pull ghcr.io/666ghj/bettafish:latest
|
|
||||||
```
|
|
||||||
|
|
||||||
> ⚠️ **注意：** 如果拉取速度较慢，您可以尝试将镜像仓库地址 `ghcr.io` 替换为 `ghcr.nju.edu.cn` 进行加速：
|
|
||||||
>
|
|
||||||
> Bash
|
|
||||||
>
|
|
||||||
> ```
|
|
||||||
> docker pull ghcr.nju.edu.cn/666ghj/bettafish:latest
|
|
||||||
> ```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 2. 🚀 使用 Docker Compose 运行
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
拉取镜像后，您需要使用项目代码中提供的 `docker-compose.yml` 文件来启动服务。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### A. 修改 `docker-compose.yml`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
打开项目中的 `docker-compose.yml` 文件，并修改 `bettafish` 服务下的 `image` 字段。将其值替换为您刚才拉取的**完整镜像名称**。
|
|
||||||
|
|
||||||
**示例：**
|
|
||||||
|
|
||||||
将原始配置：
|
|
||||||
|
|
||||||
YAML
|
|
||||||
|
|
||||||
```
|
|
||||||
services:
|
|
||||||
bettafish:
|
|
||||||
build:
|
|
||||||
context: .
|
|
||||||
dockerfile: Dockerfile
|
|
||||||
image: bettafish:latest # <-- 将此处的镜像名称替换为你拉取的名称
|
|
||||||
container_name: bettafish
|
|
||||||
# ... 其他配置
|
|
||||||
```
|
|
||||||
|
|
||||||
修改为（以 `ghcr.io/666ghj/bettafish:latest` 为例）：
|
|
||||||
|
|
||||||
YAML
|
|
||||||
|
|
||||||
```
|
|
||||||
services:
|
|
||||||
bettafish:
|
|
||||||
image: ghcr.io/666ghj/bettafish:latest # <-- 替换为你拉取的镜像名称
|
|
||||||
container_name: bettafish
|
|
||||||
# ... 其他配置
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### B. 启动服务
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
在包含修改后的 `docker-compose.yml` 文件的目录下，执行以下命令启动服务：
|
|
||||||
|
|
||||||
Bash
|
|
||||||
|
|
||||||
```
|
|
||||||
docker compose up -d
|
docker compose up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> **⚠️ 注意：镜像拉取速度慢**
|
||||||
|
|
||||||
|
> 如果您在拉取镜像时遇到速度过慢的问题，可以修改 `docker-compose.yml` 文件中对应服务下的 `image` 字段，以使用其他的镜像源。
|
||||||
|
|
||||||
### 3. ⚙️ 系统配置（数据库与模型）
|
> 在原 `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` | 数据库名称 |
|
||||||
|
| **其他** | **保持默认** | 数据库连接池等其他参数请保持默认设置。 |
|
||||||
|
|
||||||
|
#### 大模型配置
|
||||||
|
|
||||||
#### A. 数据库配置
|
在完成数据库配置后，请正常配置**所有大模型相关的参数**，确保系统能够连接到您选择的大模型服务。
|
||||||
|
|
||||||
|
完成上述所有配置并保存后，系统即可正常运行。
|
||||||
|
|
||||||
请按照以下参数配置数据库连接：
|
|
||||||
|
|
||||||
| **参数** | **值** | **说明** |
|
|
||||||
| --------------- | ----------- | -------------------------------------------- |
|
|
||||||
| **DB_HOST** | `db` | 数据库服务名称（在 `docker-compose` 网络中） |
|
|
||||||
| **DB_PORT** | `5432` | 数据库端口（PostgreSQL 默认） |
|
|
||||||
| **DB_USER** | `bettafish` | 数据库用户名 |
|
|
||||||
| **DB_PASSWORD** | `bettafish` | 数据库密码 |
|
|
||||||
| **DB_NAME** | `bettafish` | 数据库名称 |
|
|
||||||
|
|
||||||
> **提示：** 除上述参数外，其他数据库相关配置请**保留默认值**。
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### B. 大模型配置
|
|
||||||
|
|
||||||
完成数据库配置后，请正常配置所有您需要使用的大模型相关参数。
|
|
||||||
|
|
||||||
配置完成后，系统即可启动并正常运行。
|
|
||||||
|
|
||||||
------
|
------
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user