<div align="center" id="trendradar">
<a href="https://github.com/sansan0/TrendRadar" title="TrendRadar">
<img src="/_image/banner.webp" alt="TrendRadar Banner" width="80%">
</a>
Deploy in <strong>30 seconds</strong> โ Say goodbye to endless scrolling, only see the news you truly care about
<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>
[](https://github.com/sansan0/TrendRadar/stargazers)
[](https://github.com/sansan0/TrendRadar/network/members)
[](LICENSE)
[](https://github.com/sansan0/TrendRadar)
[](https://github.com/sansan0/TrendRadar)
[](https://github.com/sansan0/TrendRadar)
[](https://github.com/sansan0/TrendRadar)
[](https://work.weixin.qq.com/)
[](https://weixin.qq.com/)
[](https://telegram.org/)
[](#)
[](https://www.feishu.cn/)
[](#)
[](https://github.com/binwiederhier/ntfy)
[](https://github.com/Finb/Bark)
[](https://slack.com/)
[](#)
[](https://github.com/sansan0/TrendRadar)
[](https://sansan0.github.io/TrendRadar)
[](https://hub.docker.com/r/wantcat/trendradar)
[](https://modelcontextprotocol.io/)
[](#)
</div>
<div align="center">
**[ไธญๆ](README.md)** | **English**
</div>
> This project is designed to be lightweight and easy to deploy
<br>
## ๐ Quick Navigation
> ๐ก **Click the links below** to jump to the corresponding section. Start with "**Quick Start**" for deployment, see "**Configuration Guide**" for detailed customization
<div align="center">
| | | |
|:---:|:---:|:---:|
| [๐ **Quick Start**](#-quick-start) | [AI Analysis](#-ai-analysis) | [โ๏ธ **Configuration Guide**](#configuration-guide) |
| [Docker Deployment](#6-docker-deployment) | [MCP Clients](#-mcp-clients) | [๐ **Changelog**](#-changelog) |
| [๐ฏ **Core Features**](#-core-features) | [โ **Support Project**](#-support-project) | [๐ **Related Projects**](#-related-projects) |
</div>
<br>
- Thanks to **stargazers**, your stars and forks are the best support for open source ๐
<details>
<summary>๐ Click to view <strong>Acknowledgments</strong> (Angel Round Honor Roll ๐ฅ73+๐ฅ supporters)</summary>
### Acknowledgments to Early Supporters
> ๐ก **Special Note**:
>
> 1. **About the List**: The table below records supporters from the early stage (Angel Round) of the project. Due to the manual nature of statistics in the early days, **there may be omissions or incomplete records. If anyone was missed, it was unintentional, and we ask for your kind understanding**.
> 2. **Future Plan**: To focus limited energy back on code development and feature iteration, **this list will no longer be manually maintained as of today**.
>
> Whether your name is on the list or not, your every bit of support is the cornerstone that allows TrendRadar to be where it is today. ๐
### Infrastructure Support
Thanks to **GitHub** for providing free infrastructure, which is the biggest prerequisite for this project to run conveniently with **one-click fork**.
### Data Support
This project uses the API from [newsnow](https://github.com/ourongxing/newsnow) to fetch multi-platform data. Special thanks to the author for providing this service.
After communication, the author indicated no concerns about server pressure, but this is based on their goodwill and trust. Please everyone:
- **Visit the [newsnow project](https://github.com/ourongxing/newsnow) and give it a star**
- When deploying with Docker, please control the frequency reasonably and avoid being overly greedy
### Promotion Support
> Thanks to the following platforms and individuals for recommendations (in chronological order)
- [Appinn (ๅฐไผ่ฝฏไปถ)](https://mp.weixin.qq.com/s/fvutkJ_NPUelSW9OGK39aA) - Open source software recommendation platform
- [LinuxDo Community](https://linux.do/) - Tech enthusiasts community
- [Ruan Yifeng's Weekly](https://github.com/ruanyf/weekly) - Influential tech weekly in Chinese tech circle
### Community Support
> Thanks to **financial supporters**. Your generosity has transformed into snacks and drinks beside my keyboard, accompanying every iteration of this project
>
> **Return of "One-Yuan Appreciation"**:
> With the release of v5.0.0, the project enters a new phase. To support growing API costs and caffeine consumption, the "One-Yuan Appreciation" channel is now reopened. Every bit of your kindness translates into Tokens and motivation in the code world. ๐ [Support Now](#-support-project)
| Supporter | Amount (CNY) | Date | Note |
| :-------: | :----------: | :--: | :--: |
| D*5 | 1.8 * 3 | 2025.11.24 | |
| *้ฌผ | 1 | 2025.11.17 | |
| *่ถ
| 10 | 2025.11.17 | |
| R*w | 10 | 2025.11.17 | Great agent work! |
| J*o | 1 | 2025.11.17 | Thanks for open source |
| *ๆจ | 8.88 | 2025.11.16 | Nice project |
| *ๆตท | 1 | 2025.11.15 | |
| *ๅพท | 1.99 | 2025.11.15 | |
| *็ | 8.8 | 2025.11.14 | Great project |
| M*e | 10 | 2025.11.14 | Open source is not easy |
| **ๆฏ | 1 | 2025.11.14 | |
| *ไบ | 88 | 2025.11.13 | Good project |
| *W | 6 | 2025.11.13 | |
| *ๅฏ | 1 | 2025.11.13 | |
| ๅฏน*. | 1 | 2025.11.13 | Thanks for TrendRadar |
| s*y | 1 | 2025.11.13 | |
| **็ฟ | 10 | 2025.11.13 | Wish I found it earlier |
| *้ฆ | 9.9 | 2025.11.13 | TrendRadar is awesome |
| h*p | 5 | 2025.11.12 | Support Chinese open source |
| c*r | 6 | 2025.11.12 | |
| a*n | 5 | 2025.11.12 | |
| ใ*c | 1 | 2025.11.12 | Thanks for sharing |
| ... | ... | ... | **(More 50+ supporters)** |
</details>
<br>
## ๐ช Sponsors
<div align="center">
> **Sponsorship Open**
>
> Seeking quality product partners.
> More than features, I value **your attitude towards users**.
> Please share your user community or feedback channelsโI want to see how you support your users.
> [๐ฉ Contact Me](mailto:path@linux.do)
</div>
<br>
<a name="-support-project"></a>
## โจ Find it useful? Support TrendRadar
TrendRadar is a completely free and open-source project. Your support fuels the motivation for continuous updates.
### โค๏ธ Donate
A bottle of water or a snack represents your love.
Any amount is welcome; even 1 RMB is a gesture of kindness.
> Your sponsorship will be used to replenish caffeine for carbon-based lifeforms โ๏ธ and API Tokens for silicon-based lifeforms ๐ค.
<div align="center">
| WeChat Pay | Alipay |
| --- | --- |
| <img src="https://cdn-1258574687.cos.ap-shanghai.myqcloud.com/img/%2F2025%2F07%2F17%2F2ae0a88d98079f7e876c2b4dc85233c6-9e8025.JPG" width="240" alt="WeChat Pay"> | <img src="https://cdn-1258574687.cos.ap-shanghai.myqcloud.com/img/%2F2025%2F07%2F17%2F1ed4f20ab8e35be51f8e84c94e6e239b4-fe4947.JPG" width="240" alt="Alipay"> |
</div>
### ๐ Other Ways to Support
1. **Star the Repo** โญ๏ธ: It only takes **1 second**. Letting more people see this project is the greatest recognition for me.
2. **Charity** ๐ป: Search for **Tencent Charity** (or support a local charity) to help students in need. Pass this kindness forward.
### ๐ค Attribution & Secondary Development
If you utilize the core code or draw inspiration from the logic of this project, **it would be greatly appreciated** if you could acknowledge the source in your README or documentation and include a link to this repository.
> [https://github.com/sansan0/TrendRadar](https://github.com/sansan0/TrendRadar)
This contributes to the sustainable maintenance of the project and the growth of the community. Thank you for your respect and support! โค๏ธ
**Reference Example** (e.g., my other project):
> [https://github.com/sansan0/bilibili-comment-analyzer](https://github.com/sansan0/bilibili-comment-analyzer)
---
### ๐ฌ Feedback & Community
* **GitHub Issues**: Best for specific technical issues. Please provide complete information (screenshots, error logs, etc.) to help locate the problem quickly.
* **WeChat Official Account**: It is recommended to leave comments under relevant articles. If you need to ask questions in the background, **liking/recommending** the article first is the best "icebreaker," and I can feel your appreciation (ยดโฝ`สโกฦช).
> **Friendly Reminder**:
> This project is for open-source sharing, not a commercial product. A lot of effort went into the documentation; most deployment issues can be answered in **[๐ Quick Start](#-quick-start)**.
> *Please be patient and polite when asking questions. Treat the author as a friend, not customer service, for better communication efficiency!*
<div align="center">
| Follow on WeChat |
| --- |
| <img src="_image/weixin.png" width="500" title="Silicon-based Tea Room"/> |
</div>
<br>
## ๐ Changelog
>**๐ Check Latest Updates**: **[Original Repository Changelog](https://github.com/sansan0/TrendRadar?tab=readme-ov-file#-changelog)**:
- **Tip**: Check [Changelog] to understand specific [Features]
### 2026/01/23 - v5.4.0
- Added independent control for AI analysis mode, options: follow_report | daily | current | incremental
- Added time window control for AI analysis, supporting custom execution periods and daily frequency limits
- Added configuration file version management function
- Fixed several bugs
### 2026/01/19 - v5.3.0
> **Major Refactor: AI Module Migration to LiteLLM**
- **Unified AI Interface**: Replaced manual implementation with LiteLLM, supporting 100+ AI providers
- **Simplified Configuration**: Removed `provider` field, now using `model: "provider/model_name"` format
- **New Features**: Auto-retry (`num_retries`), fallback models (`fallback_models`)
- **Configuration Changes**:
- `ai.provider` โ Removed (merged into model)
- `ai.base_url` โ `ai.api_base`
- `AI_PROVIDER` environment variable โ Removed
- `AI_BASE_URL` environment variable โ `AI_API_BASE`
- **Model Format Examples**:
- DeepSeek: `deepseek/deepseek-chat`
- OpenAI: `openai/gpt-4o`
- Gemini: `gemini/gemini-2.5-flash`
- Anthropic: `anthropic/claude-3-5-sonnet`
### 2026/01/17 - v5.2.0
> See config.yaml for details
**๐ AI Translation**
- **Multi-language Translation**: Translate push content to any language
- **Batch Translation**: Smart batch processing to reduce API calls
- **Custom Prompts**: Customize translation style
**๐ง Configuration Optimization**
- **Standalone AI Model Config**: Analysis and translation share model config
- **Unified Region Switches**: Unified management of push region display
- **Custom Region Order**: Customize display order of each region
**โจ AI Analysis Enhancement**
- **AI Analysis Embedded in HTML**: Analysis results directly embedded in HTML reports, used by email notifications
- **Rich Style AI Section**: Gradient blue card layout, clearly separating analysis dimensions
- **Ranking Timeline Support**: AI can access precise ranking at each crawl time point
- **Section Reorganization (7โ4)**: Consolidated into Core Trends, Sentiment & Controversy, Signals & Anomalies, Outlook & Strategy
**๐ง Multi-Model Adaptation**
- **Universal Parameter Passthrough**: Pass any advanced parameters to API
- **Gemini Adaptation**: Native parameter support with relaxed safety settings
**๐ Bug Fixes**
- Fixed various known issues, improved system stability
### 2026/01/10 - mcp-v3.0.0~v3.1.5
- **Breaking Change**: All tool return values unified to `{success, summary, data, error}` structure
- **Async Consistency**: All 21 tool functions wrapped with `asyncio.to_thread()` for sync calls
- **MCP Resources**: Added 4 resources (platforms, rss-feeds, available-dates, keywords)
- **RSS Enhancement**: `get_latest_rss` supports multi-day queries (days param), cross-date URL deduplication
- **Regex Matching Fix**: `get_trending_topics` supports `/pattern/` regex syntax and `display_name`
- **Cache Optimization**: Added `make_cache_key()` function with param sorting + MD5 hash for consistency
- **New check_version Tool**: Check TrendRadar and MCP Server version updates simultaneously
<details>
<summary>๐ Click to expand: <strong>Historical Updates</strong></summary>
### 2026/01/10 - v5.0.0
> **Dev Anecdote**:
> A salute to a certain 'C' model provider that accompanied me for over two years, only to slap me with `"This organization has been disabled"` right after I renewed my subscription.
**โจ "Five Major Sections" Content Refactoring**
This update refactors the push message structure into five distinct core sections:
1. **๐ Trending News**: Aggregated trending topics from across the web, precisely filtered by your keywords.
2. **๐ฐ RSS Feeds**: Your personalized subscription content, supporting keyword-based grouping.
3. **๐ New Items**: Real-time capture of brand new trending topics since the last run (marked with ๐).
4. **๐ Independent Display**: Complete trending lists or RSS feeds from specified platforms, **completely unaffected by keyword filtering**.
5. **โจ AI Analysis**: Deep insights driven by AI, including trend overview, popularity trends, and **critically important** sentiment analysis.
**โจ AI Smart Analysis Push Feature**
- **AI Analysis Integration**: Use AI models to deeply analyze push content, automatically generate trending insights, keyword analysis, cross-platform correlation, potential impact assessment
- **Sentiment Analysis**: New deep sentiment recognition to accurately capture positive, negative, controversial, or concerned public opinions (v5.0.0 key enhancement)
- **Multi AI Provider Support**: Supports DeepSeek (default, cost-effective), OpenAI, Google Gemini, and any OpenAI-compatible API
- **Two Push Modes**: `only_analysis` (AI analysis only), `both` (push both)
- **Custom Prompts**: Customize AI analysis role and output format via `config/ai_analysis_prompt.txt`
- **Multi-dimensional Analysis**: AI can analyze ranking changes, trending duration, cross-platform performance, trend prediction
### 2026/01/02 - v4.7.0
- **Fix RSS HTML Display**: Fixed RSS data format mismatch causing rendering issues, now displays correctly grouped by keyword
- **New Regex Syntax**: Keyword config supports `/pattern/` regex syntax, solves English substring mismatch issues (e.g., `ai` matching `training`) [๐ View Syntax Details](#keyword-basic-syntax)
- **New Display Name Syntax**: Use `=> alias` to give complex regex a friendly name, cleaner push notifications (e.g., `/\bai\b/ => AI Related`)
- **Can't Write Regex?** README now includes AI prompt guide - just tell ChatGPT/Gemini/DeepSeek what you want to match
### 2025/12/30 - mcp-v2.0.0
- **Architecture Refactoring**: Removed TXT support, unified to SQLite database
- **RSS Query**: Added `get_latest_rss`, `search_rss`, `get_rss_feeds_status`
- **Unified Search**: `search_news` supports `include_rss` parameter to search both trending and RSS
### 2026/01/01 - v4.6.0
- **Fix RSS HTML Display**: Merged RSS content into trending HTML page, grouped by source
- **New display_mode Config**: Support `keyword` (group by keyword) and `platform` (group by platform) display modes
### 2025/12/30 - v4.5.0
- **RSS Feed Support**: Added RSS/Atom feed crawling, keyword-based grouping and statistics (consistent with trending format)
- **Storage Structure Refactoring**: Flattened directory structure `output/{type}/{date}.db`
- **Unified Sorting Config**: `sort_by_position_first` affects both trending and RSS
- **Config Structure Refactoring**: `config.yaml` reorganized into 7 logical groups (app, report, notification, storage, platforms, rss, advanced) with clearer config paths
### 2025/12/26 - mcp-v1.2.0
**MCP Module Update - Optimized toolset, added aggregation & comparison features, merged redundant tools:**
- Added `aggregate_news` tool - Cross-platform news deduplication and aggregation
- Added `compare_periods` tool - Period comparison analysis (week-over-week/month-over-month)
- Merged `find_similar_news` + `search_related_news_history` โ `find_related_news`
- Enhanced `get_trending_topics` - Added `auto_extract` mode for automatic trending extraction
- Fixed miscellaneous bugs
- Updated README-MCP-FAQ.md documentation in both Chinese and English (Q1-Q18)
### 2025/12/20 - v4.0.3
- Added URL normalization to fix duplicate push issues caused by dynamic parameters (e.g., Weibo's `band_rank`)
- Fixed incremental mode detection logic to correctly identify historical titles
### 2025/12/13 - mcp-v1.1.0
**MCP Module Update:**
- Adapted for v4.0.0, while maintaining compatibility with v3.x data.
- Added storage sync tools:
- `sync_from_remote`: Pull data from remote storage to local
- `get_storage_status`: Get storage configuration and status
- `list_available_dates`: List available dates in local/remote storage
### 2025/12/17 - v4.0.1
- StorageManager adds push record proxy methods
- S3 client switches to virtual-hosted style for better compatibility (supports Tencent Cloud COS and more services)
### 2025/12/13 - v4.0.0
**๐ Major Update: Comprehensive Refactoring of Storage and Core Architecture**
- **Multi-Storage Backend Support**: Introduced a brand new storage module supporting local SQLite and remote cloud storage (S3-compatible protocols, e.g., Cloudflare R2), adaptable to GitHub Actions, Docker, and local environments.
- **Database Structure Optimization**: Refactored SQLite database table structures to improve data efficiency and query performance.
- **Enhanced Features**: Implemented date format standardization, data retention policies, timezone configuration support, and optimized time display. Fixed remote storage data persistence issues to ensure accurate data merging.
- **Cleanup and Compatibility**: Removed most legacy compatibility code and unified data storage and retrieval methods.
### 2025/12/03 - v3.5.0
**๐ Core Feature Enhancements**
1. **Multi-Account Push Support**
- All push channels (Feishu, DingTalk, WeWork, Telegram, ntfy, Bark, Slack) support multiple account configuration
- Use semicolon `;` to separate multiple accounts, e.g., `FEISHU_WEBHOOK_URL=url1;url2`
- Automatic validation for paired configurations (e.g., Telegram's token and chat_id)
2. **Configurable Push Content Order**
- Added `reverse_content_order` configuration option
- Customize display order of trending keywords stats and new trending news
3. **Global Filter Keywords**
- Added `[GLOBAL_FILTER]` region marker for filtering unwanted content globally
- Use cases: Filter ads, marketing, low-quality content, etc.
**๐ณ Docker Dual-Path HTML Generation Optimization**
- **Bug Fix**: Resolved issue where `index.html` could not sync to host in Docker environment
- **Dual-Path Generation**: Daily summary HTML is generated to two locations simultaneously
- `index.html` (project root): For GitHub Pages access
- `output/index.html`: Accessible on host via Docker Volume mount
- **Compatibility**: Ensures web reports are accessible in Docker, GitHub Actions, and local environments
**๐ณ Docker MCP Image Support**
- Added independent MCP service image `wantcat/trendradar-mcp`
- Supports Docker deployment of AI analysis features via HTTP interface (port 3333)
- Dual-container architecture: News push service and MCP service run independently, can be scaled and restarted separately
- See [Docker Deployment - MCP Service](#6-docker-deployment) for details
**๐ Web Server Support**
- Added built-in web server for browser access to generated reports
- Control via `manage.py` commands: `docker exec -it trendradar python manage.py start_webserver`
- Access URL: `http://localhost:8080` (port configurable)
- Security features: Static file service, directory restriction, localhost binding
- Supports both auto-start and manual control modes
**๐ Documentation Optimization**
- Added [Report Configuration](#7-report-configuration) section: report-related parameter details
- Added [Push Window Configuration](#8-push-window-configuration) section: push_window configuration tutorial
- Added [Execution Frequency Configuration](#9-execution-frequency-configuration) section: Cron expression explanation and common examples
- Added [Multi-Account Push Configuration](#10-multiple-account-push-configuration) section: multi-account push configuration details
- Optimized all configuration sections: Unified "Configuration Location" instructions
- Simplified Quick Start configuration: Three core files at a glance
- Optimized [Docker Deployment](#6-docker-deployment) section: Added image description, recommended git clone deployment, reorganized deployment methods
**๐ง Upgrade Instructions**:
- **GitHub Fork Users**: Update `main.py`, `config/config.yaml` (Added multi-account push support, existing single-account configuration unaffected)
- **Docker Users**: Update `.env`, `docker-compose.yml` or set environment variables `REVERSE_CONTENT_ORDER`, `MAX_ACCOUNTS_PER_CHANNEL`
- **Multi-Account Push**: New feature, disabled by default, existing single-account configuration unaffected
### 2025/11/28 - v3.4.1
**๐ง Format Optimization**
1. **Bark Push Enhancement**
- Bark now supports Markdown rendering
- Enabled native Markdown format: bold, links, lists, code blocks, etc.
- Removed plain text conversion to fully utilize Bark's native rendering capabilities
2. **Slack Format Precision**
- Use dedicated mrkdwn format for batch content processing
- Improved byte size estimation accuracy (avoid message overflow)
- Optimized link format: `<url|text>` and bold syntax: `*text*`
3. **Performance Improvement**
- Format conversion completed during batching process, avoiding secondary processing
- Accurate message size estimation reduces send failure rate
**๐ง Upgrade Instructions**:
- **GitHub Fork Users**: Update `main.py`๏ผ`config.yaml`
### 2025/11/26 - mcp-v1.0.3
**MCP Module Update:**
- Added date parsing tool resolve_date_range to resolve AI model date calculation inconsistencies
- Support natural language date expression parsing (this week, last 7 days, last month, etc.)
- Tool count increased from 13 to 14
### 2025/11/25 - v3.4.0
**๐ Added Slack Push Support**
1. **Team Collaboration Push Channel**
- Supports Slack Incoming Webhooks (globally popular team collaboration tool)
- Centralized message management, suitable for team-shared trending news
- Supports mrkdwn format (bold, links, etc.)
2. **Multiple Deployment Methods**
- GitHub Actions: Configure `SLACK_WEBHOOK_URL` Secret
- Docker: Environment variable `SLACK_WEBHOOK_URL`
- Local: `config/config.yaml` configuration file
> ๐ **Detailed Configuration Tutorial**: [Quick Start - Slack Push](#-quick-start)
- Optimized the one-click installation experience for setup-windows.bat and setup-windows-en.bat
**๐ง Upgrade Instructions**:
- **GitHub Fork Users**: Update `main.py`, `config/config.yaml`, `.github/workflows/crawler.yml`
### 2025/11/24 - v3.3.0
**๐ Added Bark Push Support**
1. **iOS Exclusive Push Channel**
- Supports Bark push (based on APNs, iOS platform)
- Free, open-source, clean, efficient, ad-free
- Supports both official server and self-hosted server
2. **Multiple Deployment Methods**
- GitHub Actions: Configure `BARK_URL` Secret
- Docker: Environment variable `BARK_URL`
- Local: `config/config.yaml` configuration file
> ๐ **Detailed Configuration Tutorial**: [Quick Start - Bark Push](#-quick-start)
**๐ Bug Fix**
- Fixed issue where `ntfy_server_url` in `config.yaml` was ignored ([#345](https://github.com/sansan0/TrendRadar/issues/345))
**๐ง Upgrade Instructions**:
- **GitHub Fork Users**: Update `main.py`, `config/config.yaml`, `.github/workflows/crawler.yml`
### 2025/11/23 - v3.2.0
**๐ฏ New Advanced Customization Features**
1. **Keyword Sorting Priority Configuration**
- Two sorting strategies: Popularity first vs Config order first
- For different use cases: Hot topic tracking or personalized focus
2. **Display Count Precise Control**
- Global config: Unified limit for all keywords
- Individual config: Use `@number` syntax to set specific limits
- Effectively control push length, highlight key content
> ๐ **Detailed Tutorial**: [Keyword Configuration - Advanced Settings](#keyword-advanced-settings)
**๐ง Upgrade Instructions**:
- **GitHub Fork Users**: Update `main.py`, `config/config.yaml`
### 2025/11/22 - v3.1.1
- **Fixed data anomaly crash issue**: Resolved `'float' object has no attribute 'lower'` error encountered by some users in GitHub Actions environment
- Added dual protection mechanism: Filter invalid titles (None, float, empty strings) at data acquisition stage, with type checking at function call sites
- Enhanced system stability to ensure normal operation even when data sources return abnormal formats
**Upgrade Instructions** (GitHub Fork Users):
- Required update: `main.py`
- Recommended: Use minor version upgrade method - copy and replace the file above
### 2025/11/18 - mcp-v1.0.2
**MCP Module Update:**
- Fix issue where today's news query may return articles from past dates
### 2025/11/20 - v3.1.0
- **Added Personal WeChat Push Support**: WeWork application can push to personal WeChat without installing WeWork APP
- Supports two message formats: `markdown` (WeWork group bot) and `text` (personal WeChat app)
- Added `WEWORK_MSG_TYPE` environment variable configuration, supporting GitHub Actions, Docker, docker compose and other deployment methods
- `text` mode automatically strips Markdown syntax for clean plain text push
- See "Personal WeChat Push" configuration in Quick Start
**Upgrade Instructions** (GitHub Fork Users):
- Required updates: `main.py`, `config/config.yaml`
- Optional update: `.github/workflows/crawler.yml` (if using GitHub Actions)
- Recommended: Use minor version upgrade method - copy and replace the files above
### 2025/11/12 - v3.0.5
- Fixed email sending SSL/TLS port configuration logic error
- Optimized email service providers (QQ/163/126) to default use port 465 (SSL)
- **Added Docker environment variable support**: Core config items (`enable_crawler`, `report_mode`, `push_window`, etc.) support override via environment variables, solving config file modification issues for NAS users (see [๐ณ Docker Deployment](#-docker-deployment) chapter)
### 2025/10/26 - mcp-v1.0.1
**MCP Module Update:**
- Fixed date query parameter passing error
- Unified time parameter format for all tools
### 2025/10/31 - v3.0.4
- Solved Feishu error due to overly long push content, implemented batch pushing
### 2025/10/23 - v3.0.3
- Expanded ntfy error message display range
### 2025/10/21 - v3.0.2
- Fixed ntfy push encoding issue
### 2025/10/20 - v3.0.0
**Major Update - AI Analysis Feature Launched** โจ
- **Core Features**:
- New MCP (Model Context Protocol) based AI analysis server
- 13 smart analysis tools: basic query, smart search, advanced analysis, system management
- Natural language interaction: Query and analyze news data through conversation
- Multi-client support: Claude Desktop, Cherry Studio, Cursor, Cline, etc.
- **Analysis Capabilities**:
- Topic trend analysis (popularity tracking, lifecycle, viral detection, trend prediction)
- Data insights (platform comparison, activity stats, keyword co-occurrence)
- Sentiment analysis, similar news finding, smart summary generation
- Historical related news search, multi-mode search
- **Update Note**:
- This is an independent AI analysis feature, does not affect existing push functionality
- Optional use, no need to upgrade existing deployment
### 2025/10/15 - v2.4.4
- **Updates**:
- Fixed ntfy push encoding issue + 1
- Fixed push time window judgment issue
- **Upgrade Note**:
- Recommended minor version upgrade
### 2025/10/10 - v2.4.3
> Thanks to [nidaye996](https://github.com/sansan0/TrendRadar/issues/98) for discovering the UX issue
- **Updates**:
- Refactored "Silent Push Mode" naming to "Push Time Window Control", improving feature comprehension
- Clarified push time window as optional additional feature, can work with three push modes
- Improved comments and documentation, making feature positioning clearer
- **Upgrade Note**:
- This is just refactoring, upgrade optional
### 2025/10/8 - v2.4.2
- **Updates**:
- Fixed ntfy push encoding issue
- Fixed missing config file issue
- Optimized ntfy push effect
- Added GitHub Pages image segmented export feature
- **Upgrade Note**:
- Recommend major version update
### 2025/10/2 - v2.4.0
**Added ntfy Push Notification**
- **Core Features**:
- Supports ntfy.sh public service and self-hosted servers
- **Use Cases**:
- Suitable for privacy-conscious users (supports self-hosting)
- Cross-platform push (iOS, Android, Desktop, Web)
- No account registration needed (public servers)
- Open-source and free (MIT License)
- **Upgrade Note**:
- Recommend major version update
### 2025/09/26 - v2.3.2
- Fixed email notification config check being missed ([#88](https://github.com/sansan0/TrendRadar/issues/88))
**Fix Description**:
- Solved the issue where system still prompted "No webhook configured" even with correct email notification setup
### 2025/09/22 - v2.3.1
- **Added email push feature**, supports sending trending news reports to email
- **Smart SMTP Recognition**: Auto-detects Gmail, QQ Mail, Outlook, NetEase Mail and 10+ email service providers
- **Beautiful HTML Format**: Email content uses same HTML format as web version, well-formatted, mobile-adapted
- **Batch Sending Support**: Supports multiple recipients, separated by commas
- **Custom SMTP**: Can customize SMTP server and port
- Fixed Docker build network connection issue
**Usage Notes**:
- Use cases: Suitable for users needing email archiving, team sharing, scheduled reports
- Supported emails: Gmail, QQ Mail, Outlook/Hotmail, 163/126 Mail, Sina Mail, Sohu Mail, etc.
**Upgrade Note**:
- This update has many changes, if upgrading, recommend major version upgrade
### 2025/09/17 - v2.2.0
- Added one-click save news as image feature, easily share trending topics you care about
**Usage Notes**:
- Use case: After enabling web version feature (GitHub Pages)
- How to use: Open webpage on phone or PC, click "Save as Image" button at top
- Actual effect: System auto-creates beautiful image of current news report, saves to phone album or desktop
- Sharing convenience: Directly send this image to friends, Moments, or work groups, letting others see your discovered important info
### 2025/09/13 - v2.1.2
- Solved DingTalk push capacity limit causing news push failure (using batch push)
### 2025/09/04 - v2.1.1
- Fixed Docker unable to run properly on certain architectures
- Officially released official Docker image wantcat/trendradar, supports multi-architecture
- Optimized Docker deployment process, can use quickly without local build
### 2025/08/30 - v2.1.0
**Core Improvements**:
- **Push Logic Optimization**: Changed from "push every execution" to "controllable push within time window"
- **Time Window Control**: Can set push time range, avoid non-work hour disturbance
- **Push Frequency Options**: Supports single push or multiple pushes within time window
**Upgrade Note**:
- This feature is disabled by default, need to manually enable push time window control in config.yaml
- Upgrade requires updating both main.py and config.yaml files
### 2025/08/27 - v2.0.4
- This version is not a bug fix, but an important reminder
- Please keep webhooks properly, do not make public, do not make public, do not make public
- If you deployed this project on GitHub via fork, please put webhooks in GitHub Secret, not config.yaml
- If you already exposed webhooks or put them in config.yaml, suggest deleting and regenerating
### 2025/08/06 - v2.0.3
- Optimized GitHub Pages web version effect, convenient for mobile use
### 2025/07/28 - v2.0.2
- Refactored code
- Solved version number easily being missed for modification
### 2025/07/27 - v2.0.1
**Fixed Issues**:
1. Docker shell script line ending as CRLF causing execution exception issue
2. frequency_words.txt being empty causing news sending also empty logic issue
- After fix, when you choose frequency_words.txt empty, will **push all news**, but limited by message push size, please adjust as follows
- Option 1: Turn off mobile push, only choose GitHub Pages deployment (this is the way to get most complete info, will re-sort all platform trending by your **custom trending algorithm**)
- Option 2: Reduce push platforms, prioritize **WeWork** or **Telegram**, these two pushes I made batch push feature (because batch push affects push experience, and only these two platforms give very little push capacity, so had to make batch push feature, but at least can ensure complete info)
- Option 3: Can combine with Option 2, mode choose current or incremental can effectively reduce one-time push content
### 2025/07/17 - v2.0.0
**Major Refactoring**:
- Config management refactoring: All configs now managed through `config/config.yaml` file (main.py I still didn't split, convenient for you to copy and upgrade)
- Run mode upgrade: Supports three modes - `daily` (daily summary), `current` (current rankings), `incremental` (incremental monitoring)
- Docker support: Complete Docker deployment solution, supports containerized operation
**Config File Description**:
- `config/config.yaml` - Main config file (application settings, crawler config, notification config, platform config, etc.)
- `config/frequency_words.txt` - Keyword config (monitoring vocabulary settings)
### 2025/07/09 - v1.4.1
**New Feature**: Added incremental push (configure FOCUS_NEW_ONLY at top of main.py), this switch only cares about new topics not sustained heat, only sends notification when new content appears.
**Fixed Issue**: Under certain circumstances, some news containing special symbols caused occasional formatting exceptions.
### 2025/06/23 - v1.3.0
WeWork and Telegram push messages have length limits, I adopted splitting messages for pushing. Development docs see [WeWork](https://developer.work.weixin.qq.com/document/path/91770) and [Telegram](https://core.telegram.org/bots/api)
### 2025/06/21 - v1.2.1
Before this version, not only main.py needs copy replacement, crawler.yml also needs you to copy replacement
https://github.com/sansan0/TrendRadar/blob/master/.github/workflows/crawler.yml
### 2025/06/19 - v1.2.0
> Thanks to Claude Research for organizing various platform APIs, helping me quickly complete platform adaptation (although code is more redundant~
1. Supports Telegram, WeWork, DingTalk push channels, supports multi-channel config and simultaneous push
### 2025/06/18 - v1.1.0
> **200 starsโญ** reached, continue celebrating with everyone~
1. Important update, added weight, news you see now is hottest most concerned appearing at top
2. Updated documentation usage, because recently updated many features, and previous usage docs I was lazy wrote simple (see โ๏ธ frequency_words.txt complete configuration tutorial below)
### 2025/06/16 - v1.0.0
1. Added project new version update reminder, default on, if want to turn off, can change "FEISHU_SHOW_VERSION_UPDATE": True to False in main.py
### 2025/06/13+14
1. Removed compatibility code, students who forked before, directly copying code will show exception on same day (will recover normal next day)
2. Feishu and html bottom added new news display
### 2025/06/09
**100 starsโญ** reached, writing small feature to celebrate
frequency_words.txt file added **required word** feature, using + sign
1. Required word syntax as follows:
Tang Monk or Pig must both appear in title, will be included in push news
```
+Tang Monk
+Pig
```
2. Filter word priority higher:
If title filter word matches Tang Monk reciting sutras, then even if required word has Tang Monk, also not display
```
+Tang Monk
!Tang Monk reciting sutras
```
### 2025/06/02
1. **Webpage** and **Feishu messages** support phone directly jumping to detailed news
2. Optimized display effect + 1
### 2025/05/26
1. Feishu message display effect optimized
</details>
<br>
## โจ Core Features
### **Multi-Platform Trending News Aggregation**
- Zhihu (็ฅไน)
- Douyin (ๆ้ณ)
- Bilibili Hot Search
- Wallstreetcn (ๅๅฐ่ก่ง้ป)
- Tieba (่ดดๅง)
- Baidu Hot Search
- Yicai (่ดข่็คพ)
- Thepaper (ๆพๆนๆฐ้ป)
- Ifeng (ๅคๅฐ็ฝ)
- Toutiao (ไปๆฅๅคดๆก)
- Weibo (ๅพฎๅ)
Default monitoring of 11 mainstream platforms, with support for adding custom platforms.
> ๐ก For detailed configuration, see [Configuration Guide - Platform Configuration](#1-platform-configuration)
### **RSS Feed Support** (v4.5.0 New)
Supports RSS/Atom feed crawling, keyword-based grouping and statistics (consistent with trending format):
- **Unified Format**: RSS and trending use the same keyword matching and display format
- **Simple Config**: Add RSS sources directly in `config.yaml`
- **Merged Push**: Trending and RSS are merged into a single notification
> ๐ก RSS uses the same `frequency_words.txt` for keyword filtering as trending
### **Smart Push Strategies**
**Three Push Modes**:
| Mode | Target Users | Push Feature |
|------|--------------|--------------|
| **Daily Summary** (daily) | Managers/Regular Users | Push all matched news of the day (includes previously pushed) |
| **Current Rankings** (current) | Content Creators | Push current ranking matches (continuously ranked news appear each time) |
| **Incremental Monitor** (incremental) | Traders/Investors | Push only new content, zero duplication |
> ๐ก **Quick Selection Guide:**
> - Don't want duplicate news โ Use `incremental`
> - Want complete ranking trends โ Use `current`
> - Need daily summary reports โ Use `daily`
>
> For detailed comparison and configuration, see [Configuration Guide - Push Mode Details](#3-push-mode-details)
**Additional Features** (Optional):
| Feature | Description | Default |
|---------|-------------|---------|
| **Push Time Window Control** | Set push time range (e.g., 09:00-18:00) to avoid non-work hours notifications | Disabled |
| **Content Order Configuration** | Adjust display order of "Trending Keywords Stats" and "New Trending News" (v3.5.0 new) | Stats first |
| **Display Mode Switch** | `keyword`=group by keyword, `platform`=group by platform (v4.6.0 new) | keyword |
> ๐ก For detailed configuration, see [Configuration Guide - Report Configuration](#7-report-configuration) and [Configuration Guide - Push Window](#8-push-window-configuration)
### **Precise Content Filtering**
Set personal keywords (e.g., AI, BYD, Education Policy) to receive only relevant trending news, filtering out noise.
> ๐ก **Basic Configuration**: [Keyword Configuration - Basic Syntax](#keyword-basic-syntax)
>
> ๐ก **Advanced Configuration**: [Keyword Configuration - Advanced Settings](#keyword-advanced-settings)
>
> ๐ก You can also skip filtering and receive all trending news (leave frequency_words.txt empty)
### **Trending Analysis**
Real-time tracking of news popularity changes helps you understand not just "what's trending" but "how trends evolve."
- **Timeline Tracking**: Records complete time span from first to last appearance
- **Popularity Changes**: Tracks ranking changes and appearance frequency across time periods
- **New Detection**: Real-time identification of emerging topics, marked with ๐
- **Continuity Analysis**: Distinguishes between one-time hot topics and continuously developing news
- **Cross-Platform Comparison**: Same news across different platforms, showing media attention differences
> ๐ก Push format reference: [Configuration Guide - Push Format Reference](#5-push-format-reference)
### **Personalized Trending Algorithm**
No longer controlled by platform algorithms, TrendRadar reorganizes all trending searches
> ๐ก Weight adjustment guide: [Configuration Guide - Advanced Configuration](#4-advanced-configuration---hotspot-weight-adjustment)
### **Multi-Channel Multi-Account Push**
Supports **WeWork** (+ WeChat push solution), **Feishu**, **DingTalk**, **Telegram**, **Email**, **ntfy**, **Bark**, **Slack** โ messages delivered directly to phone and email.
> ๐ก For detailed configuration, see [Configuration Guide - Multi-Account Push Configuration](#10-multiple-account-push-configuration)
### **AI Multi-Language Translation** (v5.2.0 New)
Translate push content into any language, breaking language barriers โ whether reading domestic trends or subscribing to international news via RSS, access everything in your native language
- **One-Click Translation**: Set `ai_translation.enabled: true` and target language in `config.yaml`
- **Multi-Language Support**: Supports English, Korean, Japanese, French, and any other language
- **Smart Batch Processing**: Automatically batches translations to reduce API calls and save costs
- **Custom Style**: Customize translation style and terminology via `ai_translation_prompt.txt`
- **Shared Model Config**: Shares the `ai` config section with AI analysis feature
```yaml
# config.yaml quick enable example
ai_translation:
enabled: true
language: "English" # Target translation language
```
> ๐ก Translation shares model config with AI analysis โ just configure `ai.api_key` once to use both features
**RSS Source References**: Here are some RSS feed collections for your reference
- [awesome-tech-rss](https://github.com/tuan3w/awesome-tech-rss) - Tech, startup, and programming blogs & media
- [awesome-rss-feeds](https://github.com/plenaryapp/awesome-rss-feeds) - Mainstream news media RSS from countries worldwide
> โ ๏ธ Some international media content may involve sensitive topics that AI models might refuse to translate. Please filter subscription sources based on your actual needs
### **Flexible Storage Architecture (v4.0.0 Major Update)**
**Multi-Backend Support**:
- **Remote Cloud Storage**: GitHub Actions environment default, supports S3-compatible protocols (R2/OSS/COS, etc.), data stored in cloud, keeping repository clean
- **Local SQLite**: Traditional SQLite database, stable and efficient (Docker/local deployment)
- **Auto Selection**: Auto-selects appropriate backend based on runtime environment
> ๐ก For storage configuration details, see [Configuration Details - Storage Configuration](#11-storage-configuration-v400-new)
### **Multi-Platform Deployment**
- **GitHub Actions**: Cloud automated operations (7-day check-in cycle + remote cloud storage)
- **Docker Deployment**: Supports multi-architecture containerized operation
- **Local Running**: Python environment direct execution
### **AI Analysis Push (v5.0.0 New)**
Use AI models to deeply analyze push content, automatically generate trending insights report
- **Smart Analysis**: Automatically analyze trending topics, keyword popularity, cross-platform correlation, potential impact
- **Multi Provider**: Supports DeepSeek, OpenAI, Gemini, and OpenAI-compatible APIs
- **Flexible Push**: Choose original content only, AI analysis only, or both
- **Custom Prompts**: Customize analysis perspective via `config/ai_analysis_prompt.txt`
> ๐ก Detailed configuration tutorial: [Let AI help me analyze hot topics](#12-let-ai-help-me-analyze-hot-topics)
### **Independent Display Section (v5.0.0 New)**
Provide complete trending display for specified platforms, unaffected by keyword filtering
- **Full Trending**: Specified platforms show complete trending list, for users who want to see full rankings
- **RSS Independent Display**: RSS source content can be fully displayed, not limited by keywords
- **Flexible Configuration**: Support configuring display platforms, RSS sources, max count
> ๐ก Detailed configuration tutorial: [Report Configuration - Independent Display](#7-report-configuration)
### **AI Smart Analysis (v3.0.0 New)**
AI conversational analysis system based on MCP (Model Context Protocol), enabling deep data mining with natural language.
> **๐ก Usage Tip**: AI features require local news data support
> - Project includes test data for immediate feature experience
> - Recommend deploying the project yourself to get more real-time data
>
> See [AI Analysis](#-ai-analysis) for details
### **Web Deployment**
After running, the `index.html` generated in the root directory is the complete news report page.
> **Deployment**: Click **Use this template** to create your repository, then deploy to Cloudflare Pages or GitHub Pages.
>
> **๐ก Tip**: Enable GitHub Pages for an online URL. Go to Settings โ Pages to enable. [Preview Effect](https://sansan0.github.io/TrendRadar/)
>
> โ ๏ธ The GitHub Actions auto-storage feature has been discontinued (this approach caused excessive load on GitHub servers, affecting platform stability).
### **Reduce APP Dependencies**
Transform from "algorithm recommendation captivity" to "actively getting the information you want"
**Target Users:** Investors, content creators, PR professionals, news-conscious general users
**Typical Scenarios:** Stock investment monitoring, brand sentiment tracking, industry trend watching, lifestyle news gathering
| Web Effect (Email Push) | Feishu Push Effect | AI Analysis Push Effect |
|:---:|:---:|:---:|
|  |  |  |
<br>
## ๐ Quick Start
> **Reminder**: You should first **[check the latest official documentation](https://github.com/sansan0/TrendRadar?tab=readme-ov-file)** to ensure the configuration steps are up to date.
### Choose the Deployment Method That Fits You
#### ๐
ฐ๏ธ Option A: Docker Deployment (Recommended ๐ฅ)
* **Features**: More stable than GitHub Actions
* **Best for**: Users with their own server, NAS, or an always-on PC
๐ **[Jump to Docker Deployment Tutorial](#6-docker-deployment)**
#### ๐
ฑ๏ธ Option B: GitHub Actions Deployment (This Chapter โฌ๏ธ)
* **Features**: Data is stored in **Remote Cloud Storage** (no longer written to Git repo)
* **Storage**: Configure cloud storage service (e.g. Cloudflare R2, Alibaba Cloud OSS, Tencent Cloud COS, etc.)
* **Note**: Requires periodic check-in renewal (every 7 days)
### 1๏ธโฃ Step 1: Get project code
Click the green **[Use this template]** button in the upper right corner of this repository โ select "Create a new repository".
> โ ๏ธ Note:
> - Any mention of "Fork" in this document can be understood as "Use this template"
> - Using Fork may cause runtime issues, see [Issue #606](https://github.com/sansan0/TrendRadar/issues/606)
<br>
### 2๏ธโฃ Step 2: Setup GitHub Secrets
In your Forked repository, go to `Settings` > `Secrets and variables` > `Actions` > `New repository secret`
**๐ Important Instructions (Please Read Carefully):**
- **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
**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 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>
**Bot Setup Steps:**
#### Mobile Setup:
1. Open WeWork App โ Enter target internal group chat
2. Click "โฆ" button at top right โ Select "Message Push"
3. Click "Add" โ Name input "TrendRadar"
4. Copy Webhook address, click save, paste the copied content into GitHub Secret above
#### PC Setup Process Similar
</details>
<details>
<summary> <strong>๐ Click to expand: Personal WeChat Push</strong> (Based on WeWork app, push to personal WeChat)</summary>
<br>
> This solution is based on WeWork's plugin mechanism. The push style is plain text (no markdown format), but it can push directly to personal WeChat without installing WeWork App.
**GitHub Secret Configuration (โ ๏ธ Name must match exactly):**
- **Name**: `WEWORK_WEBHOOK_URL` (Please copy and paste this name, do not type manually)
- **Secret (Value)**: Your WeWork app Webhook address
- **Name**: `WEWORK_MSG_TYPE` (Please copy and paste this name, do not type manually)
- **Secret (Value)**: `text`
<br>
**Setup Steps:**
1. Complete the WeWork bot Webhook setup above
2. Add `WEWORK_MSG_TYPE` Secret with value `text`
3. Follow the image below to link personal WeChat
4. After configuration, WeWork App can be deleted from phone
<img src="_image/wework.png" title="Personal WeChat Push Configuration"/>
**Notes**:
- Uses the same Webhook address as WeWork bot
- Difference is message format: `text` for plain text, `markdown` for rich text (default)
- Plain text format will automatically remove all markdown syntax (bold, links, etc.)
</details>
<details>
<summary> <strong>๐ Click to expand: Feishu Bot</strong> (Message display is relatively friendly)</summary>
<br>
**Note**: If **AI Analysis** is enabled, Feishu push notifications may occasionally (approx. 5% probability) experience a few minutes of delay. This is likely due to the platform's internal compliance auditing for AI-generated content.
**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)
Method 1 discovered and suggested by **ziventian**, thanks to them. Default is personal push, group push can be configured via [#97](https://github.com/sansan0/TrendRadar/issues/97)
**Method 1:**
> For some users, additional operations needed to avoid "System Error". Need to search for the bot on mobile and enable Feishu bot application (suggestion from community, can refer)
1. Open in PC browser https://botbuilder.feishu.cn/home/my-command
2. Click "New Bot Command"
3. Click "Select Trigger", scroll down, click "Webhook Trigger"
4. Now you'll see "Webhook Address", copy this link to local notepad temporarily, continue with next steps
5. In "Parameters" put the following content, then click "Done"
```json
{
"message_type": "text",
"content": {
"text": "{{Content}}"
}
}
```
6. Click "Select Action" > "Send via Official Bot"
7. Message title fill "TrendRadar Trending Monitor"
8. Most critical part, click + button, select "Webhook Trigger", then arrange as shown in image
9. After configuration, put Webhook address from step 4 into GitHub Secrets `FEISHU_WEBHOOK_URL`
<br>
**Method 2:**
1. Open in PC browser https://botbuilder.feishu.cn/home/my-app
2. Click "New Bot Application"
3. After entering the created application, click "Process Design" > "Create Process" > "Select Trigger"
4. Scroll down, click "Webhook Trigger"
5. Now you'll see "Webhook Address", copy this link to local notepad temporarily, continue with next steps
6. In "Parameters" put the following content, then click "Done"
```json
{
"message_type": "text",
"content": {
"text": "{{Content}}"
}
}
```
7. Click "Select Action" > "Send Feishu Message", check "Group Message", then click the input box below, click "Groups I Manage" (if no group, you can create one in Feishu app)
8. Message title fill "TrendRadar Trending Monitor"
9. Most critical part, click + button, select "Webhook Trigger", then arrange as shown in image
10. After configuration, put Webhook address from step 5 into GitHub Secrets `FEISHU_WEBHOOK_URL`
</details>
<details>
<summary> <strong>๐ Click to expand: DingTalk Bot</strong></summary>
<br>
**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>
**Bot Setup Steps:**
1. **Create Bot (PC Only)**:
- Open DingTalk PC client, enter target group chat
- Click group settings icon (โ๏ธ) โ Scroll down to find "Bot" and click
- Select "Add Bot" โ "Custom"
2. **Configure Bot**:
- Set bot name
- **Security Settings**:
- **Custom Keywords**: Set "Trending" or "็ญ็น"
3. **Complete Setup**:
- Check service terms agreement โ Click "Done"
- Copy the obtained Webhook URL
- Put URL into GitHub Secrets `DINGTALK_WEBHOOK_URL`
**Note**: Mobile can only receive messages, cannot create new bots.
</details>
<details>
<summary> <strong>๐ Click to expand: Telegram Bot</strong></summary>
<br>
**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>
**Bot Setup Steps:**
1. **Create Bot**:
- Search `@BotFather` in Telegram (note case, has blue verification checkmark, shows ~37849827 monthly users, this is official, beware of fake accounts)
- Send `/newbot` command to create new bot
- Set bot name (must end with "bot", easily runs into duplicate names, so think creatively)
- Get Bot Token (format like: `123456789:AAHfiqksKZ8WmR2zSjiQ7_v4TMAKdiHm9T0`)
2. **Get Chat ID**:
**Method 1: Via Official API**
- First send a message to your bot
- Visit: `https://api.telegram.org/bot<Your Bot Token>/getUpdates`
- Find the number in `"chat":{"id":number}` in returned JSON
**Method 2: Using Third-Party Tool**
- Search `@userinfobot` and send `/start`
- Get your user ID as Chat ID
3. **Configure to GitHub**:
- `TELEGRAM_BOT_TOKEN`: Fill in Bot Token from step 1
- `TELEGRAM_CHAT_ID`: Fill in Chat ID from step 2
</details>
<details>
<summary> <strong>๐ Click to expand: Email Push</strong> (Supports all mainstream email providers)</summary>
<br>
- Note: To prevent email bulk sending abuse, current bulk sending allows all recipients to see each other's email addresses.
- If you haven't configured email sending before, not recommended to try
> โ ๏ธ **Important Configuration Dependency**: Email push requires HTML report file. Make sure `storage.formats.html` is set to `true` in `config/config.yaml`:
> ```yaml
> storage:
> formats:
> sqlite: true
> txt: false
> html: true # Must be enabled, otherwise email push will fail
> ```
> If set to `false`, email push will report error: `Error: HTML file does not exist or not provided: None`
<br>
**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>
**Supported Email Providers** (Auto-detect SMTP config):
| Provider | Domain | SMTP Server | Port | Encryption |
|----------|--------|-------------|------|-----------|
| **Gmail** | gmail.com | smtp.gmail.com | 587 | TLS |
| **QQ Mail** | qq.com | smtp.qq.com | 465 | SSL |
| **Outlook** | outlook.com | smtp-mail.outlook.com | 587 | TLS |
| **Hotmail** | hotmail.com | smtp-mail.outlook.com | 587 | TLS |
| **Live** | live.com | smtp-mail.outlook.com | 587 | TLS |
| **163 Mail** | 163.com | smtp.163.com | 465 | SSL |
| **126 Mail** | 126.com | smtp.126.com | 465 | SSL |
| **Sina Mail** | sina.com | smtp.sina.com | 465 | SSL |
| **Sohu Mail** | sohu.com | smtp.sohu.com | 465 | SSL |
| **189 Mail** | 189.cn | smtp.189.cn | 465 | SSL |
| **Aliyun Mail** | aliyun.com | smtp.aliyun.com | 465 | TLS |
| **Yandex Mail** | yandex.com | smtp.yandex.com | 465 | TLS |
| **iCloud Mail** | icloud.com | smtp.mail.me.com | 587 | SSL |
> **Auto-detect**: When using above emails, no need to manually configure `EMAIL_SMTP_SERVER` and `EMAIL_SMTP_PORT`, system auto-detects.
>
> **Feedback Notice**:
> - If you successfully test with **other email providers**, please open an [Issue](https://github.com/sansan0/TrendRadar/issues) to let us know, we'll add to support list
> - If above email configurations are incorrect or unusable, please also open an [Issue](https://github.com/sansan0/TrendRadar/issues) for feedback to help improve the project
>
> **Special Thanks**:
> - Thanks to [@DYZYD](https://github.com/DYZYD) for contributing 189 Mail (189.cn) configuration and completing self-send-receive testing ([#291](https://github.com/sansan0/TrendRadar/issues/291))
> - Thanks to [@longzhenren](https://github.com/longzhenren) for contributing Aliyun Mail (aliyun.com) configuration and completing testing ([#344](https://github.com/sansan0/TrendRadar/issues/344))
> - Thanks to [@ACANX](https://github.com/ACANX) for contributing Yandex Mail (yandex.com) configuration and completing testing ([#663](https://github.com/sansan0/TrendRadar/issues/663))
> - Thanks to [@Sleepy-Tianhao](https://github.com/Sleepy-Tianhao) for contributing iCloud Mail (icloud.com) configuration and completing testing ([#728](https://github.com/sansan0/TrendRadar/issues/728))
**Common Email Settings:**
#### QQ Mail:
1. Login QQ Mail web version โ Settings โ Account
2. Enable POP3/SMTP service
3. Generate authorization code (16-letter code)
4. `EMAIL_PASSWORD` fill authorization code, not QQ password
#### Gmail:
1. Enable two-step verification
2. Generate app-specific password
3. `EMAIL_PASSWORD` fill app-specific password
#### 163/126 Mail:
1. Login web version โ Settings โ POP3/SMTP/IMAP
2. Enable SMTP service
3. Set client authorization code
4. `EMAIL_PASSWORD` fill authorization code
<br>
**Advanced Configuration**:
If auto-detect fails, manually configure SMTP:
- `EMAIL_SMTP_SERVER`: Like smtp.gmail.com
- `EMAIL_SMTP_PORT`: Like 587 (TLS) or 465 (SSL)
<br>
**Multiple Recipients (note: English comma separator)**:
- EMAIL_TO="user1@example.com,user2@example.com,user3@example.com"
</details>
<details>
<summary> <strong>๐ Click to expand: ntfy Push</strong> (Open-source, free, self-hostable)</summary>
<br>
**Two Usage Methods:**
### Method 1: Free Use (Recommended for Beginners) ๐
**Features**:
- โ
No account registration, use immediately
- โ
250 messages/day (enough for 90% users)
- โ
Topic name is "password" (need to choose hard-to-guess name)
- โ ๏ธ Messages unencrypted, not for sensitive info, but suitable for our non-sensitive project info
**Quick Start:**
1. **Download ntfy App**:
- Android: [Google Play](https://play.google.com/store/apps/details?id=io.heckel.ntfy) / [F-Droid](https://f-droid.org/en/packages/io.heckel.ntfy/)
- iOS: [App Store](https://apps.apple.com/us/app/ntfy/id1625396347)
- Desktop: Visit [ntfy.sh](https://ntfy.sh)
2. **Subscribe to Topic** (choose a hard-to-guess name):
```
Suggested format: trendradar-{your initials}-{random numbers}
Cannot use Chinese
โ
Good example: trendradar-zs-8492
โ Bad example: news, alerts (too easy to guess)
```
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
curl -d "Test message" ntfy.sh/your-topic-name
```
---
### Method 2: Self-Hosting (Complete Privacy Control) ๐
**Target Users**: Have server, pursue complete privacy, strong technical ability
**Advantages**:
- โ
Completely open-source (Apache 2.0 + GPLv2)
- โ
Complete data self-control
- โ
No restrictions
- โ
Zero cost
**Docker One-Click Deploy**:
```bash
docker run -d \
--name ntfy \
-p 80:80 \
-v /var/cache/ntfy:/var/cache/ntfy \
binwiederhier/ntfy \
serve --cache-file /var/cache/ntfy/cache.db
```
**Configure TrendRadar**:
```yaml
NTFY_SERVER_URL: https://ntfy.yourdomain.com
NTFY_TOPIC: trendradar-alerts # Self-hosting can use simple name
NTFY_TOKEN: tk_your_token # Optional: Enable access control
```
**Subscribe in App**:
- Click "Use another server"
- Enter your server address
- Enter topic name
- (Optional) Enter login credentials
---
**FAQ:**
<details>
<summary><strong>Q1: Is the free version enough?</strong></summary>
250 messages/day is enough for most users. With 30-minute crawl intervals, about 48 pushes/day, completely sufficient.
</details>
<details>
<summary><strong>Q2: Is the Topic name really secure?</strong></summary>
If you choose a random, sufficiently long name (like `trendradar-zs-8492-news`), brute force is nearly impossible:
- ntfy has strict rate limiting (1 request/second)
- 64 character choices (A-Z, a-z, 0-9, _, -)
- 10 random characters have 64^10 possibilities (would take years to crack)
</details>
---
**Recommended Choice:**
| User Type | Recommended | Reason |
|-----------|-------------|--------|
| Regular Users | Method 1 (Free) | Simple, fast, enough |
| Technical Users | Method 2 (Self-Host) | Complete control, unlimited |
| High-Frequency Users | Method 3 (Paid) | Check official website |
**Related Links:**
- [ntfy Official Docs](https://docs.ntfy.sh/)
- [Self-Hosting Tutorial](https://docs.ntfy.sh/install/)
- [GitHub Repository](https://github.com/binwiederhier/ntfy)
</details>
<details>
<summary>๐ Click to expand: <strong>Bark Push</strong> (iOS exclusive, clean & efficient)</summary>
<br>
**GitHub Secret Configuration (โ ๏ธ Name must be exact):**
- **Name**: `BARK_URL` (copy and paste this name, don't type manually)
- **Secret**: Your Bark push URL
<br>
**Bark Introduction:**
Bark is a free open-source push tool for iOS platform, featuring simplicity, speed, and no ads.
**Usage Methods:**
### Method 1: Use Official Server (Recommended for beginners) ๐
1. **Download Bark App**:
- iOS: [App Store](https://apps.apple.com/us/app/bark-customed-notifications/id1403753865)
2. **Get Push URL**:
- Open Bark App
- Copy the push URL displayed on the home page (format: `https://api.day.app/your_device_key`)
- Configure the URL to GitHub Secrets as `BARK_URL`
### Method 2: Self-Hosted Server (Complete Privacy Control) ๐
**Suitable for**: Users with servers, pursuing complete privacy, strong technical skills
**Docker One-Click Deployment**:
```bash
docker run -d \
--name bark-server \
-p 8080:8080 \
finab/bark-server
```
**Configure TrendRadar**:
```yaml
BARK_URL: http://your-server-ip:8080/your_device_key
```
---
**Notes:**
- โ
Bark uses APNs push, max 4KB per message
- โ
Supports automatic batch sending, no worry about long messages
- โ
Push format is plain text (automatically removes Markdown syntax)
- โ ๏ธ Only supports iOS platform
**Related Links:**
- [Bark Official Website](https://bark.day.app/)
- [Bark GitHub Repository](https://github.com/Finb/Bark)
- [Bark Server Self-Hosting Tutorial](https://github.com/Finb/bark-server)
</details>
<details>
<summary>๐ Click to expand: <strong>Slack Push</strong></summary>
<br>
**GitHub Secret Configuration (โ ๏ธ Name must be exact):**
- **Name**: `SLACK_WEBHOOK_URL` (copy and paste this name, don't type manually)
- **Secret**: Your Slack Incoming Webhook URL
<br>
**Slack Introduction:**
Slack is a team collaboration tool, Incoming Webhooks can push messages to Slack channels.
**Setup Steps:**
### Step 1: Create Slack App
1. **Visit Slack API Page**:
- Open https://api.slack.com/apps?new_app=1
- Login to your Slack workspace if not logged in
2. **Choose Creation Method**:
- Click **"From scratch"**
3. **Fill in App Information**:
- **App Name**: Enter app name (e.g., `TrendRadar` or `Hot News Monitor`)
- **Workspace**: Select your workspace from dropdown
- Click **"Create App"** button
### Step 2: Enable Incoming Webhooks
1. **Navigate to Incoming Webhooks**:
- Find and click **"Incoming Webhooks"** in left menu
2. **Enable Feature**:
- Find **"Activate Incoming Webhooks"** toggle
- Switch from `OFF` to `ON`
- Page will auto-refresh showing new configuration options
### Step 3: Generate Webhook URL
1. **Add New Webhook**:
- Scroll to page bottom
- Click **"Add New Webhook to Workspace"** button
2. **Select Target Channel**:
- System will show authorization page
- Select channel to receive messages from dropdown (e.g., `#hot-news`)
- โ ๏ธ For private channels, must join the channel first
3. **Authorize App**:
- Click **"Allow"** button to complete authorization
- System will auto-redirect back to config page
### Step 4: Copy and Save Webhook URL
1. **View Generated URL**:
- In "Webhook URLs for Your Workspace" section
- You'll see the newly generated Webhook URL
- Format: `https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX`
2. **Copy URL**:
- Click **"Copy"** button on the right of URL
- Or manually select and copy URL
3. **Configure to TrendRadar**:
- **GitHub Actions**: Add URL to GitHub Secrets as `SLACK_WEBHOOK_URL`
- **Local Testing**: Fill URL in `config/config.yaml` `slack_webhook_url` field
- **Docker Deployment**: Add URL to `docker/.env` file as `SLACK_WEBHOOK_URL` variable
---
**Notes:**
- โ
Supports Markdown format (auto-converts to Slack mrkdwn)
- โ
Supports automatic batch sending (4KB per batch)
- โ
Suitable for team collaboration, centralized message management
- โ ๏ธ Webhook URL contains secret key, never make it public
**Message Format Preview:**
```
*[Batch 1/2]*
๐ *Trending Topics Statistics*
๐ฅ *[1/3] AI ChatGPT* : 2 articles
1. [Baidu Hot] ๐ ChatGPT-5 Official Release *[1]* - 09:15 (1 time)
2. [Toutiao] AI Chip Stocks Surge *[3]* - [08:30 ~ 10:45] (3 times)
```
**Related Links:**
- [Slack Incoming Webhooks Official Docs](https://api.slack.com/messaging/webhooks)
- [Slack API App Management](https://api.slack.com/apps)
</details>
<details>
<summary>๐ Click to expand: <strong>Generic Webhook Push</strong> (Supports Discord, Matrix, IFTTT, etc.)</summary>
<br>
**GitHub Secret Configuration (โ ๏ธ Name must be exact):**
- **Name**: `GENERIC_WEBHOOK_URL` (copy and paste this name, don't type manually)
- **Secret**: Your Webhook URL
- **Name**: `GENERIC_WEBHOOK_TEMPLATE` (optional, copy and paste this name)
- **Secret**: JSON template string, supports `{title}` and `{content}` placeholders
<br>
**Generic Webhook Introduction:**
Generic Webhook supports any platform that accepts HTTP POST requests, including but not limited to:
- **Discord**: Push to channels via Webhook
- **Matrix**: Push via Webhook bridge
- **IFTTT**: Trigger automation workflows
- **Custom Services**: Any custom service supporting Webhooks
**Configuration Examples:**
### Discord Configuration
1. **Get Webhook URL**:
- Go to Discord Server Settings โ Integrations โ Webhooks
- Create new Webhook, copy URL
2. **Configure Template**:
```json
{"content": "{content}"}
```
3. **GitHub Secret Configuration**:
- `GENERIC_WEBHOOK_URL`: Discord Webhook URL
- `GENERIC_WEBHOOK_TEMPLATE`: `{"content": "{content}"}`
### Custom Templates
Templates support two placeholders:
- `{title}` - Message title
- `{content}` - Message content
**Template Examples**:
```json
# Default format (used when empty)
{"title": "{title}", "content": "{content}"}
# Discord format
{"content": "{content}"}
# Custom format
{"text": "{content}", "username": "TrendRadar"}
```
---
**Notes:**
- โ
Supports Markdown format (same as WeWork format)
- โ
Supports automatic batch sending
- โ
Supports multi-account configuration (use `;` separator)
- โ ๏ธ Template must be valid JSON format
- โ ๏ธ Different platforms have different message format requirements, please refer to target platform documentation
</details>
> โ ๏ธ Note:
> - For first deployment, suggest completing **GitHub Secrets** configuration first (choose one push platform), then jump to [Step 3] to test push success.
> - **Don't modify** `config/config.yaml` and `frequency_words.txt` temporarily, adjust these configs after push test succeeds as needed.
<br>
### 3๏ธโฃ Step 3: Manual Test News Push
> โ ๏ธ Reminder:
> - Complete Step 1-2 first, then test immediately! Test success first, then adjust configuration (Step 4) as needed.
> - IMPORTANT: Enter your own forked project, not this project!
**How to find your Actions page**:
- **Method 1**: Open your forked project homepage, click the **Actions** tab at the top
- **Method 2**: Direct access `https://github.com/YourUsername/TrendRadar/actions`
**Example comparison**:
- โ Author's project: `https://github.com/sansan0/TrendRadar/actions`
- โ
Your project: `https://github.com/YourUsername/TrendRadar/actions`
**Testing steps**:
1. Enter your project's Actions page
2. Find **"Hot News Crawler"** and click in
- If you don't see this text, refer to [#109](https://github.com/sansan0/TrendRadar/issues/109) to solve
3. Click **"Run workflow"** button on the right to run
4. Wait about 1 minute, messages will be pushed to your configured platform
> โ ๏ธ Note:
> - Don't test too frequently to avoid triggering GitHub Actions limits
> - After clicking Run workflow, you need to **refresh the browser page** to see the new run record
<br>
### 4๏ธโฃ Step 4: Configuration Notes (Optional)
The default configuration is ready to use. If you need personalized adjustments, just understand the following files:
| File | Purpose |
|------|---------|
| `config/config.yaml` | Main config file: push mode, time window, platform list, hotspot weights, etc. |
| `config/frequency_words.txt` | Keyword file: set your interested keywords, filter push content |
| `.github/workflows/crawler.yml` | Execution frequency: control how often to run (โ ๏ธ modify carefully) |
๐ **Detailed Configuration Tutorial**: [Configuration Guide](#configuration-guide)
<br>
### 5๏ธโฃ Step 5: GitHub Actions Check-In & Remote Cloud Storage
**v4.0.0 Important Change**: Introduced the "Activity Detection" mechanism; GitHub Actions need periodic check-ins to maintain operation.
- **Running Cycle**: Valid for **7 days**โservice will automatically suspend when countdown ends.
- **Renewal Method**: Manually trigger the "Check In" workflow on the Actions page to reset the 7-day validity period.
- **Operation Path**: `Actions` โ `Check In` โ `Run workflow`
- **Design Philosophy**:
- If you forget for 7 days, maybe you don't really need it. Letting it stop is a digital detox, freeing you from the constant impact.
- GitHub Actions is a valuable public computing resource. The check-in mechanism aims to prevent wasted computing cycles, ensuring resources are allocated to truly active users who need them. Thank you for your understanding and support.
---
**You can also choose NOT to configure remote cloud storage**, but then you will be in **Lite Mode** with some advanced features unavailable.
**Two Deployment Modes Comparison:**
| Mode | Configuration Required | Features |
|------|------------------------|----------|
| **Lite Mode** | No storage configuration needed | Real-time crawling + Keyword filtering + Multi-channel push |
| **Full Mode** | Configure remote cloud storage | Lite Mode + New detection + Trend tracking + Incremental push + AI analysis |
**Lite Mode Description**:
- โ
Available: Real-time news crawling, keyword filtering, hotspot weight ranking, current list push
- โ Not Available: New news detection (๐), trend tracking, incremental mode, daily summary accumulation, MCP AI analysis
**Full Mode Description**: Configure remote cloud storage to unlock all features. Continue with the configuration below.
<details>
<summary>๐ Click to expand: <strong>Remote Cloud Storage Configuration (Determines Feature Completeness) (Optional)</strong></summary>
<br>
**โ ๏ธ Prerequisites for Cloudflare R2 Configuration:**
According to Cloudflare platform rules, enabling R2 requires binding a payment method.
* **Purpose**: Verify identity only, **no charges will be incurred**.
* **Payment**: Supports dual-currency credit cards or regional PayPal.
* **Usage**: R2's free tier (10GB storage/month) is sufficient for this project's daily operation, no need to worry about costs.
---
**GitHub Secret Configuration:**
**Required Configuration (4 items):**
| Name | Secret (Value) Description |
|------|----------------------------|
| `S3_BUCKET_NAME` | Bucket name (e.g., `trendradar-data`) |
| `S3_ACCESS_KEY_ID` | Access key ID |
| `S3_SECRET_ACCESS_KEY` | Access key |
| `S3_ENDPOINT_URL` | S3 API endpoint (e.g., R2: `https://<account-id>.r2.cloudflarestorage.com`) |
**Optional Configuration:**
| Name | Secret (Value) Description |
|------|----------------------------|
| `S3_REGION` | Region (default `auto`, some providers may require specification) |
> ๐ก **More storage configuration options**: See [Storage Configuration Details](#11-storage-configuration-v400-new)
<br>
**How to Get Credentials (Using Cloudflare R2 as Example):**
1. Visit [Cloudflare Dashboard](https://dash.cloudflare.com/) and log in
2. Select `R2` in left menu โ Click `Create Bucket` โ Enter name (e.g., `trendradar-data`)
3. Click `Manage R2 API Tokens` at top right โ `Create API Token`
4. Select `Object Read & Write` permission โ After creation, it will display `Access Key ID` and `Secret Access Key`
5. Endpoint URL can be found in bucket details page (format: `https://<account-id>.r2.cloudflarestorage.com`)
</details>
<br>
### 6๏ธโฃ Step 6: Enable AI Analysis Push
This is a core feature of v5.0.0, letting AI summarize and analyze news for you. Highly recommended.
**Configuration Method:**
Add the following to GitHub Secrets (or `.env` / `config.yaml`):
- `AI_API_KEY`: Your API Key (Supports DeepSeek, OpenAI, etc.)
- `AI_PROVIDER`: Provider name (e.g., `deepseek`, `openai`)
That's it! No complex deployment needed. You'll see the smart analysis report in the next push.
<br>
### 7๏ธโฃ Step 7: ๐ Deployment Success!
Congratulations! Now you can start enjoying the efficient information flow brought by TrendRadar.
๐ฌ Many users are sharing their experiences on the official account, we look forward to your insights~
- Want to learn more tips and advanced techniques?
- Need quick answers to problems?
- Have great ideas to share?
๐ Follow the WeChat Official Accountใ**[Silicon Tea Room](#-support-project)**ใ, your likes and comments are the motivation for continuous updates.
<br>
### 8๏ธโฃ Step 8: Advanced: Choose Your AI Assistant
TrendRadar provides two ways to use AI to meet different needs:
| Feature | โจ AI Analysis Push (Step 6) | ๐ง AI Smart Analysis |
| :--- | :--- | :--- |
| **Mode** | **Passive Receipt** (Daily Report) | **Active Conversation** (Deep Research) |
| **Scenario** | "What's big today?" | "Analyze AI industry changes over the past week" |
| **Deployment** | Minimalist (Just add Key) | Advanced (Requires Local/Docker) |
| **Client** | Mobile | PC |
๐ **Conclusion**: Start with **AI Analysis Push** for daily needs; if you are a data analyst or need deep mining, try **[MCP Smart Analysis](#-ai-analysis)**.
<br>
<a name="configuration-guide"></a>
## โ๏ธ Configuration Guide
> **๐ Reminder**: This chapter provides detailed configuration explanations. Suggest completing [Quick Start](#-quick-start) basic configuration first, then refer to detailed options here as needed.
### 1. Platform Configuration
<details id="custom-monitoring-platforms">
<summary>๐ Click to expand: <strong>Custom Monitoring Platforms</strong></summary>
<br>
**Configuration Location:** `platforms` section in `config/config.yaml`
This project's news data comes from [newsnow](https://github.com/ourongxing/newsnow). You can click the [website](https://newsnow.busiyi.world/), click [More], to see if there are platforms you want.
For specific additions, visit [project source code](https://github.com/ourongxing/newsnow/tree/main/server/sources), based on the file names there, modify the `platforms` configuration in `config/config.yaml` file:
```yaml
platforms:
enabled: true # Enable trending platform crawling
sources:
- id: "toutiao"
name: "Toutiao"
- id: "baidu"
name: "Baidu Hot Search"
- id: "wallstreetcn-hot"
name: "Wallstreetcn"
# Add more platforms...
```
> ๐ก **Shortcut**: If you don't know how to read source code, you can copy from others' organized [Platform Configuration Summary](https://github.com/sansan0/TrendRadar/issues/95)
> โ ๏ธ **Note**: More platforms is not always better, suggest choosing 10-15 core platforms. Too many platforms will cause information overload and actually reduce user experience.
</details>
### 2. Keyword Configuration
**Configuration Location:** `config/frequency_words.txt`
Configure monitoring keywords in `frequency_words.txt` with seven syntax types, region markers, and grouping features.
| Syntax Type | Symbol | Purpose | Example | Matching Logic |
|------------|--------|---------|---------|----------------|
| **Normal** | None | Basic matching | `Huawei` | Match any one |
| **Required** | `+` | Scope limiting | `+phone` | Must include both |
| **Filter** | `!` | Noise exclusion | `!ad` | Exclude if included |
| **Count Limit** | `@` | Control display count | `@10` | Max 10 news (v3.2.0 new) |
| **Global Filter** | `[GLOBAL_FILTER]` | Globally exclude content | See example below | Filter under any circumstances (v3.5.0 new) |
| **Regex** | `/pattern/` | Precise matching | `/\bai\b/` | Match using regex (v4.7.0 new) |
| **Display Name** | `=> alias` | Custom display text | `/\bai\b/ => AI Related` | Show alias in push/HTML (v4.7.0 new) |
#### 2.1 Basic Syntax
<a name="keyword-basic-syntax"></a>
<details>
<summary>๐ Click to expand: <strong>Basic Syntax Tutorial</strong></summary>
<br>
##### 1. **Normal Keywords** - Basic Matching
```txt
Huawei
OPPO
Apple
```
**Effect:** News containing **any one** of these words will be captured
##### 2. **Required Words** `+word` - Scope Limiting
```txt
Huawei
OPPO
+phone
```
**Effect:** Must include both normal word **and** required word to be captured
##### 3. **Filter Words** `!word` - Noise Exclusion
```txt
Apple
Huawei
!fruit
!price
```
**Effect:** News containing filter words will be **excluded**, even if it contains keywords
##### 4. **Count Limit** `@number` - Control Display Count (v3.2.0 new)
```txt
Tesla
Musk
@5
```
**Effect:** Limit maximum news count for this keyword group
**Priority:** `@number` > Global config > Unlimited
##### 5. **Global Filter** `[GLOBAL_FILTER]` - Globally Exclude Content (v3.5.0 new)
```txt
[GLOBAL_FILTER]
advertisement
promotion
marketing
shocking
clickbait
[WORD_GROUPS]
technology
AI
Huawei
HarmonyOS
!car
```
**Effect:** Filters news containing specified words under **any circumstances**, with **highest priority**
**Use Cases:**
- Filter low-quality content: shocking, clickbait, breaking news, etc.
- Filter marketing content: advertisement, promotion, sponsorship, etc.
- Filter specific topics: entertainment, gossip (based on needs)
**Filter Priority:** Global Filter > Group Filter(`!`) > Group Matching
**Region Markers:**
- `[GLOBAL_FILTER]`: Global filter region, words are filtered under any circumstances
- `[WORD_GROUPS]`: Keyword groups region, maintains existing syntax (`!`, `+`, `@`)
- If no region markers are used, all content is treated as keyword groups (backward compatible)
**Matching Examples:**
```txt
[GLOBAL_FILTER]
advertisement
[WORD_GROUPS]
technology
AI
```
- โ "Advertisement: Latest tech product launch" โ Contains global filter word "advertisement", rejected
- โ
"Tech company launches new AI product" โ No global filter words, matches "technology" group
- โ
"AI technology breakthrough draws attention" โ No global filter words, matches "AI" in "technology" group
**Important Notes:**
- Use global filter words carefully to avoid over-filtering and missing valuable content
- Recommended to keep global filter words under 5-15
- For group-specific filtering, prioritize using group filter words (`!` prefix)
##### 6. **Regex** `/pattern/` - Precise Matching (v4.7.0 new)
Normal keywords use substring matching, which is convenient for Chinese but may cause false matches in English. For example, `ai` would match the `ai` in `training`.
Use regex syntax `/pattern/` to achieve precise matching:
```txt
/(?<![a-z])ai(?![a-z])/
artificial intelligence
```
**Effect:** Match using regular expressions, supports all Python regex syntax
**Common Regex Patterns:**
| Need | Regex | Description |
|------|-------|-------------|
| Word boundary | `/\bword\b/` | Match standalone word, e.g., `/\bai\b/` matches "AI" but not "training" |
| Non-letter boundary | `/(?<![a-z])ai(?![a-z])/` | Looser boundary, suitable for mixed Chinese-English |
| Start match | `/^breaking/` | Only match titles starting with "breaking" |
| End match | `/release$/` | Only match titles ending with "release" |
| Multiple options | `/apple\|huawei\|xiaomi/` | Match any one (note escaped `\|`) |
**Matching Examples:**
```txt
# Config
/(?<![a-z])ai(?![a-z])/
artificial intelligence
```
- โ
"AI is the future" โ Matches standalone "AI"
- โ
"Hello ai here" โ Non-letter boundaries, matches "ai"
- โ
"Artificial intelligence grows rapidly" โ Matches "artificial intelligence"
- โ "Resistance training is important" โ "ai" in "training" doesn't match
- โ "The maid cleaned the room" โ "ai" in "maid" doesn't match
**Combined Usage:**
```txt
# Regex + Normal + Filter
/\bai\b/
artificial intelligence
machine learning
!advertisement
```
**Notes:**
- Regex automatically enables case-insensitive matching (`re.IGNORECASE`)
- Supports JavaScript-style `/pattern/i` syntax (flags are ignored since case-insensitive is always enabled)
- Invalid regex syntax will be treated as normal words
- Regex can be used for normal words, required words(`+`), and filter words(`!`)
**๐ก Can't Write Regex? Let AI Help!**
If you're not familiar with regular expressions, just ask ChatGPT / Gemini / DeepSeek to generate one:
> I need a Python regex to match the word "ai" but not match "ai" in "training".
> Please give me the regex in `/pattern/` format without extra explanation.
AI will give you something like: `/(?<![a-zA-Z])ai(?![a-zA-Z])/`
##### 7. **Display Name** `=> alias` - Custom Display Text (v4.7.0 new)
Regex patterns can look unfriendly in push notifications and HTML pages. Use `=> alias` syntax to set a display name:
```txt
/(?<![a-zA-Z])ai(?![a-zA-Z])/ => AI Related
artificial intelligence
```
**Effect:** Push notifications and HTML pages show "AI Related" instead of the complex regex
**Syntax Format:**
```txt
# Regex + Display Name
/pattern/ => Display Name
/pattern/i => Display Name # Supports flags syntax (flags are ignored)
/pattern/=>Display Name # Spaces around => are optional
# Normal Word + Display Name
deepseek => DeepSeek News
```
**Example:**
```txt
# Config
/(?<![a-zA-Z])ai(?![a-zA-Z])/ => AI Related
artificial intelligence
```
| Original Config | Push/HTML Display |
|----------------|-------------------|
| `/(?<![a-z])ai(?![a-z])/` + `artificial intelligence` | `(?<![a-z])ai(?![a-z]) artificial intelligence` |
| `/(?<![a-z])ai(?![a-z])/ => AI Related` + `artificial intelligence` | **`AI Related`** |
**Notes:**
- Display name only needs to be set on the first word of a group
- If multiple words have display names, the first one is used
- Without display name, all words in the group are concatenated
---
#### ๐ Group Feature - Importance of Empty Lines
**Core Rule:** Use **empty lines** to separate different groups, each group is independently counted
##### Example Configuration:
```txt
iPhone
Huawei
OPPO
+launch
A-shares
Shanghai Index
Shenzhen Index
+fluctuation
!prediction
World Cup
Euro Cup
Asian Cup
+match
```
##### Group Explanation and Matching Effects:
**Group 1 - Phone Launches:**
- Keywords: iPhone, Huawei, OPPO
- Required: launch
- Effect: Must include phone brand name and "launch"
**Matching Examples:**
- โ
"iPhone 15 officially launched with pricing" โ Has "iPhone" + "launch"
- โ
"Huawei Mate60 series launch livestream" โ Has "Huawei" + "launch"
- โ
"OPPO Find X7 launch date confirmed" โ Has "OPPO" + "launch"
- โ "iPhone sales hit record high" โ Has "iPhone" but missing "launch"
**Group 2 - Stock Market:**
- Keywords: A-shares, Shanghai Index, Shenzhen Index
- Required: fluctuation
- Filter: prediction
- Effect: Include stock-related words and "fluctuation", but exclude "prediction"
**Matching Examples:**
- โ
"A-shares major fluctuation analysis today" โ Has "A-shares" + "fluctuation"
- โ
"Shanghai Index fluctuation reasons explained" โ Has "Shanghai Index" + "fluctuation"
- โ "Experts predict A-shares fluctuation trends" โ Has "A-shares" + "fluctuation" but contains "prediction"
- โ "A-shares trading volume hits new high" โ Has "A-shares" but missing "fluctuation"
**Group 3 - Football Events:**
- Keywords: World Cup, Euro Cup, Asian Cup
- Required: match
- Effect: Must include cup name and "match"
**Matching Examples:**
- โ
"World Cup group stage match results" โ Has "World Cup" + "match"
- โ
"Euro Cup final match time" โ Has "Euro Cup" + "match"
- โ "World Cup tickets on sale" โ Has "World Cup" but missing "match"
#### ๐ฏ Configuration Tips
##### 1. **From Broad to Strict Strategy**
```txt
# Step 1: Start with broad keywords for testing
Artificial Intelligence
AI
ChatGPT
# Step 2: After finding mismatches, add required words
Artificial Intelligence
AI
ChatGPT
+technology
# Step 3: After finding noise, add filter words
Artificial Intelligence
AI
ChatGPT
+technology
!advertisement
!training
```
##### 2. **Avoid Over-Complexity**
โ **Not Recommended:** Too many words in one group
```txt
Huawei
OPPO
Apple
Samsung
vivo
OnePlus
Meizu
+phone
+launch
+sales
!fake
!repair
!second-hand
```
**Recommended:** Split into precise groups
```txt
Huawei
OPPO
+new product
Apple
Samsung
+launch
phone
sales
+market
```
</details>
#### 2.2 Advanced Settings (v3.2.0 new)
<a name="keyword-advanced-settings"></a>
<details>
<summary>๐ Click to expand: <strong>Advanced Settings Tutorial</strong></summary>
<br>
##### Keyword Sorting Priority
**Config Location:** `config/config.yaml`
```yaml
report:
sort_by_position_first: false # Sorting priority config
```
| Value | Sorting Rule | Use Case |
|-------|-------------|----------|
| `false` (default) | News count โ โ Config position โ | Focus on popularity trends |
| `true` | Config position โ โ News count โ | Focus on personal priority |
**Example:** Config order A, B, C, news count A(3), B(10), C(5)
- `false`: B(10) โ C(5) โ A(3)
- `true`: A(3) โ B(10) โ C(5)
##### Global Display Count Limit
```yaml
report:
max_news_per_keyword: 10 # Max 10 per keyword (0=unlimited)
```
**Docker Environment Variables:**
```bash
SORT_BY_POSITION_FIRST=true
MAX_NEWS_PER_KEYWORD=10
```
**Combined Example:**
```yaml
# config.yaml
report:
sort_by_position_first: true # Config order priority
max_news_per_keyword: 10 # Global default max 10 per keyword
```
```txt
# frequency_words.txt
Tesla
Musk
@20 # Key focus, show 20 (override global)
Huawei # Use global config, show 10
BYD
@5 # Limit to 5
```
**Final Effect:** Display in config order: Tesla(20) โ Huawei(10) โ BYD(5)
</details>
### 3. Which push mode should I choose?
<details>
<summary>๐ Click to expand: <strong>Detailed Comparison of 3 Modes</strong></summary>
<br>
**Configuration Location:** `report.mode` in `config/config.yaml`
```yaml
report:
mode: "daily" # Options: "daily" | "incremental" | "current"
```
#### Detailed Comparison Table
| Mode | Target Users | Push Timing | Display Content | Typical Use Case |
|------|----------|----------|----------|--------------|
| **Daily Summary**<br/>`daily` | ๐ Managers/Regular Users | Scheduled push (default hourly) | All matched news of the day<br/>+ New news section | **Example**: Check all important news of the day at 6 PM<br/>**Feature**: See full-day trend, don't miss any hot topic<br/>**Note**: Will include previously pushed news |
| **Current Rankings**<br/>`current` | ๐ฐ Content Creators | Scheduled push (default hourly) | Current ranking matches<br/>+ New news section | **Example**: Track "which topics are hottest now" hourly<br/>**Feature**: Real-time understanding of current popularity ranking changes<br/>**Note**: Continuously ranked news appear each time |
| **Incremental Monitor**<br/>`incremental` | ๐ Traders/Investors | Push only when new | Newly appeared frequency word matches | **Example**: Monitor "Tesla", only notify when new news appears<br/>**Feature**: Zero duplication, only see first-time news<br/>**Suitable for**: High-frequency monitoring, avoid information disturbance |
#### Actual Push Effect Example
Assume you monitor "Apple" keyword, execute once per hour:
| Time | daily Mode Push | current Mode Push | incremental Mode Push |
|-----|--------------|----------------|-------------------|
| 10:00 | News A, News B | News A, News B | News A, News B |
| 11:00 | News A, News B, News C | News B, News C, News D | **Only** News C |
| 12:00 | News A, News B, News C | News C, News D, News E | **Only** News D, News E |
**Explanation**:
- `daily`: Cumulative display of all news of the day (A, B, C all retained)
- `current`: Display current ranking news (ranking changed, News D on list, News A off list)
- `incremental`: **Only push newly appeared news** (avoid duplicate disturbance)
#### Common Questions
> **๐ก Encountered this problem?** ๐ "Execute once per hour, news output in first execution still appears in next hour execution"
> - **Reason**: You might have selected `daily` (Daily Summary) or `current` (Current Rankings) mode
> - **Solution**: Change to `incremental` (Incremental Monitor) mode, only push new content
#### โ ๏ธ Incremental Mode Important Notice
> **Users who selected `incremental` (Incremental Monitor) mode, please note:**
>
> ๐ **Incremental mode only pushes when there are new matching news**
>
> **If you haven't received push notifications for a long time, it may be because:**
> 1. No new hot topics matching your keywords in current time period
> 2. Keyword configuration is too strict or too broad
> 3. Too few monitoring platforms
>
> **Solutions:**
> - Solution 1: ๐ [Optimize Keyword Configuration](#2-keyword-configuration) - Adjust keyword precision, add or modify monitoring keywords
> - Solution 2: Switch push mode - Change to `current` or `daily` mode for scheduled push notifications
> - Solution 3: ๐ [Add More Platforms](#1-platform-configuration) - Add more news platforms to expand information sources
</details>
### 4. How to adjust hotness algorithm?
<details>
<summary>๐ Click to expand: <strong>Customize Hotspot Weights</strong></summary>
<br>
**Configuration Location:** `advanced.weight` section in `config/config.yaml`
```yaml
advanced:
weight:
rank: 0.6 # Ranking weight
frequency: 0.3 # Frequency weight
hotness: 0.1 # Hotness weight
```
Current default configuration is balanced.
#### Two Core Scenarios
**Real-Time Trending Type**:
```yaml
advanced:
weight:
rank: 0.8 # Mainly focus on ranking
frequency: 0.1 # Less concern about continuity
hotness: 0.1
```
**Target Users**: Content creators, marketers, users wanting to quickly understand current hot topics
**In-Depth Topic Type**:
```yaml
advanced:
weight:
rank: 0.4 # Moderate ranking focus
frequency: 0.5 # Emphasize sustained heat within the day
hotness: 0.1
```
**Target Users**: Investors, researchers, journalists, users needing deep trend analysis
#### Adjustment Method
1. **Three numbers must sum to 1.0**
2. **Increase what's important**: Increase `rank` for rankings, `frequency` for continuity
3. **Suggest adjusting 0.1-0.2 at a time**, observe effects
Core idea: Users pursuing speed and timeliness increase ranking weight, users pursuing depth and stability increase frequency weight.
</details>
### 5. What will the messages look like?
<details>
<summary>๐ Click to expand: <strong>Message Style Preview</strong></summary>
<br>
#### Push Example
๐ Trending Keywords Stats
๐ฅ [1/3] AI ChatGPT : 2 items
1. [Baidu Hot] ๐ ChatGPT-5 officially launched [**1**] - 09:15 (1 time)
2. [Toutiao] AI chip concept stocks surge [**3**] - [08:30 ~ 10:45] (3 times)
โโโโโโโโโโโโโโโโโโโ
๐ [2/3] BYD Tesla : 2 items
1. [Weibo] ๐ BYD monthly sales break record [**2**] - 10:20 (1 time)
2. [Douyin] Tesla price reduction promotion [**4**] - [07:45 ~ 09:15] (2 times)
โโโโโโโโโโโโโโโโโโโ
๐ [3/3] A-shares Stock Market : 1 item
1. [Wallstreetcn] A-shares midday review [**5**] - [11:30 ~ 12:00] (2 times)
๐ New Trending News (Total 2 items)
**Baidu Hot** (1 item):
1. ChatGPT-5 officially launched [**1**]
**Weibo** (1 item):
1. BYD monthly sales break record [**2**]
Updated: 2025-01-15 12:30:15
#### Message Format Explanation
| Format Element | Example | Meaning | Description |
| ------------- | ------- | -------- | ----------- |
| ๐ฅ๐๐ | ๐ฅ [1/3] AI ChatGPT | Popularity Level | ๐ฅ High (โฅ10) ๐ Medium (5-9) ๐ Normal (<5) |
| [Number/Total] | [1/3] | Rank Position | Current group rank among all matches |
| Keyword Group | AI ChatGPT | Keyword Group | Group from config, title must contain words |
| : N items | : 2 items | Match Count | Total news matching this group |
| [Platform] | [Baidu Hot] | Source Platform | Platform name of the news |
| ๐ | ๐ ChatGPT-5 officially launched | New Mark | First appearance in this round |
| [**number**] | [**1**] | High Rank | Rank โค threshold, bold red display |
| [number] | [7] | Normal Rank | Rank > threshold, normal display |
| - time | - 09:15 | First Time | Time when news was first discovered |
| [time~time] | [08:30 ~ 10:45] | Duration | Time range from first to last appearance |
| (N times) | (3 times) | Frequency | Total appearances during monitoring |
| **New Section** | ๐ **New Trending News** | New Topic Summary | Separately shows newly appeared topics |
</details>
### 6. Docker Deployment
<details>
<summary>๐ Click to expand: <strong>Complete Docker Deployment Guide</strong></summary>
<br>
**Image Description:**
TrendRadar provides two independent Docker images, deploy according to your needs:
| Image Name | Purpose | Description |
|---------|------|------|
| `wantcat/trendradar` | News Push Service | Scheduled news crawling, push notifications (Required) |
| `wantcat/trendradar-mcp` | AI Analysis Service | MCP protocol support, AI dialogue analysis (Optional) |
> ๐ก **Recommendations**:
> - Only need push functionality: Deploy `wantcat/trendradar` image only
> - Need AI analysis: Deploy both images
---
#### Method 1: Using docker compose (Recommended)
1. **Create Project Directory and Config**:
**Method 1-A: Using git clone (Recommended, Simplest)**
```bash
# Clone project to local
git clone https://github.com/sansan0/TrendRadar.git
cd TrendRadar
```
**Method 1-B: Using wget to download config files**
```bash
# Create directory structure
mkdir -p trendradar/{config,docker}
cd trendradar
# Download config file templates
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/config/config.yaml -P config/
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/config/frequency_words.txt -P config/
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/config/ai_analysis_prompt.txt -P config/
# Download docker compose config
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/docker/.env -P docker/
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/docker/docker-compose.yml -P docker/
```
> ๐ก **Note**: Key directory structure required for Docker deployment:
```
current directory/
โโโ config/
โ โโโ config.yaml
โ โโโ frequency_words.txt
โ โโโ ai_analysis_prompt.txt # AI analysis prompt (v5.0.0 new, optional)
โโโ docker/
โโโ .env
โโโ docker-compose.yml
```
2. **Config File Description**:
- `config/config.yaml` - Application main config (report mode, push settings, AI analysis, etc.)
- `config/frequency_words.txt` - Keyword config (set your interested trending keywords)
- `config/ai_analysis_prompt.txt` - AI prompt config (customize AI analysis role and output format, v5.0.0 new)
- `.env` - Environment variable config (webhook URLs, API Keys, scheduled tasks)
**โ๏ธ Environment Variable Override Mechanism (v3.0.5+)**
If you encounter **config.yaml modifications not taking effect** in NAS or other Docker environments, you can directly override configs via environment variables:
| Environment Variable | Corresponding Config | Example Value | Description |
|---------------------|---------------------|---------------|-------------|
| `ENABLE_WEBSERVER` | - | `true` / `false` | Auto-start web server |
| `WEBSERVER_PORT` | - | `8080` | Web server port |
| `FEISHU_WEBHOOK_URL` | `notification.channels.feishu.webhook_url` | `https://...` | Feishu Webhook (multi-account use `;` separator) |
| `AI_ANALYSIS_ENABLED` | `ai_analysis.enabled` | `true` / `false` | Enable AI analysis (v5.0.0 new) |
| `AI_API_KEY` | `ai.api_key` | `sk-xxx...` | AI API Key (shared by ai_analysis and ai_translation) |
| `AI_PROVIDER` | `ai.provider` | `deepseek` / `openai` / `gemini` | AI provider (v5.0.0 new) |
| `S3_*` | `storage.remote.*` | - | Remote storage config (5 params) |
**Config Priority**: Environment Variables > config.yaml
**Usage Method**:
- Modify `.env` file, uncomment and fill in needed configs
- Or add directly in NAS/Synology Docker management interface's "Environment Variables"
- Restart container to take effect: `docker compose up -d`
3. **Start Service**:
**Option A: Start All Services (Push + AI Analysis)**
```bash
# Pull latest images
docker compose pull
# Start all services (trendradar + trendradar-mcp)
docker compose up -d
```
**Option B: Start News Push Service Only**
```bash
# Start trendradar only (scheduled crawling and push)
docker compose pull trendradar
docker compose up -d trendradar
```
**Option C: Start MCP AI Analysis Service Only**
```bash
# Start trendradar-mcp only (AI analysis interface)
docker compose pull trendradar-mcp
docker compose up -d trendradar-mcp
```
> ๐ก **Tips**:
> - Most users only need to start `trendradar` for news push functionality
> - Only need to start `trendradar-mcp` when using ChatGPT/Gemini for AI dialogue analysis
> - Both services are independent and can be flexibly combined
4. **Check Running Status**:
```bash
# View news push service logs
docker logs -f trendradar
# View MCP AI analysis service logs
docker logs -f trendradar-mcp
# View all container status
docker ps | grep trendradar
# Stop specific service
docker compose stop trendradar # Stop push service
docker compose stop trendradar-mcp # Stop MCP service
```
#### Method 2: Local Build (Developer Option)
If you need custom code modifications or build your own image:
```bash
# Clone project
git clone https://github.com/sansan0/TrendRadar.git
cd TrendRadar
# Modify config files
vim config/config.yaml
vim config/frequency_words.txt
# Use build version docker compose
cd docker
cp docker-compose-build.yml docker-compose.yml
```
**Build and Start Services**:
```bash
# Option A: Build and start all services
docker compose build
docker compose up -d
# Option B: Build and start news push service only
docker compose build trendradar
docker compose up -d trendradar
# Option C: Build and start MCP AI analysis service only
docker compose build trendradar-mcp
docker compose up -d trendradar-mcp
```
> ๐ก **Architecture Parameter Notes**:
> - Default builds `amd64` architecture images (suitable for most x86_64 servers)
> - To build `arm64` architecture (Apple Silicon, Raspberry Pi, etc.), set environment variable:
> ```bash
> export DOCKER_ARCH=arm64
> docker compose build
> ```
#### Image Update
```bash
# Method 1: Manual update (Crawler + MCP images)
docker pull wantcat/trendradar:latest
docker pull wantcat/trendradar-mcp:latest
docker compose down
docker compose up -d
# Method 2: Using docker compose update
docker compose pull
docker compose up -d
```
**Available Images**:
| Image Name | Purpose | Description |
|---------|------|---------|
| `wantcat/trendradar` | News Push Service | Scheduled news crawling, push notifications |
| `wantcat/trendradar-mcp` | MCP Service | AI analysis features (optional) |
#### Service Management Commands
```bash
# View running status
docker exec -it trendradar python manage.py status
# Manually execute crawler once
docker exec -it trendradar python manage.py run
# View real-time logs
docker exec -it trendradar python manage.py logs
# Display current config
docker exec -it trendradar python manage.py config
# Display output files
docker exec -it trendradar python manage.py files
# Web server management (for browser access to generated reports)
docker exec -it trendradar python manage.py start_webserver # Start web server
docker exec -it trendradar python manage.py stop_webserver # Stop web server
docker exec -it trendradar python manage.py webserver_status # Check web server status
# View help info
docker exec -it trendradar python manage.py help
# Restart container
docker restart trendradar
# Stop container
docker stop trendradar
# Remove container (keep data)
docker rm trendradar
```
> ๐ก **Web Server Notes**:
> - After starting, access latest report at `http://localhost:8080`
> - Access historical reports via directory navigation (e.g., `http://localhost:8080/2025-xx-xx/`)
> - Port can be configured in `.env` file with `WEBSERVER_PORT` parameter
> - Auto-start: Set `ENABLE_WEBSERVER=true` in `.env`
> - Security: Static files only, limited to output directory, localhost binding only
#### Data Persistence
Generated reports and data are saved in `./output` directory by default. Data persists even if container is restarted or removed.
**๐ Web Report Access Paths**:
TrendRadar generates daily summary HTML reports to two locations simultaneously:
| File Location | Access Method | Use Case |
|--------------|---------------|----------|
| `output/index.html` | Direct host access | **Docker Deployment** (via Volume mount, visible on host) |
| `index.html` | Root directory access | **GitHub Pages** (repository root, auto-detected by Pages) |
| `output/html/YYYY-MM-DD/ๅฝๆฅๆฑๆป.html` | Historical reports | All environments (archived by date) |
**Local Access Examples**:
```bash
# Method 1: Via Web Server (recommended, Docker environment)
# 1. Start web server
docker exec -it trendradar python manage.py start_webserver
# 2. Access in browser
http://localhost:8080 # Access latest report (default index.html)
http://localhost:8080/html/2025-xx-xx/ # Access reports for specific date
# Method 2: Direct file access (local environment)
open ./output/index.html # macOS
start ./output/index.html # Windows
xdg-open ./output/index.html # Linux
# Method 3: Access historical archives
open ./output/html/2025-xx-xx/ๅฝๆฅๆฑๆป.html
```
**Why two index.html files?**
- `output/index.html`: Docker Volume mounted to host, can be opened locally
- `index.html`: Pushed to repository by GitHub Actions, auto-deployed by GitHub Pages
> ๐ก **Tip**: Both files have identical content, choose either one to access.
#### Troubleshooting
```bash
# Check container status
docker inspect trendradar
# View container logs
docker logs --tail 100 trendradar
# Enter container for debugging
docker exec -it trendradar /bin/bash
# Verify config files
docker exec -it trendradar ls -la /app/config/
```
#### MCP Service Deployment (AI Analysis Feature)
If you need to use AI analysis features, you can deploy the standalone MCP service container.
**Architecture Description**:
```mermaid
flowchart TB
subgraph trendradar["trendradar"]
A1[Scheduled News Fetching]
A2[Push Notifications]
end
subgraph trendradar-mcp["trendradar-mcp"]
B1[127.0.0.1:3333]
B2[AI Analysis API]
end
subgraph shared["Shared Volume"]
C1["config/ (ro)"]
C2["output/ (ro)"]
end
trendradar --> shared
trendradar-mcp --> shared
```
**Quick Start**:
Use docker compose to start both news push and MCP services:
```bash
# Method 1: Clone project (Recommended)
git clone https://github.com/sansan0/TrendRadar.git
cd TrendRadar/docker
docker compose up -d
# Method 2: Download docker-compose.yml separately
mkdir trendradar && cd trendradar
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/docker/docker-compose.yml
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/docker/.env
mkdir -p config output
# Download config files
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/config/config.yaml -P config/
wget https://raw.githubusercontent.com/sansan0/TrendRadar/master/config/frequency_words.txt -P config/
# Modify volume paths in docker-compose.yml: ../config -> ./config, ../output -> ./output
docker compose up -d
# Check running status
docker ps | grep trendradar
```
**Start MCP Service Separately**:
```bash
# Linux/Mac
docker run -d --name trendradar-mcp \
-p 127.0.0.1:3333:3333 \
-v $(pwd)/config:/app/config:ro \
-v $(pwd)/output:/app/output:ro \
-e TZ=Asia/Shanghai \
wantcat/trendradar-mcp:latest
# Windows PowerShell
docker run -d --name trendradar-mcp `
-p 127.0.0.1:3333:3333 `
-v ${PWD}/config:/app/config:ro `
-v ${PWD}/output:/app/output:ro `
-e TZ=Asia/Shanghai `
wantcat/trendradar-mcp:latest
```
> โ ๏ธ **Note**: Ensure `config/` and `output/` folders exist in current directory with config files and news data before running.
**Verify Service**:
```bash
# Check MCP service health
curl http://127.0.0.1:3333/mcp
# View MCP service logs
docker logs -f trendradar-mcp
```
**Configure in AI Clients**:
After MCP service starts, configure based on your client:
**Cherry Studio** (Recommended, GUI config):
- Settings โ MCP Server โ Add
- Type: `streamableHttp`
- URL: `http://127.0.0.1:3333/mcp`
**Claude Desktop / Cline** (JSON config):
```json
{
"mcpServers": {
"trendradar": {
"url": "http://127.0.0.1:3333/mcp",
"type": "streamableHttp"
}
}
}
```
> ๐ก **Tip**: MCP service only listens on local port (127.0.0.1) for security. For remote access, configure reverse proxy and authentication yourself.
</details>
### 7. How is the push content displayed?
<details>
<summary>๐ Click to expand: <strong>Customize Push Style and Content</strong></summary>
<br>
**Configuration Location:** `report` and `display` sections in `config/config.yaml`
```yaml
report:
mode: "daily" # Push mode
display_mode: "keyword" # Display mode (v4.6.0 new)
rank_threshold: 5 # Ranking highlight threshold
sort_by_position_first: false # Sorting priority
max_news_per_keyword: 0 # Maximum display count per keyword
display:
region_order: # Region display order (v5.2.0 new)
- new_items # New trending section
- hotlist # Hotlist section
- rss # RSS subscription section
- standalone # Independent display section
- ai_analysis # AI analysis section
```
#### Configuration Details
| Config Item | Type | Default | Description |
|------------|------|---------|-------------|
| `mode` | string | `daily` | Push mode, options: `daily`/`incremental`/`current`, see [Push Mode Details](#3-push-mode-details) |
| `display_mode` | string | `keyword` | Display mode, options: `keyword`/`platform`, see below |
| `rank_threshold` | int | `5` | Ranking highlight threshold, news with rank โค this value will be displayed in bold |
| `sort_by_position_first` | bool | `false` | Sorting priority: `false`=sort by news count, `true`=sort by config position |
| `max_news_per_keyword` | int | `0` | Maximum display count per keyword, `0`=unlimited |
| `display.region_order` | list | See config above | Adjust list order to control region display positions |
#### Display Mode Configuration (v4.6.0 New)
Controls how news is grouped in push messages and HTML reports:
| Mode | Grouping | Title Prefix | Use Case |
|------|----------|--------------|----------|
| `keyword` (default) | Group by keyword | `[Platform]` | Users focusing on specific topics |
| `platform` | Group by platform | `[Keyword]` | Users focusing on specific platforms |
**Example Comparison:**
```
# keyword mode (group by keyword)
๐ Trending Keywords Stats
๐ฅ [1/3] AI : 12 items
1. [Weibo] OpenAI releases GPT-5 #1-#3 - 08:30 (5 times)
2. [Zhihu] How to view AI replacing programmers #2 - 09:15 (3 times)
# platform mode (group by platform)
๐ Trending News Stats
๐ฅ [1/4] Weibo : 12 items
1. [AI] OpenAI releases GPT-5 #1-#3 - 08:30 (5 times)
2. [Trump] Trump announces major policy #2 - 09:15 (3 times)
```
#### Region Display Order (region_order)
Control the display position of each section in push messages by adjusting the order of `display.region_order` list.
**Default Order**: New Items โ Hotlist โ RSS โ Standalone โ AI Analysis
**Custom Example**: Want AI analysis at the top?
```yaml
display:
region_order:
- ai_analysis # Move to first line
- new_items
- hotlist
- rss
- standalone
```
**Note**: A region will only be displayed when both conditions are met:
1. Listed in `region_order`
2. Corresponding switch in `display.regions` is `true`
#### Sorting Priority Configuration
**Example Scenario:** Config order A, B, C, news count A(3), B(10), C(5)
| Config Value | Display Order | Use Case |
|-------------|--------------|----------|
| `false` (default) | B(10) โ C(5) โ A(3) | Focus on popularity trends |
| `true` | A(3) โ B(10) โ C(5) | Focus on personal priority |
**Docker Environment Variables:**
```bash
SORT_BY_POSITION_FIRST=true
MAX_NEWS_PER_KEYWORD=10
```
#### Independent Display Section Configuration (v5.0.0 New)
Provides full trending list display for specified platforms, unaffected by `frequency_words.txt` keyword filtering.
**Configuration Location:** `display` section in `config/config.yaml`
```yaml
display:
regions:
standalone: true # Enable independent display section
standalone:
platforms: ["zhihu", "weibo"] # Trending platform ID list
rss_feeds: ["hacker-news"] # RSS feed ID list
max_items: 20 # Max display count per source (0=unlimited)
```
**Use Cases:**
- Want to view the complete trending ranking of a platform (like Zhihu) instead of just keyword-matched content
- Subscribed to RSS feeds with few updates (like personal blogs) and want full push every time
**Effect Example:**
```
๐ Independent Display Section (Total 15 items)
Zhihu Trending (10 items):
1. [Zhihu] How to view OpenAI releasing Sora?
2. [Zhihu] 2024 postgraduate entrance exam scores released...
...
Hacker News (5 items):
1. [Hacker News] Launch HN: TrendRadar...
...
```
</details>
### 8. When will I receive pushes?
<details>
<summary>๐ Click to expand: <strong>Set Push Time Window</strong></summary>
<br>
**Configuration Location:** `notification.push_window` section in `config/config.yaml`
```yaml
notification:
push_window:
enabled: false # Whether to enable
start: "20:00" # Start time (Beijing time)
end: "22:00" # End time (Beijing time)
once_per_day: true # Push only once per day
```
#### Configuration Details
| Config Item | Type | Default | Description |
|------------|------|---------|-------------|
| `enabled` | bool | `false` | Whether to enable push time window control |
| `start` | string | `"20:00"` | Push window start time (Beijing time, HH:MM format) |
| `end` | string | `"22:00"` | Push window end time (Beijing time, HH:MM format) |
| `once_per_day` | bool | `true` | `true`=push only once per day within window, `false`=push every execution within window |
#### Use Cases
| Scenario | Configuration Example |
|----------|---------------------|
| **Working Hours Push** | `start: "09:00"`, `end: "18:00"`, `once_per_day: false` |
| **Evening Summary Push** | `start: "20:00"`, `end: "22:00"`, `once_per_day: true` |
| **Lunch Break Push** | `start: "12:00"`, `end: "13:00"`, `once_per_day: true` |
#### Important Notice
> โ ๏ธ **GitHub Actions Users Note:**
> - GitHub Actions execution time is unstable, may have ยฑ15 minutes deviation
> - Time range should be at least **2 hours** wide
> - For precise timed push, recommend **Docker deployment** on personal server
#### Docker Environment Variables
```bash
PUSH_WINDOW_ENABLED=true
PUSH_WINDOW_START=09:00
PUSH_WINDOW_END=18:00
PUSH_WINDOW_ONCE_PER_DAY=false
```
#### Complete Configuration Examples
**Scenario: Push once between 8-10 PM daily**
```yaml
notification:
push_window:
enabled: true
start: "20:00"
end: "22:00"
once_per_day: true
```
**Scenario: Push every hour during working hours**
```yaml
notification:
push_window:
enabled: true
start: "09:00"
end: "18:00"
once_per_day: false
```
</details>
### 9. How often does it run?
<details>
<summary>๐ Click to expand: <strong>Set Auto-Run Frequency</strong></summary>
<br>
**Configuration Location:** `schedule` section in `.github/workflows/crawler.yml`
```yaml
on:
schedule:
- cron: "0 * * * *" # Run every hour
```
#### How to change the schedule?
GitHub Actions uses a time format called "Cron". You don't need to understand it deeply; just copy and replace the code below.
**Configuration Location**: `schedule` section in `.github/workflows/crawler.yml`
| I want... | Copy this line | Note |
|-----------|----------------|------|
| **Every Hour** | `- cron: "0 * * * *"` | **Default**, runs at minute 0 |
| **Every 30 Mins** | `- cron: "*/30 * * * *"` | Runs every 30 minutes |
| **Daily at 8 AM** | `- cron: "0 0 * * *"` | โ ๏ธ `0` because UTC 0:00 = Beijing 8:00 AM |
| **Work Hours (30m)** | `- cron: "*/30 0-14 * * *"` | Beijing 8:00 - 22:00 |
| **3 Times Daily** | `- cron: "0 0,6,12 * * *"` | Beijing 8:00, 14:00, 20:00 |
#### โ ๏ธ Two Important Notes
1. **Time Zone**: GitHub servers use **UTC time**.
- **Math**: Your desired Beijing time **minus 8 hours** = value to fill.
- *Example: For Beijing 20:00, fill in 12:00.*
2. **Don't run too often**: Suggest intervals no shorter than 30 minutes.
- GitHub free resources are limited; running too frequently might get flagged.
- Actions have startup delays, so precise timing isn't guaranteed anyway.
#### Step-by-Step Guide
1. In your GitHub repository, find `.github/workflows/crawler.yml`.
2. Click the โ๏ธ (Edit) button top right.
3. Find the line `cron: "..."` and replace the content inside quotes with the code above.
4. Click the green **Commit changes** button to save.
</details>
### 10. Push to multiple groups/devices
<details>
<summary>๐ Click to expand: <strong>Send to Multiple Recipients</strong></summary>
<br>
**Configuration Location:** `notification` section in `config/config.yaml`
> ### โ ๏ธ **Security First**
> **DO NOT write passwords/Tokens directly in `config.yaml`!**
> If you upload a file containing passwords to GitHub, the whole world can see it.
>
> **Correct Method**:
> - **GitHub Actions Users**: Add in Settings -> Secrets
> - **Docker Users**: Write in `.env` file (this file won't be uploaded)
#### How to push to multiple places?
Simple, just separate multiple addresses with a semicolon `;`.
**Example**:
Suppose you have two Feishu groups:
- Group 1: `https://.../webhook/aaa`
- Group 2: `https://.../webhook/bbb`
Config value:
`https://.../webhook/aaa;https://.../webhook/bbb`
#### Supported Platforms
| Platform | Method | Note |
|----------|--------|------|
| **Feishu/DingTalk/WeWork** | Separate URLs with `;` | Just chain them up |
| **Bark (iOS)** | Separate URLs with `;` | Push to multiple iPhones |
| **Telegram** | Separate Tokens and ChatIDs with `;` | โ ๏ธ **Order must match**: <br>Token1 โ ChatID1<br>Token2 โ ChatID2 |
| **ntfy** | Separate Topics and Tokens with `;` | If a topic needs no token, leave empty:<br>`token1;;token3` (middle is empty) |
#### Common Config Examples (GitHub Secrets / .env)
```bash
# Send to 3 Feishu groups
FEISHU_WEBHOOK_URL=https://hook1...;https://hook2...;https://hook3...
# Send to 2 DingTalk groups
DINGTALK_WEBHOOK_URL=https://oapi...;https://oapi...
# Send to 2 Telegram users (Match one-to-one)
TELEGRAM_BOT_TOKEN=tokenA;tokenB
TELEGRAM_CHAT_ID=userA;userB
```
> **Tip**: Default limit is 3 accounts per platform to prevent abuse. Adjust `MAX_ACCOUNTS_PER_CHANNEL` if needed.
</details>
<br>
### 11. Where is the data saved?
<details id="storage-config">
<summary>๐ Click to expand: <strong>Choose Data Storage Location</strong></summary>
<br>
#### Where is the data saved?
The system automatically selects the best location for you, so you usually don't need to worry about it:
| Your Environment | Data Location | Description |
|------------------|---------------|-------------|
| **Docker / Local** | **Local Disk** | Saved in the `output/` folder within the project directory. |
| **GitHub Actions** | **Cloud Storage** | Since GitHub Actions environments are destroyed after running, cloud storage (e.g., Cloudflare R2) is required. |
#### How to configure cloud storage? (For GitHub Actions Users)
If you run on GitHub Actions, you need a "cloud drive" to save data. For example, Cloudflare R2 (free tier is generous).
**Add these 5 variables to GitHub Secrets:**
| Variable Name | Value |
|---------------|-------|
| `STORAGE_BACKEND` | `remote` |
| `S3_BUCKET_NAME` | Your bucket name |
| `S3_ACCESS_KEY_ID` | Your Access Key |
| `S3_SECRET_ACCESS_KEY` | Your Secret Key |
| `S3_ENDPOINT_URL` | Your R2 endpoint URL |
> ๐ก **Tutorial**: How to apply for R2? See [Quick Start - Remote Storage Configuration](#-quick-start)
#### How long is data kept?
By default, we never delete your data. If you want to save space, you can enable "Auto Cleanup".
**Config Location**: `config/config.yaml`
```yaml
storage:
local:
retention_days: 30 # Keep local data for 30 days (0 = forever)
remote:
retention_days: 30 # Keep cloud data for 30 days
```
#### Push time is wrong? (Timezone Settings)
If you are overseas or find the push time doesn't match your local time, you can change the timezone.
**Config Location**: `config/config.yaml`
```yaml
app:
timezone: "Asia/Shanghai" # Default is China Standard Time
```
- Example for Los Angeles: `America/Los_Angeles`
- Example for London: `Europe/London`
</details>
### 12. Let AI help me analyze hot topics
<details id="ai-analysis-config">
<summary>๐ Click to expand: <strong>Enable AI Smart Analysis</strong></summary>
#### What can AI do for me?
After enabling this feature, AI acts as a professional analyst. When pushing a batch of news, it will:
1. **Auto-Read**: Read all matched trending news.
2. **Deep Think**: Analyze connections between seemingly isolated news items.
3. **Write Report**: Append a concise and profound "Insight Report" at the end of the push message.
**Includes**: Trending topic summary, public opinion direction, cross-platform correlation, potential impact assessment, etc.
#### How to enable AI Analysis?
The simplest way is via environment variables (Recommended for GitHub Secrets or .env).
**Required Configurations**:
| Variable Name | Value | Description |
|--------------|-------|-------------|
| `AI_ANALYSIS_ENABLED` | `true` | Enable switch |
| `AI_API_KEY` | `sk-xxxxxx` | Your API Key |
| `AI_MODEL` | `deepseek/deepseek-chat` | Model identifier (format: `provider/model`) |
**Supported AI Providers** (Based on LiteLLM, supports 100+ providers):
| Provider | AI_MODEL Value | Description |
|----------|----------------|-------------|
| **DeepSeek** (Recommended) | `deepseek/deepseek-chat` | Excellent cost-performance ratio for high-frequency analysis |
| **OpenAI** | `openai/gpt-4o`<br>`openai/gpt-4o-mini` | GPT-4o series |
| **Google Gemini** | `gemini/gemini-1.5-flash`<br>`gemini/gemini-1.5-pro` | Gemini series |
| **Custom API** | Any format | Use with `AI_API_BASE` |
> ๐ก **New Feature**: Now based on [LiteLLM](https://github.com/BerriAI/litellm) unified interface, supporting 100+ AI providers with simpler configuration and better error handling.
**Optional Configurations**:
| Variable Name | Default | Description |
|--------------|---------|-------------|
| `AI_API_BASE` | (auto) | Custom API endpoint (e.g., OneAPI, local models) |
| `AI_TEMPERATURE` | `1.0` | Sampling temperature (0-2, higher = more random) |
| `AI_MAX_TOKENS` | `5000` | Maximum tokens to generate |
| `AI_TIMEOUT` | `120` | Request timeout (seconds) |
| `AI_NUM_RETRIES` | `2` | Number of retries on failure |
#### Advanced: AI Translation
If you subscribe to foreign RSS feeds (like Hacker News), AI can translate the content into your native language.
**Configuration Location**: `config/config.yaml`
```yaml
ai_translation:
enabled: true # Enable translation
language: "Chinese" # Target language (Chinese, English, Japanese...)
```
#### Advanced: Customize AI "Persona"
Think the AI sounds too official? You can modify its prompt to change its style (e.g., "Sarcastic Commentator", "Senior Investment Advisor").
- **File**: `config/ai_analysis_prompt.txt`
- **Method**: Edit with a text editor, tell AI what analysis style you want.
</details>
<br>
## โจ AI Analysis
TrendRadar v3.0.0 added **MCP (Model Context Protocol)** based AI analysis feature, allowing natural language conversations with news data for deep analysis.
### โ ๏ธ Important Notice Before Use
**Critical: AI features require local news data support**
AI analysis **does not** query real-time online data directly, but analyzes **locally accumulated news data** (stored in the `output` folder)
#### Usage Instructions:
1. **Built-in Test Data**: The `output` directory includes one week of trending news data from **December 21-27, 2025** for quick feature testing
2. **Query Limitations**:
- โ
Only query data within available date range (Dec 21-27, 7 days total)
- โ Cannot query real-time news or future dates
3. **Getting Latest Data**:
- Test data is for quick experience only, **recommend deploying the project yourself** to get real-time data
- Follow [Quick Start](#-quick-start) to deploy and run the project
- After accumulating news data for at least 1 day, you can query the latest trending topics
---
### 1. Quick Deployment
Cherry Studio provides GUI config interface, 5-minute quick deployment, complex parts are one-click install.
**Illustrated Deployment Tutorial**: Now updated to my WeChat Official Account (see [Support Project](#-support-project)), reply "mcp" to get
**Detailed Deployment Tutorial**: [README-Cherry-Studio.md](README-Cherry-Studio.md)
**Deployment Mode Description**:
- **STDIO Mode (Recommended)**: One-time configuration, no need to reconfigure later. The **illustrated deployment tutorial** only demonstrates this mode's configuration.
- **HTTP Mode (Alternative)**: If STDIO mode configuration encounters issues, you can use HTTP mode. This mode's configuration is basically the same as STDIO, but only requires copy-pasting one line, less error-prone. The only thing to note is that you need to manually start the service before each use. For details, refer to the HTTP mode section at the bottom of [README-Cherry-Studio.md](README-Cherry-Studio.md).
### 2. Learning to Talk with AI
**Detailed Conversation Tutorial**: [README-MCP-FAQ.md](README-MCP-FAQ.md)
**Question Effect**:
> ๐ก **Tip**: Actually not recommended to ask multiple questions at once. If your chosen AI model cannot even sequentially call as shown below, suggest switching models.
<img src="/_image/ai4.png" alt="MCP usage effect" width="600">
<br>
## ๐ MCP Clients
TrendRadar MCP service supports standard Model Context Protocol (MCP), can connect to various AI clients supporting MCP for smart analysis.
### Supported Clients
**Note**:
- Replace `/path/to/TrendRadar` with your actual project path
- Windows paths use double backslashes: `C:\\Users\\YourName\\TrendRadar`
- Remember to restart after saving
<details>
<summary><b>๐ Click to expand: Cursor</b></summary>
#### Method 1: HTTP Mode
1. **Start HTTP Service**:
```bash
# Windows
start-http.bat
# Mac/Linux
./start-http.sh
```
2. **Configure Cursor**:
**Project Level Config** (Recommended):
Create `.cursor/mcp.json` in project root:
```json
{
"mcpServers": {
"trendradar": {
"url": "http://localhost:3333/mcp",
"description": "TrendRadar News Trending Aggregation Analysis"
}
}
}
```
**Global Config**:
Create `~/.cursor/mcp.json` in user directory (same content)
3. **Usage Steps**:
- Restart Cursor after saving config
- Check connected tools in chat interface "Available Tools"
- Start using: `Search today's "AI" related news`
#### Method 2: STDIO Mode (Recommended)
Create `.cursor/mcp.json`:
```json
{
"mcpServers": {
"trendradar": {
"command": "uv",
"args": [
"--directory",
"/path/to/TrendRadar",
"run",
"python",
"-m",
"mcp_server.server"
]
}
}
}
```
</details>
<details>
<summary><b>๐ Click to expand: VSCode (Cline/Continue)</b></summary>
#### Cline Configuration
Add in Cline's MCP settings:
**HTTP Mode**:
```json
{
"trendradar": {
"url": "http://localhost:3333/mcp",
"type": "streamableHttp",
"autoApprove": [],
"disabled": false
}
}
```
**STDIO Mode** (Recommended):
```json
{
"trendradar": {
"command": "uv",
"args": [
"--directory",
"/path/to/TrendRadar",
"run",
"python",
"-m",
"mcp_server.server"
],
"type": "stdio",
"disabled": false
}
}
```
#### Continue Configuration
Edit `~/.continue/config.json`:
```json
{
"experimental": {
"modelContextProtocolServers": [
{
"transport": {
"type": "stdio",
"command": "uv",
"args": [
"--directory",
"/path/to/TrendRadar",
"run",
"python",
"-m",
"mcp_server.server"
]
}
}
]
}
}
```
**Usage Examples**:
```
Analyze recent 7 days "Tesla" popularity trend
Generate today's trending summary report
Search "Bitcoin" related news and analyze sentiment
```
</details>
<details>
<summary><b>๐ Click to expand: MCP Inspector</b> (Debug Tool)</summary>
<br>
MCP Inspector is the official debug tool for testing MCP connections:
#### Usage Steps
1. **Start TrendRadar HTTP Service**:
```bash
# Windows
start-http.bat
# Mac/Linux
./start-http.sh
```
2. **Start MCP Inspector**:
```bash
npx @modelcontextprotocol/inspector
```
3. **Connect in Browser**:
- Visit: `http://localhost:3333/mcp`
- Test "Ping Server" function to verify connection
- Check "List Tools" returns 14 tools:
- Date Parsing: resolve_date_range
- Basic Query: get_latest_news, get_news_by_date, get_trending_topics
- Smart Search: search_news, search_related_news_history
- Advanced Analysis: analyze_topic_trend, analyze_data_insights, analyze_sentiment, find_similar_news, generate_summary_report
- System Management: get_current_config, get_system_status, trigger_crawl
</details>
<details>
<summary><b>๐ Click to expand: Other MCP-Compatible Clients</b></summary>
<br>
Any client supporting Model Context Protocol can connect to TrendRadar:
#### HTTP Mode
**Service Address**: `http://localhost:3333/mcp`
**Basic Config Template**:
```json
{
"name": "trendradar",
"url": "http://localhost:3333/mcp",
"type": "http",
"description": "News Trending Aggregation Analysis"
}
```
#### STDIO Mode (Recommended)
**Basic Config Template**:
```json
{
"name": "trendradar",
"command": "uv",
"args": [
"--directory",
"/path/to/TrendRadar",
"run",
"python",
"-m",
"mcp_server.server"
],
"type": "stdio"
}
```
**Notes**:
- Replace `/path/to/TrendRadar` with actual project path
- Windows paths use backslash escape: `C:\\Users\\...`
- Ensure project dependencies installed (ran setup script)
</details>
### Common Questions
<details>
<summary><b>๐ Click to expand: Q1: HTTP Service Cannot Start?</b></summary>
<br>
**Check Steps**:
1. Confirm port 3333 is not occupied:
```bash
# Windows
netstat -ano | findstr :3333
# Mac/Linux
lsof -i :3333
```
2. Check if project dependencies installed:
```bash
# Re-run install script
# Windows: setup-windows.bat or setup-windows-en.bat
# Mac/Linux: ./setup-mac.sh
```
3. View detailed error logs:
```bash
uv run python -m mcp_server.server --transport http --port 3333
```
4. Try custom port:
```bash
uv run python -m mcp_server.server --transport http --port 33333
```
</details>
<details>
<summary><b>๐ Click to expand: Q2: Client Cannot Connect to MCP Service?</b></summary>
<br>
**Solutions**:
1. **STDIO Mode**:
- Confirm UV path correct (run `which uv` or `where uv`)
- Confirm project path correct and no Chinese characters
- Check client error logs
2. **HTTP Mode**:
- Confirm service started (visit `http://localhost:3333/mcp`)
- Check firewall settings
- Try using 127.0.0.1 instead of localhost
3. **General Checks**:
- Restart client application
- Check MCP service logs
- Use MCP Inspector to test connection
</details>
<details>
<summary><b>๐ Click to expand: Q3: Tool Call Failed or Returns Error?</b></summary>
<br>
**Possible Reasons**:
1. **Data Does Not Exist**:
- Confirm crawler has run (have output directory data)
- Check query date range has data
- Check available dates in output directory
2. **Parameter Error**:
- Check date format: `YYYY-MM-DD`
- Confirm correct platform ID: `zhihu`, `weibo`, etc.
- See parameter descriptions in tool docs
3. **Config Issues**:
- Confirm `config/config.yaml` exists
- Confirm `config/frequency_words.txt` exists
- Check config file format is correct
</details>
<br>
## ๐ Related Projects
> **4 Related Articles** (Chinese):
- [Comment here for mobile Q&A by project author](https://mp.weixin.qq.com/s/KYEPfTPVzZNWFclZh4am_g)
- [Breaking 1000 stars in 2 months - My GitHub project promotion experience](https://mp.weixin.qq.com/s/jzn0vLiQFX408opcfpPPxQ)
- [Important notes for running this project via GitHub fork](https://mp.weixin.qq.com/s/C8evK-U7onG1sTTdwdW2zg)
- [How to write WeChat Official Account or news articles based on this project](https://mp.weixin.qq.com/s/8ghyfDAtQZjLrnWTQabYOQ)
> **AI Development**:
- If you have niche requirements, you can develop based on my project yourself, even with zero programming experience
- All my open-source projects use my own **AI-assisted software** to improve development efficiency, this tool is now open-source
- **Core Function**: Quickly filter project code to feed AI, you just need to add personal requirements
- **Project Address**: https://github.com/sansan0/ai-code-context-helper
### Other Projects
> ๐ Chairman Mao's Footprint Map - Interactive dynamic display of complete trajectory 1893-1976. Welcome comrades to contribute data
- https://github.com/sansan0/mao-map
> Bilibili Comment Data Visualization Analysis Software
- https://github.com/sansan0/bilibili-comment-analyzer
[](https://www.star-history.com/#sansan0/TrendRadar&Date)
<br>
## ๐ License
GPL-3.0 License
---
<div align="center">
[๐ Back to Top](#trendradar)
</div>
