{"id":13405115,"url":"https://github.com/RSS-Bridge/rss-bridge","last_synced_at":"2025-03-14T09:32:21.399Z","repository":{"id":9923640,"uuid":"11935508","full_name":"RSS-Bridge/rss-bridge","owner":"RSS-Bridge","description":"The RSS feed for websites missing it","archived":false,"fork":false,"pushed_at":"2024-05-19T15:48:30.000Z","size":14355,"stargazers_count":6914,"open_issues_count":190,"forks_count":1016,"subscribers_count":122,"default_branch":"master","last_synced_at":"2024-05-21T13:17:09.688Z","etag":null,"topics":["atom-feed","hacktoberfest","json-feed","php","rss","rss-bridge","rss-feed","unlicense"],"latest_commit_sha":null,"homepage":"https://rss-bridge.org/bridge01/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RSS-Bridge.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-08-06T21:55:13.000Z","updated_at":"2024-05-27T22:03:28.098Z","dependencies_parsed_at":"2024-05-27T22:03:24.923Z","dependency_job_id":null,"html_url":"https://github.com/RSS-Bridge/rss-bridge","commit_stats":{"total_commits":3568,"total_committers":337,"mean_commits":10.58753709198813,"dds":0.843890134529148,"last_synced_commit":"5a68ee0c87bc2392886efd411511e094ae4fe5ac"},"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RSS-Bridge%2Frss-bridge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RSS-Bridge%2Frss-bridge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RSS-Bridge%2Frss-bridge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RSS-Bridge%2Frss-bridge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RSS-Bridge","download_url":"https://codeload.github.com/RSS-Bridge/rss-bridge/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221454073,"owners_count":16824598,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["atom-feed","hacktoberfest","json-feed","php","rss","rss-bridge","rss-feed","unlicense"],"created_at":"2024-07-30T19:01:55.954Z","updated_at":"2025-03-14T09:32:21.388Z","avatar_url":"https://github.com/RSS-Bridge.png","language":"PHP","readme":"# RSS-Bridge\n\n![RSS-Bridge](static/logo_600px.png)\n\nRSS-Bridge is a PHP web application.\n\nIt generates web feeds for websites that don't have one.\n\nOfficially hosted instance: https://rss-bridge.org/bridge01/\n\nIRC channel #rssbridge at https://libera.chat/\n\n[Full documentation](https://rss-bridge.github.io/rss-bridge/index.html)\n\nAlternatively find another\n[public instance](https://rss-bridge.github.io/rss-bridge/General/Public_Hosts.html).\n\nRequires minimum PHP 7.4.\n\n\n[![LICENSE](https://img.shields.io/badge/license-UNLICENSE-blue.svg)](UNLICENSE)\n[![GitHub release](https://img.shields.io/github/release/rss-bridge/rss-bridge.svg?logo=github)](https://github.com/rss-bridge/rss-bridge/releases/latest)\n[![irc.libera.chat](https://img.shields.io/badge/irc.libera.chat-%23rssbridge-blue.svg)](https://web.libera.chat/#rssbridge)\n[![Actions Status](https://img.shields.io/github/actions/workflow/status/RSS-Bridge/rss-bridge/tests.yml?branch=master\u0026label=GitHub%20Actions\u0026logo=github)](https://github.com/RSS-Bridge/rss-bridge/actions)\n\n|||\n|:-:|:-:|\n|![Screenshot #1](/static/screenshot-1.png?raw=true)|![Screenshot #2](/static/screenshot-2.png?raw=true)|\n|![Screenshot #3](/static/screenshot-3.png?raw=true)|![Screenshot #4](/static/screenshot-4.png?raw=true)|\n|![Screenshot #5](/static/screenshot-5.png?raw=true)|![Screenshot #6](/static/screenshot-6.png?raw=true)|\n\n## A subset of bridges (15/447)\n\n* `CssSelectorBridge`: [Scrape out a feed using CSS selectors](https://rss-bridge.org/bridge01/#bridge-CssSelectorBridge)\n* `FeedMergeBridge`: [Combine multiple feeds into one](https://rss-bridge.org/bridge01/#bridge-FeedMergeBridge)\n* `FeedReducerBridge`: [Reduce a noisy feed by some percentage](https://rss-bridge.org/bridge01/#bridge-FeedReducerBridge)\n* `FilterBridge`: [Filter a feed by excluding/including items by keyword](https://rss-bridge.org/bridge01/#bridge-FilterBridge)\n* `GettrBridge`: [Fetches the latest posts from a GETTR user](https://rss-bridge.org/bridge01/#bridge-GettrBridge)\n* `MastodonBridge`: [Fetches statuses from a Mastodon (ActivityPub) instance](https://rss-bridge.org/bridge01/#bridge-MastodonBridge)\n* `RedditBridge`: [Fetches posts from a user/subredit (with filtering options)](https://rss-bridge.org/bridge01/#bridge-RedditBridge)\n* `RumbleBridge`: [Fetches channel/user videos](https://rss-bridge.org/bridge01/#bridge-RumbleBridge)\n* `SoundcloudBridge`: [Fetches music by username](https://rss-bridge.org/bridge01/#bridge-SoundcloudBridge)\n* `TelegramBridge`: [Fetches posts from a public channel](https://rss-bridge.org/bridge01/#bridge-TelegramBridge)\n* `ThePirateBayBridge:` [Fetches torrents by search/user/category](https://rss-bridge.org/bridge01/#bridge-ThePirateBayBridge)\n* `TikTokBridge`: [Fetches posts by username](https://rss-bridge.org/bridge01/#bridge-TikTokBridge)\n* `TwitchBridge`: [Fetches videos from channel](https://rss-bridge.org/bridge01/#bridge-TwitchBridge)\n* `XPathBridge`: [Scrape out a feed using XPath expressions](https://rss-bridge.org/bridge01/#bridge-XPathBridge)\n* `YoutubeBridge`: [Fetches videos by username/channel/playlist/search](https://rss-bridge.org/bridge01/#bridge-YoutubeBridge)\n* `YouTubeCommunityTabBridge`: [Fetches posts from a channel's community tab](https://rss-bridge.org/bridge01/#bridge-YouTubeCommunityTabBridge)\n\n## Tutorial\n\n### How to install on traditional shared web hosting\n\nRSS-Bridge can basically be unzipped into a web folder. Should be working instantly.\n\nLatest zip:\nhttps://github.com/RSS-Bridge/rss-bridge/archive/refs/heads/master.zip (2MB)\n\n### How to install on Debian 12 (nginx + php-fpm)\n\nThese instructions have been tested on a fresh Debian 12 VM from Digital Ocean (1vcpu-512mb-10gb, 5 USD/month).\n\n```shell\ntimedatectl set-timezone Europe/Oslo\n\napt install git nginx php8.2-fpm php-mbstring php-simplexml php-curl php-intl\n\n# Create a user account\nuseradd --shell /bin/bash --create-home rss-bridge\n\ncd /var/www\n\n# Create folder and change its ownership to rss-bridge\nmkdir rss-bridge \u0026\u0026 chown rss-bridge:rss-bridge rss-bridge/\n\n# Become rss-bridge\nsu rss-bridge\n\n# Clone master branch into existing folder\ngit clone https://github.com/RSS-Bridge/rss-bridge.git rss-bridge/\ncd rss-bridge\n\n# Copy over the default config (OPTIONAL)\ncp -v config.default.ini.php config.ini.php\n\n# Recursively give full permissions to user/owner\nchmod 700 --recursive ./\n\n# Give read and execute to others on folder ./static\nchmod o+rx ./ ./static\n\n# Recursively give give read to others on folder ./static\nchmod o+r --recursive ./static\n```\n\nNginx config:\n\n```nginx\n# /etc/nginx/sites-enabled/rss-bridge.conf\n\nserver {\n    listen 80;\n\n    # TODO: change to your own server name\n    server_name example.com;\n\n    access_log /var/log/nginx/rss-bridge.access.log;\n    error_log /var/log/nginx/rss-bridge.error.log;\n    log_not_found off;\n\n    # Intentionally not setting a root folder\n\n    # Static content only served here\n    location /static/ {\n        alias /var/www/rss-bridge/static/;\n    }\n\n    # Pass off to php-fpm only when location is EXACTLY == /\n    location = / {\n        root /var/www/rss-bridge/;\n        include snippets/fastcgi-php.conf;\n        fastcgi_read_timeout 45s;\n        fastcgi_pass unix:/run/php/rss-bridge.sock;\n    }\n\n    # Reduce log noise\n    location = /favicon.ico {\n        access_log off;\n    }\n\n    # Reduce log noise\n    location = /robots.txt {\n        access_log off;\n    }\n}\n```\n\nPHP FPM pool config:\n```ini\n; /etc/php/8.2/fpm/pool.d/rss-bridge.conf\n\n[rss-bridge]\n\nuser = rss-bridge\ngroup = rss-bridge\n\nlisten = /run/php/rss-bridge.sock\n\nlisten.owner = www-data\nlisten.group = www-data\n\n; Create 10 workers standing by to serve requests\npm = static\npm.max_children = 10\n\n; Respawn worker after 500 requests (workaround for memory leaks etc.)\npm.max_requests = 500\n```\n\nPHP ini config:\n```ini\n; /etc/php/8.2/fpm/conf.d/30-rss-bridge.ini\n\nmax_execution_time = 15\nmemory_limit = 64M\n```\n\nRestart fpm and nginx:\n\n```shell\n# Lint and restart php-fpm\nphp-fpm8.2 -t \u0026\u0026 systemctl restart php8.2-fpm\n\n# Lint and restart nginx\nnginx -t \u0026\u0026 systemctl restart nginx\n```\n\n### How to install from Composer\n\nInstall the latest release.\n\n```shell\ncd /var/www\ncomposer create-project -v --no-dev --no-scripts rss-bridge/rss-bridge\n```\n\n### How to install with Caddy\n\nTODO. See https://github.com/RSS-Bridge/rss-bridge/issues/3785\n\n### Install from Docker Hub:\n\nInstall by downloading the docker image from Docker Hub:\n\n```bash\n# Create container\ndocker create --name=rss-bridge --publish 3000:80 --volume $(pwd)/config:/config rssbridge/rss-bridge\n```\n\nYou can put custom `config.ini.php` and bridges into `./config`.\n\n**You must restart container for custom changes to take effect.**\n\nSee `docker-entrypoint.sh` for details.\n\n```bash\n# Start container\ndocker start rss-bridge\n```\n\nBrowse http://localhost:3000/\n\n### Install by locally building from Dockerfile\n\n```bash\n# Build image from Dockerfile\ndocker build -t rss-bridge .\n\n# Create container\ndocker create --name rss-bridge --publish 3000:80 --volume $(pwd)/config:/config rss-bridge\n```\n\nYou can put custom `config.ini.php` and bridges into `./config`.\n\n**You must restart container for custom changes to take effect.**\n\nSee `docker-entrypoint.sh` for details.\n\n```bash\n# Start container\ndocker start rss-bridge\n```\n\nBrowse http://localhost:3000/\n\n### Install with docker-compose (using Docker Hub)\n\nYou can put custom `config.ini.php` and bridges into `./config`.\n\n**You must restart container for custom changes to take effect.**\n\nSee `docker-entrypoint.sh` for details.\n\n```bash\ndocker-compose up\n```\n\nBrowse http://localhost:3000/\n\n### Other installation methods\n\n[![Deploy on Scalingo](https://cdn.scalingo.com/deploy/button.svg)](https://my.scalingo.com/deploy?source=https://github.com/sebsauvage/rss-bridge)\n[![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)\n[![Deploy to Cloudron](https://cloudron.io/img/button.svg)](https://www.cloudron.io/store/com.rssbridgeapp.cloudronapp.html)\n[![Run on PikaPods](https://www.pikapods.com/static/run-button.svg)](https://www.pikapods.com/pods?run=rssbridge)\n\nThe Heroku quick deploy currently does not work. It might work if you fork this repo and\nmodify the `repository` in `scalingo.json`. See https://github.com/RSS-Bridge/rss-bridge/issues/2688\n\nLearn more in\n[Installation](https://rss-bridge.github.io/rss-bridge/For_Hosts/Installation.html).\n\n## How-to\n\n### How to fix \"Access denied.\"\n\nOutput is from php-fpm. It is unable to read index.php.\n\n    chown rss-bridge:rss-bridge /var/www/rss-bridge/index.php\n\n### How to password-protect the instance (token)\n\nModify `config.ini.php`:\n\n    [authentication]\n\n    token = \"hunter2\"\n\n### How to remove all cache items\n\nAs current user:\n\n    bin/cache-clear\n\nAs user rss-bridge:\n\n    sudo -u rss-bridge bin/cache-clear\n\nAs root:\n\n    sudo bin/cache-clear\n\n### How to remove all expired cache items\n\n    bin/cache-prune\n\n### How to fix \"PHP Fatal error:  Uncaught Exception: The FileCache path is not writable\"\n\n```shell\n# Give rss-bridge ownership\nchown rss-bridge:rss-bridge -R /var/www/rss-bridge/cache\n\n# Or, give www-data ownership\nchown www-data:www-data -R /var/www/rss-bridge/cache\n\n# Or, give everyone write permission\nchmod 777 -R /var/www/rss-bridge/cache\n\n# Or last ditch effort (CAREFUL)\nrm -rf /var/www/rss-bridge/cache/ \u0026\u0026 mkdir /var/www/rss-bridge/cache/\n```\n\n### How to fix \"attempt to write a readonly database\"\n\nThe sqlite files (db, wal and shm) are not writeable.\n\n    chown -v rss-bridge:rss-bridge cache/*\n\n### How to fix \"Unable to prepare statement: 1, no such table: storage\"\n\n    rm cache/*\n\n### How to create a new bridge from scratch\n\nCreate the new bridge in e.g. `bridges/BearBlogBridge.php`:\n\n```php\n\u003c?php\n\nclass BearBlogBridge extends BridgeAbstract\n{\n    const NAME = 'BearBlog (bearblog.dev)';\n\n    public function collectData()\n    {\n        $dom = getSimpleHTMLDOM('https://herman.bearblog.dev/blog/');\n        foreach ($dom-\u003efind('.blog-posts li') as $li) {\n            $a = $li-\u003efind('a', 0);\n            $this-\u003eitems[] = [\n                'title' =\u003e $a-\u003eplaintext,\n                'uri' =\u003e 'https://herman.bearblog.dev' . $a-\u003ehref,\n            ];\n        }\n    }\n}\n```\n\nLearn more in [bridge api](https://rss-bridge.github.io/rss-bridge/Bridge_API/index.html).\n\n### How to enable all bridges\n\n    enabled_bridges[] = *\n\n### How to enable some bridges\n\n```\nenabled_bridges[] = TwitchBridge\nenabled_bridges[] = GettrBridge\n```\n\n### How to enable debug mode\n\nThe \n[debug mode](https://rss-bridge.github.io/rss-bridge/For_Developers/Debug_mode.html)\ndisables the majority of caching operations.\n\n    enable_debug_mode = true\n\n### How to switch to memcached as cache backend\n\n```\n[cache]\n\n; Cache backend: file (default), sqlite, memcached, null\ntype = \"memcached\"\n```\n\n### How to switch to sqlite3 as cache backend\n\n    type = \"sqlite\"\n\n### How to disable bridge errors (as feed items)\n\nWhen a bridge fails, RSS-Bridge will produce a feed with a single item describing the error.\n\nThis way, feed readers pick it up and you are notified.\n\nIf you don't want this behaviour, switch the error output to `http`:\n\n    [error]\n\n    ; Defines how error messages are returned by RSS-Bridge\n    ;\n    ; \"feed\" = As part of the feed (default)\n    ; \"http\" = As HTTP error message\n    ; \"none\" = No errors are reported\n    output = \"http\"\n\n### How to accumulate errors before finally reporting it\n\nModify `report_limit` so that an error must occur 3 times before it is reported.\n\n    ; Defines how often an error must occur before it is reported to the user\n    report_limit = 3\n\nThe report count is reset to 0 each day.\n\n### How to password-protect the instance (HTTP Basic Auth)\n\n    [authentication]\n\n    enable = true\n    username = \"alice\"\n    password = \"cat\"\n\nWill typically require feed readers to be configured with the credentials.\n\nIt may also be possible to manually include the credentials in the URL:\n\nhttps://alice:cat@rss-bridge.org/bridge01/?action=display\u0026bridge=FabriceBellardBridge\u0026format=Html\n\n### How to create a new output format\n\nSee `formats/PlaintextFormat.php` for an example.\n\n### How to run unit tests and linter\n\nThese commands require that you have installed the dev dependencies in `composer.json`.\n\nRun all tests:\n\n    ./vendor/bin/phpunit\n\nRun a single test class:\n\n    ./vendor/bin/phpunit --filter UrlTest\n\nRun linter:\n\n    ./vendor/bin/phpcs --standard=phpcs.xml --warning-severity=0 --extensions=php -p ./\n\nhttps://github.com/squizlabs/PHP_CodeSniffer/wiki\n\n### How to spawn a minimal development environment\n\n    php -S 127.0.0.1:9001\n\nhttp://127.0.0.1:9001/\n\n## Explanation\n\nWe are RSS-Bridge community, a group of developers continuing the project initiated by sebsauvage,\nwebmaster of\n[sebsauvage.net](https://sebsauvage.net), author of\n[Shaarli](https://sebsauvage.net/wiki/doku.php?id=php:shaarli) and\n[ZeroBin](https://sebsauvage.net/wiki/doku.php?id=php:zerobin).\n\nSee [CONTRIBUTORS.md](CONTRIBUTORS.md)\n\nRSS-Bridge uses caching to prevent services from banning your server for repeatedly updating feeds.\nThe specific cache duration can be different between bridges.\n\nRSS-Bridge allows you to take full control over which bridges are displayed to the user.\nThat way you can host your own RSS-Bridge service with your favorite collection of bridges!\n\nCurrent maintainers (as of 2024): @dvikan and @Mynacol #2519\n\n## Reference\n\n### Feed item structure\n\nThis is the feed item structure that bridges are expected to produce.\n\n```php\n    $item = [\n        'uri' =\u003e 'https://example.com/blog/hello',\n        'title' =\u003e 'Hello world',\n        // Publication date in unix timestamp\n        'timestamp' =\u003e 1668706254,\n        'author' =\u003e 'Alice',\n        'content' =\u003e 'Here be item content',\n        'enclosures' =\u003e [\n            'https://example.com/foo.png',\n            'https://example.com/bar.png'\n        ],\n        'categories' =\u003e [\n            'news',\n            'tech',\n        ],\n        // Globally unique id\n        'uid' =\u003e 'e7147580c8747aad',\n    ]\n```\n\n### Output formats\n\n* `Atom`: Atom feed, for use in feed readers\n* `Html`: Simple HTML page\n* `Json`: JSON, for consumption by other applications\n* `Mrss`: MRSS feed, for use in feed readers\n* `Plaintext`: Raw text, for consumption by other applications\n* `Sfeed`: Text, TAB separated\n\n### Cache backends\n\n* `File`\n* `SQLite`\n* `Memcached`\n* `Array`\n* `Null`\n\n### Licenses\n\nThe source code for RSS-Bridge is [Public Domain](UNLICENSE).\n\nRSS-Bridge uses third party libraries with their own license:\n\n  * [`Parsedown`](https://github.com/erusev/parsedown) licensed under the [MIT License](https://opensource.org/licenses/MIT)\n  * [`PHP Simple HTML DOM Parser`](https://simplehtmldom.sourceforge.io/docs/1.9/index.html) licensed under the [MIT License](https://opensource.org/licenses/MIT)\n  * [`php-urljoin`](https://github.com/fluffy-critter/php-urljoin) licensed under the [MIT License](https://opensource.org/licenses/MIT)\n  * [`Laravel framework`](https://github.com/laravel/framework/) licensed under the [MIT License](https://opensource.org/licenses/MIT)\n\n## Rant\n\n*Dear so-called \"social\" websites.*\n\nYour catchword is \"share\", but you don't want us to share. You want to keep us within your walled gardens. That's why you've been removing RSS links from webpages, hiding them deep on your website, or removed feeds entirely, replacing it with crippled or demented proprietary API. **FUCK YOU.**\n\nYou're not social when you hamper sharing by removing feeds. You're happy to have customers creating content for your ecosystem, but you don't want this content out - a content you do not even own. Google Takeout is just a gimmick. We want our data to flow, we want RSS or Atom feeds.\n\nWe want to share with friends, using open protocols: RSS, Atom, XMPP, whatever. Because no one wants to have *your* service with *your* applications using *your* API force-feeding them. Friends must be free to choose whatever software and service they want.\n\nWe are rebuilding bridges you have willfully destroyed.\n\nGet your shit together: Put RSS/Atom back in.\n","funding_links":[],"categories":["PHP","Software","News, RSS Feed","Application Recommendation","hacktoberfest","Apps","类库","Apps deployable on Scalingo"],"sub_categories":["Feed Readers","Media Servers","🤖 Automation Tools","RSS","未归类","Apps deployed without adaptation"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRSS-Bridge%2Frss-bridge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FRSS-Bridge%2Frss-bridge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRSS-Bridge%2Frss-bridge/lists"}