Skip to content

Commit e4274b1

Browse files
committed
docs: 文档命令修正
1 parent 0af44e9 commit e4274b1

2 files changed

Lines changed: 65 additions & 65 deletions

File tree

README-EN.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -397,7 +397,7 @@ Transform from "algorithm recommendation captivity" to "actively getting the inf
397397

398398
**🔧 Upgrade Instructions**:
399399
- **GitHub Fork Users**: Update `main.py`, `config/config.yaml` (Added multi-account push support, existing single-account configuration unaffected)
400-
- **Docker Users**: Update `.env`, `docker-compose.yml` or set environment variables `REVERSE_CONTENT_ORDER`, `MAX_ACCOUNTS_PER_CHANNEL`
400+
- **Docker Users**: Update `.env`, `docker compose.yml` or set environment variables `REVERSE_CONTENT_ORDER`, `MAX_ACCOUNTS_PER_CHANNEL`
401401
- **Multi-Account Push**: New feature, disabled by default, existing single-account configuration unaffected
402402

403403

@@ -520,7 +520,7 @@ Transform from "algorithm recommendation captivity" to "actively getting the inf
520520

521521
- **Added Personal WeChat Push Support**: WeWork application can push to personal WeChat without installing WeWork APP
522522
- Supports two message formats: `markdown` (WeWork group bot) and `text` (personal WeChat app)
523-
- Added `WEWORK_MSG_TYPE` environment variable configuration, supporting GitHub Actions, Docker, docker-compose and other deployment methods
523+
- Added `WEWORK_MSG_TYPE` environment variable configuration, supporting GitHub Actions, Docker, docker compose and other deployment methods
524524
- `text` mode automatically strips Markdown syntax for clean plain text push
525525
- See "Personal WeChat Push" configuration in Quick Start
526526

@@ -2018,7 +2018,7 @@ TrendRadar provides two independent Docker images, deploy according to your need
20182018

20192019
---
20202020

2021-
#### Method 1: Using docker-compose (Recommended)
2021+
#### Method 1: Using docker compose (Recommended)
20222022

20232023
1. **Create Project Directory and Config**:
20242024

@@ -2039,9 +2039,9 @@ TrendRadar provides two independent Docker images, deploy according to your need
20392039
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/config/config.yaml -P config/
20402040
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/config/frequency_words.txt -P config/
20412041
2042-
# Download docker-compose config
2042+
# Download docker compose config
20432043
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/docker/.env -P docker/
2044-
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/docker/docker-compose.yml -P docker/
2044+
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/docker/docker compose.yml -P docker/
20452045
```
20462046

20472047
> 💡 **Note**: Key directory structure required for Docker deployment:
@@ -2052,7 +2052,7 @@ current directory/
20522052
│ └── frequency_words.txt
20532053
└── docker/
20542054
├── .env
2055-
└── docker-compose.yml
2055+
└── docker compose.yml
20562056
```
20572057
20582058
2. **Config File Description**:
@@ -2082,32 +2082,32 @@ current directory/
20822082
**Usage Method**:
20832083
- Modify `.env` file, uncomment and fill in needed configs
20842084
- Or add directly in NAS/Synology Docker management interface's "Environment Variables"
2085-
- Restart container to take effect: `docker-compose up -d`
2085+
- Restart container to take effect: `docker compose up -d`
20862086
20872087
20882088
3. **Start Service**:
20892089
20902090
**Option A: Start All Services (Push + AI Analysis)**
20912091
```bash
20922092
# Pull latest images
2093-
docker-compose pull
2093+
docker compose pull
20942094
20952095
# Start all services (trend-radar + trend-radar-mcp)
2096-
docker-compose up -d
2096+
docker compose up -d
20972097
```
20982098

20992099
**Option B: Start News Push Service Only**
21002100
```bash
21012101
# Start trend-radar only (scheduled crawling and push)
2102-
docker-compose pull trend-radar
2103-
docker-compose up -d trend-radar
2102+
docker compose pull trend-radar
2103+
docker compose up -d trend-radar
21042104
```
21052105

21062106
**Option C: Start MCP AI Analysis Service Only**
21072107
```bash
21082108
# Start trend-radar-mcp only (AI analysis interface)
2109-
docker-compose pull trend-radar-mcp
2110-
docker-compose up -d trend-radar-mcp
2109+
docker compose pull trend-radar-mcp
2110+
docker compose up -d trend-radar-mcp
21112111
```
21122112

21132113
> 💡 **Tips**:
@@ -2127,8 +2127,8 @@ current directory/
21272127
docker ps | grep trend-radar
21282128

21292129
# Stop specific service
2130-
docker-compose stop trend-radar # Stop push service
2131-
docker-compose stop trend-radar-mcp # Stop MCP service
2130+
docker compose stop trend-radar # Stop push service
2131+
docker compose stop trend-radar-mcp # Stop MCP service
21322132
```
21332133

21342134
#### Method 2: Local Build (Developer Option)
@@ -2144,33 +2144,33 @@ cd TrendRadar
21442144
vim config/config.yaml
21452145
vim config/frequency_words.txt
21462146

2147-
# Use build version docker-compose
2147+
# Use build version docker compose
21482148
cd docker
2149-
cp docker-compose-build.yml docker-compose.yml
2149+
cp docker compose-build.yml docker compose.yml
21502150
```
21512151

21522152
**Build and Start Services**:
21532153

21542154
```bash
21552155
# Option A: Build and start all services
2156-
docker-compose build
2157-
docker-compose up -d
2156+
docker compose build
2157+
docker compose up -d
21582158

21592159
# Option B: Build and start news push service only
2160-
docker-compose build trend-radar
2161-
docker-compose up -d trend-radar
2160+
docker compose build trend-radar
2161+
docker compose up -d trend-radar
21622162

21632163
# Option C: Build and start MCP AI analysis service only
2164-
docker-compose build trend-radar-mcp
2165-
docker-compose up -d trend-radar-mcp
2164+
docker compose build trend-radar-mcp
2165+
docker compose up -d trend-radar-mcp
21662166
```
21672167

21682168
> 💡 **Architecture Parameter Notes**:
21692169
> - Default builds `amd64` architecture images (suitable for most x86_64 servers)
21702170
> - To build `arm64` architecture (Apple Silicon, Raspberry Pi, etc.), set environment variable:
21712171
> ```bash
21722172
> export DOCKER_ARCH=arm64
2173-
> docker-compose build
2173+
> docker compose build
21742174
> ```
21752175
21762176
#### Image Update
@@ -2179,12 +2179,12 @@ docker-compose up -d trend-radar-mcp
21792179
# Method 1: Manual update (Crawler + MCP images)
21802180
docker pull wantcat/trendradar:latest
21812181
docker pull wantcat/trendradar-mcp:latest
2182-
docker-compose down
2183-
docker-compose up -d
2182+
docker compose down
2183+
docker compose up -d
21842184
2185-
# Method 2: Using docker-compose update
2186-
docker-compose pull
2187-
docker-compose up -d
2185+
# Method 2: Using docker compose update
2186+
docker compose pull
2187+
docker compose up -d
21882188
```
21892189
21902190
**Available Images**:
@@ -2321,14 +2321,14 @@ flowchart TB
23212321

23222322
**Quick Start**:
23232323

2324-
Use docker-compose to start both news push and MCP services:
2324+
Use docker compose to start both news push and MCP services:
23252325

23262326
```bash
2327-
# Download latest docker-compose.yml (includes MCP service config)
2328-
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/docker/docker-compose.yml
2327+
# Download latest docker compose.yml (includes MCP service config)
2328+
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/docker/docker compose.yml
23292329

23302330
# Start all services
2331-
docker-compose up -d
2331+
docker compose up -d
23322332

23332333
# Check running status
23342334
docker ps | grep trend-radar

README.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -567,7 +567,7 @@ GitHub 一键 Fork 即可使用,无需编程基础。
567567

568568
- **新增个人微信推送支持**:企业微信应用可推送到个人微信,无需安装企业微信 APP
569569
- 支持两种消息格式:`markdown`(企业微信群机器人)和 `text`(个人微信应用)
570-
- 新增 `WEWORK_MSG_TYPE` 环境变量配置,支持 GitHub Actions、Docker、docker-compose 等多种部署方式
570+
- 新增 `WEWORK_MSG_TYPE` 环境变量配置,支持 GitHub Actions、Docker、docker compose 等多种部署方式
571571
- `text` 模式自动清除 Markdown 语法,提供纯文本推送效果
572572
- 详见快速开始中的「个人微信推送」配置说明
573573

@@ -2046,7 +2046,7 @@ TrendRadar 提供两个独立的 Docker 镜像,可根据需求选择部署:
20462046

20472047
---
20482048

2049-
#### 方式一:使用 docker-compose(推荐)
2049+
#### 方式一:使用 docker compose(推荐)
20502050

20512051
1. **创建项目目录和配置**:
20522052

@@ -2067,9 +2067,9 @@ TrendRadar 提供两个独立的 Docker 镜像,可根据需求选择部署:
20672067
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/config/config.yaml -P config/
20682068
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/config/frequency_words.txt -P config/
20692069
2070-
# 下载 docker-compose 配置
2070+
# 下载 docker compose 配置
20712071
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/docker/.env -P docker/
2072-
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/docker/docker-compose.yml -P docker/
2072+
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/docker/docker compose.yml -P docker/
20732073
```
20742074

20752075
> 💡 **说明**:Docker 部署需要的关键目录结构如下:
@@ -2080,7 +2080,7 @@ TrendRadar 提供两个独立的 Docker 镜像,可根据需求选择部署:
20802080
│ └── frequency_words.txt
20812081
└── docker/
20822082
├── .env
2083-
└── docker-compose.yml
2083+
└── docker compose.yml
20842084
```
20852085

20862086
2. **配置文件说明**:
@@ -2110,32 +2110,32 @@ TrendRadar 提供两个独立的 Docker 镜像,可根据需求选择部署:
21102110
**使用方法**:
21112111
- 修改 `.env` 文件,取消注释并填写需要的配置
21122112
- 或在 NAS/群晖 Docker 管理界面的"环境变量"中直接添加
2113-
- 重启容器后生效:`docker-compose up -d`
2113+
- 重启容器后生效:`docker compose up -d`
21142114

21152115

21162116
3. **启动服务**:
21172117

21182118
**选项 A:启动所有服务(推送 + AI 分析)**
21192119
```bash
21202120
# 拉取最新镜像
2121-
docker-compose pull
2121+
docker compose pull
21222122
21232123
# 启动所有服务(trend-radar + trend-radar-mcp)
2124-
docker-compose up -d
2124+
docker compose up -d
21252125
```
21262126

21272127
**选项 B:仅启动新闻推送服务**
21282128
```bash
21292129
# 只启动 trend-radar(定时抓取和推送)
2130-
docker-compose pull trend-radar
2131-
docker-compose up -d trend-radar
2130+
docker compose pull trend-radar
2131+
docker compose up -d trend-radar
21322132
```
21332133

21342134
**选项 C:仅启动 MCP AI 分析服务**
21352135
```bash
21362136
# 只启动 trend-radar-mcp(提供 AI 分析接口)
2137-
docker-compose pull trend-radar-mcp
2138-
docker-compose up -d trend-radar-mcp
2137+
docker compose pull trend-radar-mcp
2138+
docker compose up -d trend-radar-mcp
21392139
```
21402140

21412141
> 💡 **提示**:
@@ -2155,8 +2155,8 @@ TrendRadar 提供两个独立的 Docker 镜像,可根据需求选择部署:
21552155
docker ps | grep trend-radar
21562156
21572157
# 停止特定服务
2158-
docker-compose stop trend-radar # 停止推送服务
2159-
docker-compose stop trend-radar-mcp # 停止 MCP 服务
2158+
docker compose stop trend-radar # 停止推送服务
2159+
docker compose stop trend-radar-mcp # 停止 MCP 服务
21602160
```
21612161

21622162
#### 方式二:本地构建(开发者选项)
@@ -2172,33 +2172,33 @@ cd TrendRadar
21722172
vim config/config.yaml
21732173
vim config/frequency_words.txt
21742174
2175-
# 使用构建版本的 docker-compose
2175+
# 使用构建版本的 docker compose
21762176
cd docker
2177-
cp docker-compose-build.yml docker-compose.yml
2177+
cp docker compose-build.yml docker compose.yml
21782178
```
21792179

21802180
**构建并启动服务**:
21812181

21822182
```bash
21832183
# 选项 A:构建并启动所有服务
2184-
docker-compose build
2185-
docker-compose up -d
2184+
docker compose build
2185+
docker compose up -d
21862186
21872187
# 选项 B:仅构建并启动新闻推送服务
2188-
docker-compose build trend-radar
2189-
docker-compose up -d trend-radar
2188+
docker compose build trend-radar
2189+
docker compose up -d trend-radar
21902190
21912191
# 选项 C:仅构建并启动 MCP AI 分析服务
2192-
docker-compose build trend-radar-mcp
2193-
docker-compose up -d trend-radar-mcp
2192+
docker compose build trend-radar-mcp
2193+
docker compose up -d trend-radar-mcp
21942194
```
21952195

21962196
> 💡 **架构参数说明**:
21972197
> - 默认构建 `amd64` 架构镜像(适用于大多数 x86_64 服务器)
21982198
> - 如需构建 `arm64` 架构(Apple Silicon、树莓派等),设置环境变量:
21992199
> ```bash
22002200
> export DOCKER_ARCH=arm64
2201-
> docker-compose build
2201+
> docker compose build
22022202
> ```
22032203

22042204
#### 镜像更新
@@ -2207,12 +2207,12 @@ docker-compose up -d trend-radar-mcp
22072207
# 方式一:手动更新(爬虫 + MCP 镜像)
22082208
docker pull wantcat/trendradar:latest
22092209
docker pull wantcat/trendradar-mcp:latest
2210-
docker-compose down
2211-
docker-compose up -d
2210+
docker compose down
2211+
docker compose up -d
22122212
2213-
# 方式二:使用 docker-compose 更新
2214-
docker-compose pull
2215-
docker-compose up -d
2213+
# 方式二:使用 docker compose 更新
2214+
docker compose pull
2215+
docker compose up -d
22162216
```
22172217

22182218
**可用镜像**:
@@ -2349,14 +2349,14 @@ flowchart TB
23492349

23502350
**快速启动**:
23512351

2352-
使用 docker-compose 同时启动新闻推送和 MCP 服务:
2352+
使用 docker compose 同时启动新闻推送和 MCP 服务:
23532353

23542354
```bash
2355-
# 下载最新的 docker-compose.yml(已包含 MCP 服务配置)
2356-
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/docker/docker-compose.yml
2355+
# 下载最新的 docker compose.yml(已包含 MCP 服务配置)
2356+
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/docker/docker compose.yml
23572357
23582358
# 启动所有服务
2359-
docker-compose up -d
2359+
docker compose up -d
23602360
23612361
# 查看运行状态
23622362
docker ps | grep trend-radar

0 commit comments

Comments
 (0)