Content
[English](README-en.md)
---
# Partner
<a href="http://compshare.cn/?ytag=GPU_YY_JL_git_zenfeed">
<img src="docs/images/ucloud.png" alt="Thanks to UCloud for sponsoring this project" width="420">
</a>
Thanks to UCloud for sponsoring this project! UCloud is an AI cloud platform that provides stable and comprehensive domestic model APIs, with a single key to call. The main package has a monthly subscription and a pay-as-you-go coding plan with a high cost-effectiveness ratio, based on the official 2-5 fold discount. It supports access to Claude Code, Codex, and API calls. It supports enterprise high concurrency, 7*24 technical support, and self-service invoicing. Users who register through [this link](http://compshare.cn/?ytag=GPU_YY_JL_git_zenfeed) can get a free platform experience fund of 5 yuan!
[](https://share.302.ai/mFS9MS)
[302.AI](https://share.302.ai/mFS9MS) is a pay-as-you-go AI application platform that provides the most comprehensive AI APIs and AI online applications on the market.
* For users: We provide over 50 AI applications covering text, image, and audio-visual fields, with no monthly fee, and payment based on usage, available online.
* For developers: One-stop access to almost all AI application development models and APIs, one-stop payment, and unified access.
* For enterprises: Management and use interface separation, one person manages, and multiple people use, reducing the threshold and cost of AI use for small and medium-sized enterprises.
GitHub one-click login [Register now](https://share.302.ai/mFS9MS) and get a $1 credit immediately!
---
# Main Content
<p align="center">
<img src="docs/images/crad.png" alt="zenfeed cover image">
</p>
<p align="center">
<a href="https://app.codacy.com/gh/glidea/zenfeed/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade"><img src="https://app.codacy.com/project/badge/Grade/1b51f1087558402d85496fbe7bddde89"/></a>
<a href="https://sonarcloud.io/summary/new_code?id=glidea_zenfeed"><img src="https://sonarcloud.io/api/project_badges/measure?project=glidea_zenfeed&metric=sqale_rating"/></a>
<a href="https://goreportcard.com/badge/github.com/glidea/zenfeed"><img src="https://goreportcard.com/badge/github.com/glidea/zenfeed"/></a>
<a href="https://deepwiki.com/glidea/zenfeed"><img src="https://deepwiki.com/badge.svg"/></a>
</p>
<h3 align="center">Stay Zen in the Feed</h3>
<p align="center">
zenfeed is your <strong>AI Information Hub</strong>. It's not only an <strong>Intelligent RSS Reader</strong> but also a real-time <strong>"News" Knowledge Base</strong> and a personal secretary that helps you track "specified events" and presents <strong>analysis reports</strong>.
</p>
<p align="center">
<a href="https://zenfeed.xyz"><b>Online Experience (RSS Reader only)</b></a>
|
<a href="https://github.com/xusonfan/zenfeedApp"><b>Android Experience (RSS Reader only)</b></a>
|
<a href="docs/tech/hld-zh.md"><b>Technical Documentation</b></a>
|
<a href="#-Installation-and-Usage"><b>Quick Start</b></a>
</p>
> [!NOTE]
> DeepWiki's description is not entirely accurate
---
**epub2rss**: Convert epub e-books into daily updated RSS Feeds, [join waitlist](https://epub2rss.pages.dev/)
**one-coffee**: A daily report product similar to syft, tracking everything (with differences: supporting podcasts and multimodal; high-quality sources, focusing on AI). Add my WeChat to join the waitlist below
---
## 💡 Preface
RSS (Really Simple Syndication) was born in the Web 1.0 era, aiming to solve the problem of information dispersion, allowing users to aggregate and track updates from multiple websites in one place without frequent visits. It pushes website updates to subscribers in summary form, making it easy to obtain information.
However, with the development of Web 2.0 and the rise of social media and algorithm recommendations, RSS did not become mainstream. The closure of Google Reader in 2013 was a significant event. As Zhang Yiming pointed out at the time, RSS requires users to have strong information screening capabilities and self-discipline to manage subscription sources; otherwise, it's easy to get overwhelmed by information noise. He believed that for most users, more relaxed "personalized recommendations" are a better solution, which led to the later development of Toutiao and Douyin.
Algorithm recommendations did lower the threshold for information acquisition but often led to information cocoons and entertainment addiction. If you want to obtain truly valuable content from information streams, you need stronger self-control to resist the "feeding" of algorithms.
Is pure RSS subscription the answer? Not entirely. Information overload and screening difficulties (information noise) are still pain points for RSS users.
As Confucius said, everything has a golden mean. Can we find a compromise that combines the control and high-quality sources of RSS with technical means to overcome its information overload drawbacks?
Try zenfeed! **AI + RSS** might be a better way to acquire information in this era. zenfeed aims to utilize AI capabilities to help you automatically screen and summarize the information you care about, allowing you to stay Zen in the Feed.
> Reference article: [AI Revives RSS? - Minority Report](https://sspai.com/post/89494)
---
## ✨ Features
**Designed for RSS veterans** 🚗
* Your AI-powered RSS Reader (used with [zenfeed-web](https://github.com/glidea/zenfeed-web))
* Can be used as an [MCP](https://mcp.so/) Server for [RSSHub](https://github.com/DIYgod/RSSHub)
* Customizable trustworthy RSS data sources, creating a super-fast personal AI search engine
* Features similar to [Feedly AI](https://feedly.com/ai)
<details>
<summary><b>Preview</b></summary>
<br>
<img src="docs/images/feed-list-with-web.png" alt="Feed list" width="600">
<img src="docs/images/chat-with-feeds.png" alt="Chat with feeds" width="500">
</details>
**Designed for seekers of alternatives to [Wanwuzhuizong](https://www.wwzzai.com/)** 🔍
* With powerful [information tracking capabilities](https://github.com/glidea/zenfeed/blob/main/docs/config-zh.md#%E8%B0%83%E5%BA%A6%E9%85%8B%E7%BD%AE-scheduls) and emphasis on high-quality, customizable data sources
* Can be used as an RSS version of [AI Chief Intelligence Officer](https://github.com/TeamWiseFlow/wiseflow?tab=readme-ov-file), more flexible and closer to engine form
<details>
<summary><b>Preview</b></summary>
<br>
<img src="docs/images/monitoring.png" alt="Monitoring setup" width="500">
<img src="docs/images/notification-with-web.png" alt="Notification example" width="500">
</details>
**Designed for Information Anxiety Sufferers (like me)** 😌
* If you're tired of frequently brushing information streams, try the briefing feature. Receive daily AI briefings for specified periods, efficiently reading in one go, and bid farewell to the hidden costs of context switching. Ah, it feels a bit like the Renaissance! ✨
* "zenfeed" is a combination of "zen" and "feed," meaning staying Zen in the feed.
<details>
<summary><b>Preview</b></summary>
<br>
<img src="docs/images/daily-brief.png" alt="Daily brief example" width="500">
</details>
**Designed for Developers** 🔬
* **Pipelined processing mechanism**: Similar to Prometheus's [Relabeling](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config), zenfeed abstracts each piece of content into a label set, allowing you to process (score, classify, summarize, filter, etc.) labels at each node of the pipeline with custom Prompts.
* **Flexible orchestration**: Based on processed labels, you can freely query, filter, [route](https://github.com/glidea/zenfeed/blob/main/docs/config-zh.md#%E9%80%9A%E7%9F%A5%E8%B7%AF%E7%94%B1%E9%85%8D%E7%BD%AE-notifyroute-%E5%8F%8A-notifyroutesub_routes) and [notify](https://github.com/glidea/zenfeed/blob/main/docs/config-zh.md#%E9%80%9A%E7%9F%A5%E6%B8%A0%E9%81%93-email-%E9%85%8D%E7%BD%AE-notifychannelsemail), giving zenfeed a strong tool-like and personalized flavor. See [Rewrite Rules](docs/tech/rewrite-zh.md) for details.
* **Open API**:
* [Query API](/docs/query-api-zh.md)
* [RSS Exported API](/docs/rss-api-zh.md)
* [Notify Webhook](/docs/webhook-zh.md)
* [大量声明式 YAML 配置](/docs/config-zh.md)
<details>
<summary><b>Preview</b></summary>
<br>
<img src="docs/images/update-config-with-web.png" alt="Update config via web" width="500">
</details>
<p align="center">
<a href="docs/preview.md"><b>➡️ View more preview effects</b></a>
</p>
---
## 🚀 Installation and Usage
### 1. Preparation
> [!IMPORTANT]
> zenfeed uses [Silicon Flow](https://cloud.siliconflow.cn/) provided model services by default.
> * Model: `Qwen/Qwen3-8B` (free) and `Qwen/Qwen3-Embedding-4B`.
> * **!!!If you're willing to sponsor this project, you'll get a certain amount of Gemini 2.5 Pro/Flash!!! (see below)**
> * If you don't have a Silicon Flow account, use [**invitation link**](https://cloud.siliconflow.cn/i/U2VS0Q5A) to get **14 yuan** gift quota.
> * If you need to use other manufacturers or models, or perform more detailed custom deployment, please refer to [configuration documentation](https://github.com/glidea/zenfeed/blob/main/docs/config-zh.md) to edit `docker-compose.yml`.
### 2. One-click Deployment
> Fastest 1 minute to start the service.
#### Mac / Linux
```bash
# Download configuration file
curl -L -O https://raw.githubusercontent.com/glidea/zenfeed/main/docker-compose.yml
# Start service (please replace your API_KEY)
API_KEY="sk-..." docker-compose -p zenfeed up -d
```
#### Windows (PowerShell)
```powershell
# Download configuration file
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/glidea/zenfeed/main/docker-compose.yml" -OutFile "docker-compose.yml"
# Start service (please replace your API_KEY)
$env:API_KEY = "sk-..."; docker-compose -p zenfeed up -d
```
🎉 **Deployment completed!**
Access http://localhost:1400
> [!WARNING]
> * If you deploy zenfeed on a VPS or public network environment, please access it through `http://<your IP>:1400` and ensure that the firewall/security group has opened port `1400`.
> * **Security tip:** zenfeed does not have an authentication mechanism yet, exposing the service to the public network may leak your `API_KEY`. Please configure strict security group rules and only open access to trusted IPs.
### 3. Getting Started
> Android version: https://github.com/xusonfan/zenfeedApp
#### Add RSS Subscription Source
<img src="docs/images/web-add-source.png" alt="Add RSS source via web" width="400">
> * Migrate from Follow, please refer to [migrate-from-follow.md](docs/migrate-from-follow.md).
> * After adding, zenfeed needs to access the source station, please ensure the network is smooth.
> * After adding, please wait a few minutes for content crawling and processing, especially when the model has strict rate limits.
#### Configure Daily Brief, Monitoring, etc.
<img src="docs/images/notification-with-web.png" alt="Configure notifications via web" width="400">
#### Configure MCP (optional)
Take Cherry Studio as an example, configure MCP and connect to Zenfeed, see [Cherry Studio MCP](docs/cherry-studio-mcp.md).
> Default address `http://localhost:1301/sse`
#### More...
The page cannot fully express zenfeed's powerful flexibility, for more gameplay, please refer to [configuration documentation](docs/config-zh.md)
---
## 🗺️ Roadmap
We plan some cool features, welcome to view [Roadmap](/docs/roadmap-zh.md) and propose your suggestions!
---
## 💬 Communication and Support
> **Please propose [Issues](https://github.com/glidea/zenfeed/issues) for usage problems first**, which can help friends with similar problems and better track and solve problems.
<table>
<tr>
<td align="center">
<img src="https://github.com/glidea/zenfeed/blob/main/docs/images/wechat.png?raw=true" alt="Wechat QR Code" width="300">
<br>
<strong>AI Learning Exchange Community</strong>
</td>
<td align="center">
<img src="https://github.com/glidea/banana-prompt-quicker/blob/main/images/glidea.png?raw=true" width="250">
<br>
<strong><a href="https://glidea.zenfeed.xyz/">My other projects</a></strong>
</td>
</tr>
<tr>
<td align="center" colspan="2">
<img src="https://github.com/glidea/banana-prompt-quicker/blob/main/images/readnote.png?raw=true" width="400">
<br>
<strong><a href="https://www.xiaohongshu.com/user/profile/5f7dc54d0000000001004afb">📕 Xiaohongshu account - Continuously sharing AI original content</a></strong>
</td>
</tr>
</table>
You've made it this far, give me a **Star ⭐️** for motivation!
If you have interesting AI jobs, please contact me!
---
## 📝 Notes and Disclaimer
### Notes
* **Version compatibility:** Before version 1.0, API and configuration backward compatibility are not guaranteed.
* **Open-source protocol:** The project uses the AGPLv3 protocol, and any fork and distribution must remain open-source.
* **Commercial use:** Please contact the author for commercial use, and support will be provided within a reasonable range. We welcome legitimate commercial use and do not encourage using this project for gray industries.
* **Data storage:** Data will not be stored permanently and is stored for 8 days by default.
### Acknowledgments
* Thanks to [eryajf](https://github.com/eryajf) for providing [Compose Inline Config](https://github.com/glidea/zenfeed/issues/1) suggestions, making deployment easier to understand.
* [](https://dartnode.com "Powered by DartNode - Free VPS for Open Source")
### Welcome Contributions
* The contribution specifications are still being improved, but we adhere to a core principle: "code style consistency".
### Disclaimer
<details>
<summary><strong>Click to expand and view the full disclaimer</strong></summary>
**Before using the `zenfeed` software (hereinafter referred to as "the Software"), please carefully read and understand this disclaimer. Your download, installation, use of the Software or any related services will be considered as your reading, understanding, and agreement to all terms of this statement. If you do not agree with any content of this statement, please stop using the Software immediately.**
1. **"As-Is" Provision:** The Software is provided "as-is" and "as-available" without any express or implied warranties of any kind. The project authors and contributors make no guarantees or representations regarding the merchantability, fitness for a particular purpose, non-infringement, accuracy, completeness, reliability, security, timeliness, or performance of the Software.
2. **User Responsibilities:** You will be fully responsible for all your actions related to the use of the Software. This includes but is not limited to:
* **Data Source Selection:** You are solely responsible for selecting and configuring the data sources to be connected (such as RSS feeds, potential future Email sources, etc.). You must ensure you have the right to access and process the content of these data sources and comply with their respective terms of service, copyright policies, and applicable laws and regulations.
* **Content Compliance:** You must not use the Software to process, store, or distribute any illegal, infringing, defamatory, obscene, or otherwise objectionable content.
* **API Keys and Credentials Security:** You are responsible for protecting the security of any API keys, passwords, or other credentials configured in the Software. The project authors and contributors will not be liable for any loss or damage caused by your failure to properly secure them.
* **Configuration and Use:** You are responsible for correctly configuring and using the Software's features, including content processing pipelines, filtering rules, notification settings, etc.
3. **Third-Party Content and Services:** The Software may integrate or depend on third-party data sources or services (such as RSSHub, LLM providers, SMTP service providers, etc.). The project authors and contributors are not responsible for the availability, accuracy, legality, security, or terms of service of these third-party content or services. Your interaction with these third parties is governed by their respective terms and policies. The copyright of third-party content processed through the Software (including original articles, summaries, classifications, ratings, etc.) belongs to the original copyright holders, and you are responsible for any potential legal liabilities arising from the use of these contents.
4. **No Content Processing Guarantee:** The Software uses large language models (LLM) and other technologies to process content (such as summaries, classifications, ratings, filtering). These processing results may be inaccurate, incomplete, or biased. The project authors and contributors are not responsible for any decisions or actions taken based on these processing results. The accuracy of semantic search results is also influenced by multiple factors and is not guaranteed.
5. **No Indirect or Consequential Damages:** In no event will the project authors and contributors be liable for any direct, indirect, incidental, special, punitive, or consequential damages, whether in contract, tort, or otherwise, arising out of or in connection with the use or inability to use the Software, including but not limited to loss of profits, data loss, loss of goodwill, business interruption, or other commercial damages or losses, even if advised of the possibility of such damages.
6. **Open-Source Software:** The Software is licensed under the AGPLv3 license. You are responsible for understanding and complying with the terms of this license.
7. **Not Legal Advice:** This disclaimer does not constitute legal advice. If you have any questions about the legal implications of using the Software, you should consult a qualified legal professional.
8. **Modification and Acceptance:** The project authors reserve the right to modify this disclaimer at any time. Continued use of the Software will be considered acceptance of the modified terms.
**Please note again: Using the Software to crawl, process, and distribute copyrighted content may involve legal risks. You are responsible for ensuring that your use complies with all applicable laws and regulations and third-party service terms. The project authors and contributors will not be liable for any legal disputes or losses caused by your abuse or improper use of the Software.**
</details>
