ghmark675

docs(README-EN): add one-click docker tutorial

@@ -206,6 +206,128 @@ Weibo_PublicOpinion_AnalysisSystem/ @@ -206,6 +206,128 @@ Weibo_PublicOpinion_AnalysisSystem/
206 206
207 ## 🚀 Quick Start 207 ## 🚀 Quick Start
208 208
  209 +### 1. 🐳 Pulling the Docker Image
  210 +
  211 +
  212 +
  213 +You can view all available versions of the BettaFish Docker image on the GitHub Container Registry (GHCR) here:
  214 +
  215 +https://github.com/666ghj/BettaFish/pkgs/container/bettafish
  216 +
  217 +Use the following command to pull the image:
  218 +
  219 +Bash
  220 +
  221 +```
  222 +docker pull ghcr.io/666ghj/bettafish:latest
  223 +```
  224 +
  225 +> ⚠️ **Note:** If the pull speed is slow, you can try replacing the registry address `ghcr.io` with `ghcr.nju.edu.cn` for faster download:
  226 +>
  227 +> Bash
  228 +>
  229 +> ```
  230 +> docker pull ghcr.nju.edu.cn/666ghj/bettafish:latest
  231 +> ```
  232 +
  233 +
  234 +
  235 +### 2. 🚀 Running with Docker Compose
  236 +
  237 +
  238 +
  239 +After pulling the image, you need to use the provided `docker-compose.yml` file to start the service.
  240 +
  241 +
  242 +
  243 +#### A. Modifying `docker-compose.yml`
  244 +
  245 +
  246 +
  247 +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.
  248 +
  249 +**Example:**
  250 +
  251 +Change the original configuration:
  252 +
  253 +YAML
  254 +
  255 +```
  256 +services:
  257 + bettafish:
  258 + build:
  259 + context: .
  260 + dockerfile: Dockerfile
  261 + image: bettafish:latest # <-- Replace this image name with the one you pulled
  262 + container_name: bettafish
  263 +# ... other configurations
  264 +```
  265 +
  266 +To (using `ghcr.io/666ghj/bettafish:latest` as an example:
  267 +
  268 +YAML
  269 +
  270 +```
  271 +services:
  272 + bettafish:
  273 + image: ghcr.io/666ghj/bettafish:latest # <-- Replace with the image name you pulled
  274 + container_name: bettafish
  275 +# ... other configurations
  276 +```
  277 +
  278 +
  279 +
  280 +#### B. Starting the Service
  281 +
  282 +
  283 +
  284 +In the directory containing the modified `docker-compose.yml` file, execute the following command to start the service:
  285 +
  286 +Bash
  287 +
  288 +```
  289 +docker compose up -d
  290 +```
  291 +
  292 +
  293 +
  294 +### 3. ⚙️ System Configuration (Database and Models)
  295 +
  296 +
  297 +
  298 +After the service starts, you need to configure the system.
  299 +
  300 +
  301 +
  302 +#### A. Database Configuration
  303 +
  304 +
  305 +
  306 +Please configure the database connection with the following parameters:
  307 +
  308 +| **Parameter** | **Value** | **Description** |
  309 +| --------------- | ----------- | --------------------------------------------------- |
  310 +| **DB_HOST** | `db` | Database service name (in `docker-compose` network) |
  311 +| **DB_PORT** | `5432` | Database port (PostgreSQL default) |
  312 +| **DB_USER** | `bettafish` | Database username |
  313 +| **DB_PASSWORD** | `bettafish` | Database password |
  314 +| **DB_NAME** | `bettafish` | Database name |
  315 +
  316 +> **Tip:** You should **keep the default values** for any other database-related parameters.
  317 +
  318 +
  319 +
  320 +#### B. Large Language Model (LLM) Configuration
  321 +
  322 +
  323 +
  324 +After completing the database configuration, proceed to configure all the Large Language Model related parameters that you intend to use.
  325 +
  326 +Once the configuration is complete, the system should start and run normally.
  327 +
  328 +
  329 +## 💻 ⚙️ Source Code Startup Guide
  330 +
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) 331 > 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 332
211 ### System Requirements 333 ### System Requirements