RSS-Bridge

RSS-Bridge是一个PHP网络应用程序。

它为没有网络订阅源的网站生成订阅源。

或者寻找其他公共实例。

最低要求PHP 7.4。

部分桥接器（16/447）

CssSelectorBridge：使用CSS选择器抓取订阅源
FeedMergeBridge：将多个订阅源合并为一个
FeedReducerBridge：按一定百分比减少嘈杂的订阅源
FilterBridge：通过关键词排除/包含项目来过滤订阅源
GettrBridge：获取GETTR用户的最新帖子
MastodonBridge：从Mastodon（ActivityPub）实例获取状态
RedditBridge：获取用户/子版块的帖子（带过滤选项）
RumbleBridge：获取频道/用户视频
SoundcloudBridge：通过用户名获取音乐
TelegramBridge：获取公共频道的帖子
ThePirateBayBridge：通过搜索/用户/分类获取种子
TikTokBridge：通过用户名获取帖子
TwitchBridge：获取频道的视频
VkBridge：获取用户/群组的帖子
XPathBridge：使用XPath表达式抓取订阅源
YoutubeBridge：通过用户名/频道/播放列表/搜索获取视频
YouTubeCommunityTabBridge：获取频道社区标签的帖子

教程

如何在传统共享Web主机上安装

RSS-Bridge基本上可以解压到Web文件夹中。应该可以立即工作。

如何在Debian 12上安装（nginx + php-fpm）

这些说明已在Digital Ocean的全新Debian 12虚拟机上测试过（1vcpu-512mb-10gb，每月5美元）。

timedatectl set-timezone Europe/Oslo

apt install git nginx php8.2-fpm php-mbstring php-simplexml php-curl php-intl

# 创建用户账户
useradd --shell /bin/bash --create-home rss-bridge

cd /var/www

# 创建文件夹并更改所有权
mkdir rss-bridge && chown rss-bridge:rss-bridge rss-bridge/

# 切换用户
su rss-bridge

# 获取最新的master分支
git clone https://github.com/RSS-Bridge/rss-bridge.git rss-bridge/
cd rss-bridge

# 复制默认配置
cp -v config.default.ini.php config.ini.php

# 仅给所有者（rss-bridge）完全权限
chmod 700 -R ./
# 给其他用户(nginx和php-fpm)添加读和执行权限
chmod o+rx ./ ./static

# 给其他用户(nginx)添加读权限
chmod o+r -R ./static

Nginx配置:

# /etc/nginx/sites-enabled/rss-bridge.conf

server {
    listen 80;

    # TODO: 修改为你自己的服务器名
    server_name example.com;

    access_log /var/log/nginx/rss-bridge.access.log;
    error_log /var/log/nginx/rss-bridge.error.log;
    log_not_found off;

    # 此处故意不设置根目录

    # autoindex默认是关闭的,但显式关闭感觉更好
    autoindex off;

    # 只在此处提供静态内容
    location /static/ {
        alias /var/www/rss-bridge/static/;
    }

    # 当location精确匹配/时,传递给php-fpm
    location = / {
        root /var/www/rss-bridge/;
        include snippets/fastcgi-php.conf;
        fastcgi_read_timeout 45s;
        fastcgi_pass unix:/run/php/rss-bridge.sock;
    }

    # 减少垃圾请求
    location = /favicon.ico {
        access_log off;
    }

    # 减少垃圾请求
    location = /robots.txt {
        access_log off;
    }
}

PHP FPM池配置:

; /etc/php/8.2/fpm/pool.d/rss-bridge.conf

[rss-bridge]

user = rss-bridge
group = rss-bridge

listen = /run/php/rss-bridge.sock

listen.owner = www-data
listen.group = www-data

# 创建10个待命的工作进程来处理请求
pm = static
pm.max_children = 10

# 每个工作进程处理500个请求后重新生成(解决内存泄漏等问题)
pm.max_requests = 500

PHP ini配置:

; /etc/php/8.2/fpm/conf.d/30-rss-bridge.ini

max_execution_time = 15
memory_limit = 64M

重启fpm和nginx:

# 检查并重启php-fpm
php-fpm8.2 -t && systemctl restart php8.2-fpm

# 检查并重启nginx
nginx -t && systemctl restart nginx

如何通过Composer安装

安装最新版本。

cd /var/www
composer create-project -v --no-dev --no-scripts rss-bridge/rss-bridge

如何使用Caddy安装

待完成。参见 https://github.com/RSS-Bridge/rss-bridge/issues/3785

从Docker Hub安装:

通过从Docker Hub下载docker镜像来安装:

# 创建容器
docker create --name=rss-bridge --publish 3000:80 --volume $(pwd)/config:/config rssbridge/rss-bridge

你可以将自定义的config.ini.php和bridges放入./config。

必须重启容器才能使自定义更改生效。

详情请参阅docker-entrypoint.sh。

# 启动容器
docker start rss-bridge

浏览 http://localhost:3000/

通过本地构建Dockerfile安装

# 从Dockerfile构建镜像
docker build -t rss-bridge .

# 创建容器
docker create --name rss-bridge --publish 3000:80 --volume $(pwd)/config:/config rss-bridge

你可以将自定义的config.ini.php和bridges放入./config。

必须重启容器才能使自定义更改生效。

详情请参阅docker-entrypoint.sh。

# 启动容器
docker start rss-bridge

浏览 http://localhost:3000/

使用docker-compose安装(使用Docker Hub)

你可以将自定义的config.ini.php和bridges放入./config。

必须重启容器才能使自定义更改生效。

详情请参阅docker-entrypoint.sh。

docker-compose up

浏览 http://localhost:3000/

其他安装方法

Heroku快速部署目前不可用。如果你fork这个仓库并修改scalingo.json中的repository，它可能会工作。参见 https://github.com/RSS-Bridge/rss-bridge/issues/2688

在安装中了解更多。

操作指南

如何修复"拒绝访问。"

输出来自php-fpm。它无法读取index.php。

chown rss-bridge:rss-bridge /var/www/rss-bridge/index.php

如何密码保护实例(令牌)

修改config.ini.php:

[authentication]

token = "hunter2"

如何删除所有缓存项

作为当前用户:

bin/cache-clear

作为rss-bridge用户:

sudo -u rss-bridge bin/cache-clear

作为root:

sudo bin/cache-clear

如何删除所有过期的缓存项

bin/cache-prune

如何修复"PHP致命错误: 未捕获的异常: FileCache路径不可写"

# 给rss-bridge所有权
chown rss-bridge:rss-bridge -R /var/www/rss-bridge/cache

# 或者,给www-data所有权
chown www-data:www-data -R /var/www/rss-bridge/cache

# 或者,给所有人写权限
chmod 777 -R /var/www/rss-bridge/cache

# 或最后的努力(小心)
rm -rf /var/www/rss-bridge/cache/ && mkdir /var/www/rss-bridge/cache/

如何修复"尝试写入只读数据库"

sqlite文件(db、wal和shm)不可写。 chown -v rss-bridge:rss-bridge cache/*

如何修复"Unable to prepare statement: 1, no such table: storage"错误

rm cache/*

如何从头开始创建新的bridge

在 bridges/BearBlogBridge.php 中创建新的bridge:

<?php

class BearBlogBridge extends BridgeAbstract
{
    const NAME = 'BearBlog (bearblog.dev)';

    public function collectData()
    {
        $dom = getSimpleHTMLDOM('https://herman.bearblog.dev/blog/');
        foreach ($dom->find('.blog-posts li') as $li) {
            $a = $li->find('a', 0);
            $this->items[] = [
                'title' => $a->plaintext,
                'uri' => 'https://herman.bearblog.dev' . $a->href,
            ];
        }
    }
}

在bridge api中了解更多信息。

如何启用所有bridge

enabled_bridges[] = *

如何启用某些bridge

enabled_bridges[] = TwitchBridge
enabled_bridges[] = GettrBridge

如何启用调试模式

调试模式禁用了大部分缓存操作。

enable_debug_mode = true

如何切换到memcached作为缓存后端

[cache]

; 缓存后端: file (默认), sqlite, memcached, null
type = "memcached"

如何切换到sqlite3作为缓存后端

type = "sqlite"

如何禁用bridge错误（作为feed项目）

当bridge失败时，RSS-Bridge会生成一个包含单个项目的feed来描述错误。

这样，feed阅读器就能捕获到并通知你。

如果你不想要这种行为，可以将错误输出切换为 http:

[error]

; 定义RSS-Bridge如何返回错误信息
;
; "feed" = 作为feed的一部分（默认）
; "http" = 作为HTTP错误信息
; "none" = 不报告错误
output = "http"

如何累积错误后再最终报告

修改 report_limit 使得错误必须发生3次后才报告。

; 定义错误必须发生多少次才向用户报告
report_limit = 3

报告计数每天重置为0。

如何为实例设置密码保护（HTTP基本认证）

[authentication]

enable = true
username = "alice"
password = "cat"

通常需要用凭据配置feed阅读器。

也可以手动在URL中包含凭据：

https://alice:cat@rss-bridge.org/bridge01/?action=display&bridge=FabriceBellardBridge&format=Html

如何创建新的输出格式

参见 formats/PlaintextFormat.php 的示例。

如何运行单元测试和代码检查

这些命令需要你已安装 composer.json 中的开发依赖。

运行所有测试：

./vendor/bin/phpunit

运行单个测试类：

./vendor/bin/phpunit --filter UrlTest

运行代码检查：

./vendor/bin/phpcs --standard=phpcs.xml --warning-severity=0 --extensions=php -p ./

https://github.com/squizlabs/PHP_CodeSniffer/wiki

如何创建最小开发环境

php -S 127.0.0.1:9001

http://127.0.0.1:9001/

说明

我们是RSS-Bridge社区，一群开发者继续sebsauvage发起的项目， sebsauvage是sebsauvage.net的站长， Shaarli和 ZeroBin的作者。

参见CONTRIBUTORS.md

RSS-Bridge使用缓存来防止服务因反复更新feed而封禁你的服务器。不同bridge之间的具体缓存时间可能不同。缓存文件在24小时后自动删除。

RSS-Bridge允许你完全控制向用户显示哪些bridge。这样你就可以用自己喜欢的bridge集合托管自己的RSS-Bridge服务！

当前维护者（截至2024年）：@dvikan 和 @Mynacol #2519

参考

Feed项目结构

这是bridge预期生成的feed项目结构。

    $item = [
        'uri' => 'https://example.com/blog/hello',
        'title' => 'Hello world',
        // 以unix时间戳表示的发布日期
        'timestamp' => 1668706254,
        'author' => 'Alice',
        'content' => 'Here be item content',
        'enclosures' => [
            'https://example.com/foo.png',
            'https://example.com/bar.png'
        ],
        'categories' => [
            'news',
            'tech',
        ],
        // 全局唯一ID
        'uid' => 'e7147580c8747aad',
    ]