https://github.com/caomeiyouren/rss-impact-server

一个支持 Hook 的 RSS 订阅工具。本项目为后端部分。文档：https://rss-docs.cmyr.dev/
https://github.com/caomeiyouren/rss-impact-server

rss rss-aggregator rss-feed rss-hook

Last synced: 6 days ago
JSON representation

一个支持 Hook 的 RSS 订阅工具。本项目为后端部分。文档：https://rss-docs.cmyr.dev/

• Host: GitHub
• URL: https://github.com/caomeiyouren/rss-impact-server
• Owner: CaoMeiYouRen
• License: agpl-3.0
• Created: 2024-03-09T07:50:02.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-10-29T22:06:20.000Z (16 days ago)
• Last Synced: 2024-10-30T00:38:11.075Z (16 days ago)
• Topics: rss, rss-aggregator, rss-feed, rss-hook
• Language: TypeScript
• Homepage: https://rss-demo.cmyr.dev/
• Size: 4.89 MB
• Stars: 27
• Watchers: 0
• Forks: 2
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
rss-impact-server 



  

  

  

  

    

     

  

  

    

  

  

  

    

  

  

    

  

  

    

  



> RSS + Hook = RSS Impact

>

> 一个支持 Hook 的 RSS 订阅工具。

>

> 本项目为后端部分，前端部分请参考 [rss-impact-web](https://github.com/CaoMeiYouRen/rss-impact-web)。

>

> **rss-impact-plus** 正在众筹中，详情请点击链接查看：[rss-impact-plus 众筹](https://afdian.com/project/73a4fc8e6de911efa0f95254001e7c00)。

>

> 当 RSS Impact 开发完毕的时候，您将收到通知邮件，**[点击链接立即加入等待名单](https://waitlist.cmyr.dev)**。

## 🏠 主页

[https://github.com/CaoMeiYouRen/rss-impact-server#readme](https://github.com/CaoMeiYouRen/rss-impact-server#readme)

## 🌰 Demo

https://rss-demo.cmyr.dev

用户名：`demo` 密码：`demodemo`

> Demo 站开放注册，可以随意体验。

>

> Demo 站不保证可用性，仅供演示使用。

>

> 注意：Demo 站每次部署都会重置数据，因此仅供体验，请勿存放重要数据！

如果你不希望数据被删除，可以访问内测体验站（需要注册账号）：https://rss-impact.cmyr.ltd

内测体验站目前也会和 Demo 站同步更新，所以不保证可用性（但在内测结束前，数据不会删除）。

## ✨功能亮点

- 项目的核心在于 Hook ，本项目支持 推送通知、Webhook 、下载、BitTorrent、AI 大模型 等多种形式的 Hook ，还支持反转触发（即 RSS 源出错的时候触发）。

- 推送通知 Hook 基于 [push-all-in-one](https://github.com/CaoMeiYouRen/push-all-in-one) 开发，支持 Server 酱、自定义邮件、钉钉机器人、企业微信机器人 等多种推送方式。支持 markdown 格式推送。

- BitTorrent Hook 支持调用 qBitTorrent 接口来自动下载 BitTorrent ，也支持按体积过滤 BitTorrent ，解决部分 BitTorrent RSS 源没有提供 `enclosureLength` 的问题。支持 `` tag。

- Webhook 支持 GET/POST 等全部 HTTP 方法进行调用。

- 下载 Hook 支持按 md5 过滤资源，支持按后缀名过滤资源。

- AI Hook 支持调用 OpenAI（或兼容 OpenAI 接口）的大模型，支持 AI 总结。支持在 AI 总结后推送。支持生成/翻译 RSS 分类 。

- 支持正则替换 Hook，可对正文内容进行替换，可用于替换链接为代理地址。

- 支持自定义查询，并将查询结果转换为 RSS。自定义查询支持将 AI 总结输出到正文中。

- 支持从 OPML 文件导入订阅，也支持导出订阅为 OPML 文件。

- 支持 Docker 一键部署。

- 支持 Redis 缓存。

- 支持 SQLite/MySQL/Postgres 作为数据库 (详见：[数据库配置](./docs/usage.md#数据库配置))。

- 支持配置代理。

- 支持自动抓取全文。无需配置 css 查询器。

- 支持 [Auth0](https://auth0.com/) 第三方一键登录。

## 📦 依赖要求

- node >=16

## 🚀 部署

部署方式请查看 [部署文档](./docs/deploy.md)

## 👨‍💻 使用

```sh

pnpm run start

```

更多使用说明请参考 [使用文档](./docs/usage.md)

## 🛠️ 开发

```sh

pnpm run dev

```

## 🔧 编译

```sh

pnpm run build

```

## 🧪 测试

```sh

pnpm run test

```

## 🔍 Lint

```sh

pnpm run lint

```

## 💾 Commit

```sh

pnpm run commit

```

## 👤 作者

**CaoMeiYouRen**

* Website: [https://blog.cmyr.ltd/](https://blog.cmyr.ltd/)

* GitHub: [@CaoMeiYouRen](https://github.com/CaoMeiYouRen)

## 🤝 贡献

欢迎 贡献、提问或提出新功能！
如有问题请查看 [issues page](https://github.com/CaoMeiYouRen/rss-impact-server/issues). 
贡献或提出新功能可以查看[contributing guide](https://github.com/CaoMeiYouRen/rss-impact-server/blob/master/CONTRIBUTING.md).

## 💰 支持

如果觉得这个项目有用的话请给一颗⭐️，非常感谢。



  



## 🌟 Star History

[![Star History Chart](https://api.star-history.com/svg?repos=CaoMeiYouRen/rss-impact-server&type=Date)](https://star-history.com/#CaoMeiYouRen/rss-impact-server&Date)

## 📝 License

1. 本项目采用 AGPLv3 授权，并附加以下额外条件。

2. 任何个人和商业实体可以基于本项目进行商业化使用，但必须遵守以下额外条件:

3. 商业化使用的产品或服务中，必须包含与原项目明显不同的功能或改进。这些不同之处需要在产品描述中向最终用户充分披露。

4. 个人可以基于本项目进行非商业化使用，无需遵守第 3 条的额外条件。 

5. 非商业化使用是指不以营利为目的的使用。

6. 本项目的 Logo 不在 License 协议范围内，图片版权由项目所有者 [CaoMeiYouRen](https://github.com/CaoMeiYouRen) 保留。如要进行商业化使用，需更换 Logo。非商业化使用的情况允许在不影响项目所有者权益的情况下使用。

7. 如果您至少向本项目提交并被合并 1 个有效的功能改进或问题修复，可以免除第 3 条的条件。本条仅适用于个人。

8. 对于任何贡献到本项目的代码，贡献者同意：项目所有者可以在遵守项目协议的前提下，用于非商业化和商业化用途；项目所有者可以按照项目协议的条款对外分发该代码。

9. 项目所有者保留对违反以上授权说明的个人和商业实体追究的权利。

10. 本授权说明可能会进行修改或更新。修改后的授权说明从公布修改内容的次日 00:00(UTC+8) 时起开始生效,并适用于此后对本项目的使用。

Copyright © 2024 [CaoMeiYouRen](https://github.com/CaoMeiYouRen).


This project is [AGPL-3.0](https://github.com/CaoMeiYouRen/rss-impact-server/blob/master/LICENSE) licensed.

***

_This README was generated with ❤️ by [cmyr-template-cli](https://github.com/CaoMeiYouRen/cmyr-template-cli)_