docs: 增加更详细的新手配置说明,请参照【快速开始】部分进行项目部署

This commit is contained in:
sansan
2025-11-18 11:22:55 +08:00
parent d22f169cdd
commit 1c043dda23
2 changed files with 122 additions and 54 deletions
+61 -27
View File
@@ -8,7 +8,7 @@
<a href="https://trendshift.io/repositories/14726" target="_blank"><img src="https://trendshift.io/api/badge/repositories/14726" alt="sansan0%2FTrendRadar | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
<a href="https://share.302.ai/mEOUzG" target="_blank"><img src="_image/302ai.png" alt="302.AI logo" height="40"/></a>
<a href="https://share.302.ai/mEOUzG" target="_blank"><img src="_image/302ai.png" alt="302.AI logo" height="60"/></a>
[![GitHub Stars](https://img.shields.io/github/stars/sansan0/TrendRadar?style=flat-square&logo=github&color=yellow)](https://github.com/sansan0/TrendRadar/stargazers)
[![GitHub Forks](https://img.shields.io/github/forks/sansan0/TrendRadar?style=flat-square&logo=github&color=blue)](https://github.com/sansan0/TrendRadar/network/members)
@@ -812,22 +812,33 @@ frequency_words.txt file added **required word** feature, using + sign
2. **Setup GitHub Secrets (Choose your needed platforms)**:
In your forked repo, go to `Settings` > `Secrets and variables` > `Actions` > `New repository secret`, then configure one or more notification platforms as needed:
In your forked repo, go to `Settings` > `Secrets and variables` > `Actions` > `New repository secret`
You can configure multiple platforms simultaneously, system will send notifications to all configured platforms.
**📌 Important Instructions (Please Read Carefully):**
Effect similar to the image below, one name corresponds to one secret. After saving, you won't see the secret value when re-editing, which is normal.
-**One Name for One Secret**: For each configuration item, click the "New repository secret" button once and fill in a pair of "Name" and "Secret"
-**Cannot See Value After Saving is Normal**: For security reasons, after saving, you can only see the Name when re-editing, but not the Secret value
- ⚠️ **DO NOT Create Custom Names**: The Secret Name must **strictly use** the names listed below (e.g., `WEWORK_WEBHOOK_URL`, `FEISHU_WEBHOOK_URL`, etc.). Do not modify or create new names arbitrarily, or the system will not recognize them
- 💡 **Can Configure Multiple Platforms**: The system will send notifications to all configured platforms
<img src="_image/secrets.png" alt="GitHub Secrets"/>
**Configuration Example:**
<img src="_image/secrets.png" alt="GitHub Secrets Configuration Example"/>
As shown above, each row is a configuration item:
- **Name**: Must use the fixed names listed in the expanded sections below (e.g., `WEWORK_WEBHOOK_URL`)
- **Secret (Value)**: Fill in the actual content obtained from the corresponding platform (e.g., Webhook URL, Token, etc.)
<br>
<details>
<summary> <strong>👉 Click to expand: WeWork Bot</strong> (Simplest and fastest configuration)</summary>
<br>
**GitHub Secret Configuration:**
- Name: `WEWORK_WEBHOOK_URL`
- Value: Your WeWork bot Webhook address
**GitHub Secret Configuration (⚠️ Name must match exactly):**
- **Name**: `WEWORK_WEBHOOK_URL` (Please copy and paste this name, do not type manually to avoid typos)
- **Secret (Value)**: Your WeWork bot Webhook address
<br>
@@ -846,9 +857,9 @@ frequency_words.txt file added **required word** feature, using + sign
<summary> <strong>👉 Click to expand: Feishu Bot</strong> (Most user-friendly message display)</summary>
<br>
**GitHub Secret Configuration:**
- Name: `FEISHU_WEBHOOK_URL`
- Value: Your Feishu bot Webhook address (link starts with https://www.feishu.cn/flow/api/trigger-webhook/********)
**GitHub Secret Configuration (⚠️ Name must match exactly):**
- **Name**: `FEISHU_WEBHOOK_URL` (Please copy and paste this name, do not type manually)
- **Secret (Value)**: Your Feishu bot Webhook address (link starts with https://www.feishu.cn/flow/api/trigger-webhook/********)
<br>
Two methods available, **Method 1** is simpler, **Method 2** is more complex (but stable push)
@@ -901,9 +912,9 @@ frequency_words.txt file added **required word** feature, using + sign
<summary> <strong>👉 Click to expand: DingTalk Bot</strong></summary>
<br>
**GitHub Secret Configuration:**
- Name: `DINGTALK_WEBHOOK_URL`
- Value: Your DingTalk bot Webhook address
**GitHub Secret Configuration (⚠️ Name must match exactly):**
- **Name**: `DINGTALK_WEBHOOK_URL` (Please copy and paste this name, do not type manually)
- **Secret (Value)**: Your DingTalk bot Webhook address
<br>
@@ -931,9 +942,14 @@ frequency_words.txt file added **required word** feature, using + sign
<summary> <strong>👉 Click to expand: Telegram Bot</strong></summary>
<br>
**GitHub Secret Configuration:**
- Name: `TELEGRAM_BOT_TOKEN` - Your Telegram Bot Token
- Name: `TELEGRAM_CHAT_ID` - Your Telegram Chat ID
**GitHub Secret Configuration (⚠️ Name must match exactly):**
- **Name**: `TELEGRAM_BOT_TOKEN` (Please copy and paste this name, do not type manually)
- **Secret (Value)**: Your Telegram Bot Token
- **Name**: `TELEGRAM_CHAT_ID` (Please copy and paste this name, do not type manually)
- **Secret (Value)**: Your Telegram Chat ID
**Note**: Telegram requires **two** Secrets, please click "New repository secret" button twice to add them separately
<br>
@@ -970,12 +986,23 @@ frequency_words.txt file added **required word** feature, using + sign
<br>
**GitHub Secret Configuration:**
- Name: `EMAIL_FROM` - Sender email address
- Name: `EMAIL_PASSWORD` - Email password or authorization code
- Name: `EMAIL_TO` - Recipient email address (multiple separated by comma) or can be same as EMAIL_FROM, send to yourself
- Name: `EMAIL_SMTP_SERVER` - SMTP server address (optional, auto-detect if empty)
- Name: `EMAIL_SMTP_PORT` - SMTP port (optional, auto-detect if empty)
**GitHub Secret Configuration (⚠️ Name must match exactly):**
- **Name**: `EMAIL_FROM` (Please copy and paste this name, do not type manually)
- **Secret (Value)**: Sender email address
- **Name**: `EMAIL_PASSWORD` (Please copy and paste this name, do not type manually)
- **Secret (Value)**: Email password or authorization code
- **Name**: `EMAIL_TO` (Please copy and paste this name, do not type manually)
- **Secret (Value)**: Recipient email address (multiple separated by comma, or can be same as EMAIL_FROM to send to yourself)
- **Name**: `EMAIL_SMTP_SERVER` (Optional, please copy and paste this name)
- **Secret (Value)**: SMTP server address (leave empty for auto-detection)
- **Name**: `EMAIL_SMTP_PORT` (Optional, please copy and paste this name)
- **Secret (Value)**: SMTP port (leave empty for auto-detection)
**Note**: Email push requires at least **3 required** Secrets (EMAIL_FROM, EMAIL_PASSWORD, EMAIL_TO), the last two are optional
<br>
@@ -1057,10 +1084,17 @@ frequency_words.txt file added **required word** feature, using + sign
❌ Bad example: news, alerts (too easy to guess)
```
3. **Configure GitHub Secret**:
- `NTFY_TOPIC`: Fill in your subscribed topic name
- `NTFY_SERVER_URL`: Leave empty (default uses ntfy.sh)
- `NTFY_TOKEN`: Leave empty
3. **Configure GitHub Secret (⚠️ Name must match exactly)**:
- **Name**: `NTFY_TOPIC` (Please copy and paste this name, do not type manually)
- **Secret (Value)**: Fill in your subscribed topic name
- **Name**: `NTFY_SERVER_URL` (Optional, please copy and paste this name)
- **Secret (Value)**: Leave empty (default uses ntfy.sh)
- **Name**: `NTFY_TOKEN` (Optional, please copy and paste this name)
- **Secret (Value)**: Leave empty
**Note**: ntfy requires at least 1 required Secret (NTFY_TOPIC), the last two are optional
4. **Test**:
```bash