多功能的RSS工具RSS Funnel

什么是 RSS Funnel ?

RSS Funnel 是一个模块化的 RSS 处理管道系统。它可以以多种方式操作 RSS/Atom 源。

例如:

  • 提取完整内容
  • HTML 页面生成 RSS 订阅
  • 删除不需要的元素和文本
  • 使用正则表达式进行文字编辑或替换
  • 保留或删除与关键词或模式匹配的文章
  • 突出显示关键词
  • 将单个 RSS 文章拆分为多个文章
  • 将多个订阅合并为单个订阅
  • 运行 JavaScript 代码来转换订阅或文章
  • 在不同的订阅格式之间进行转换
  • 又有更多用法:https://github.com/shouya/rss-funnel/wiki/Filter-config

准备

RSS Funnel 是通过一个名为 funnel.yaml 的配置文件,来定义源和服务器设置的,原本老苏博客上的 RSS 源只提供了摘要而不是全文

下面是老苏准备的一个示例文件,可以提取到全文

1
2
3
4
5
6
7
endpoints:
- path: /laosu-blog.xml
note: 老苏的博客
source: https://laosu.tech/atom.xml
filters:
- full_text: {}
- simplify_html: {}
  • path:是访问地址,例如上面的写法,可以通过 http://群晖IP:端口/laosu-blog.xml 访问;
  • note:是简介,因为是中文,所以 funnel.yaml 保存时编码使用 UTF-8
  • source:是源地址;
  • filters:过滤器;
    • full_text:此过滤器从文章中获取文章的完整 HTMLlink并将其填充到content文章的字段中;
    • simplify_html:此过滤器利用readability 库简化了 HTML ;

更多filters 参数设置请参考官方文档:https://github.com/shouya/rss-funnel/wiki/Filter-config

安装

ghcr.io 镜像下载

官方的镜像没有发布在 docker hub,而是在 ghcr.io,所以直接用命令行来安装。

SSH 客户端中依次执行下面的命令

1
2
# 下载镜像
docker pull ghcr.io/shouya/rss-funnel:latest

如果没有科学上网,很可能会拉不动,可以试试 docker 代理网站:https://dockerproxy.com/,但是会多几个步骤

1
2
3
4
5
6
7
8
# 如果拉不动的话加个代理
docker pull ghcr.dockerproxy.com/shouya/rss-funnel:latest

# 重命名镜像(如果是通过代理下载的)
docker tag ghcr.dockerproxy.com/shouya/rss-funnel:latest ghcr.io/shouya/rss-funnel:latest

# 删除代理镜像(如果是通过代理下载的)
docker rmi ghcr.dockerproxy.com/shouya/rss-funnel:latest

当然代理网站也不是什么时候都好使,有时候也会报错,例如下面👇这样的

1
Error response from daemon: received unexpected HTTP status: 500 Internal Server Error

所以有一个稳定的科学上网环境还是很重要的

docker cli 安装

现在可以开始运行了

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# 新建文件夹 rss-funnel 和 子目录
mkdir -p /volume1/docker/rss-funnel

# 进入 rss-funnel 目录
cd /volume1/docker/rss-funnel

# 将 funnel.yaml 放入当前目录

# 运行容器
docker run -d \
--restart unless-stopped \
--name rss-funn \
-p 4090:4090 \
-v $(pwd)//funnel.yaml:/funnel.yaml \
-e RSS_FUNNEL_CONFIG=/funnel.yaml \
-e RSS_FUNNEL_BIND=0.0.0.0:4090 \
-e RSS_FUNNEL_WATCH=true \
ghcr.io/shouya/rss-funnel:latest

目前项目支持的环境变量如下:

可变 默认值 描述
RSS_FUNNEL_BIND 127.0.0.1:4080 服务器绑定地址
RSS_FUNNEL_INSPECTOR_UI true 是否提供检查器 UI
RSS_FUNNEL_WATCH false 是否监视配置文件更改并自动重新加载
RSS_FUNNEL_CONFIG 未指定 配置文件的位置。

docker compose 安装

也可以用 docker-compose 安装,将下面的内容保存为 docker-compose.yml 文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
version: '3'

services:
rss-funne:
image: ghcr.io/shouya/rss-funnel:latest
container_name: rss-funne
restart: unless-stopped
ports:
- 4090:4090
volumes:
- ./funnel.yaml:/funnel.yaml
environment:
- RSS_FUNNEL_CONFIG=/funnel.yaml
- RSS_FUNNEL_BIND=0.0.0.0:4090
- RSS_FUNNEL_WATCH=true

然后执行下面的命令

1
2
3
4
5
6
7
8
9
10
# 新建文件夹 rss-funnel 和 子目录
mkdir -p /volume1/docker/rss-funnel

# 进入 rss-funnel 目录
cd /volume1/docker/rss-funnel

# 将 funnel.yaml 和 docker-compose.yml 放入当前目录

# 一键启动
docker-compose up -d

运行

在浏览器中输入 http://群晖IP:4090 就能看到主界面

点击链接可以看到每篇文章都是显示的全文

切换到 Raw 模式

访问 http://群晖IP:4090/laosu-blog.xml

虽然中文都显示为乱码

但不影响在 FreshRSS 中订阅

参考文档

shouya/rss-funnel: An RSS multi-tool
地址:https://github.com/shouya/rss-funnel

RSS Funnel Inspector
地址:https://rss-funnel-demo.fly.dev