Skip to content

Commit

Permalink
docs: 更新文档说明;增加 功能亮点介绍
Browse files Browse the repository at this point in the history
  • Loading branch information
CaoMeiYouRen committed Jun 9, 2024
1 parent d65e4ca commit 914f2d4
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,13 @@
>
> 一个基于 RSS 的 Hook 系统。本项目为后端部分。
**温馨提示:本项目还在开发阶段,功能还不完善,暂时还不建议在生产环境使用。**

## 🏠 主页

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

## Demo
## 🌰 Demo

https://rss-demo.cmyr.ltd/

Expand All @@ -41,6 +43,18 @@ https://rss-demo.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 源没有提供 `enclosure.length` 的问题
- Webhook 支持 GET/POST 等全部 HTTP 方法进行调用
- 下载 Hook 支持按 md5 过滤资源,支持按后缀名过滤资源。
- AI Hook 支持调用 OpenAI(或兼容 OpenAI 接口)的大模型,支持 AI 总结。支持在 AI 总结后推送。
- 支持 自定义查询,并转换为 RSS 输出。
- 支持 Docker 一键部署
- 支持 Redis 缓存
- 支持 SQLite 作为数据库

## 📦 依赖要求

Expand All @@ -59,8 +73,10 @@ https://rss-demo.cmyr.ltd/
支持以下架构:

- `linux/amd64`
- `linux/arm/v7`
- `linux/arm64`
- ~~`linux/arm/v7`~~
- ~~`linux/arm64`~~

> linux/arm/v7 和 linux/arm64 尚未进行测试
有以下几种 tags:

Expand Down

0 comments on commit 914f2d4

Please sign in to comment.