Skip to content

Latest commit

 

History

History
344 lines (299 loc) · 16.7 KB

README.md

File metadata and controls

344 lines (299 loc) · 16.7 KB
Raw

RSS-Bridge

LICENSE GitHub release irc.libera.chat Chat on Matrix Actions Status Docker Build Status

RSS-Bridge is a PHP project capable of generating RSS and Atom feeds for websites that don't have one. It can be used on webservers or as a stand-alone application in CLI mode.

Important: RSS-Bridge is not a feed reader or feed aggregator, but a tool to generate feeds that are consumed by feed readers and feed aggregators. Find a list of feed aggregators on Wikipedia.

Supported sites/pages (examples)

  • Bandcamp : Returns last release from bandcamp for a tag PROUT
  • Cryptome : Returns the most recent documents from Cryptome.org
  • DansTonChat: Most recent quotes from danstonchat.com
  • DuckDuckGo: Most recent results from DuckDuckGo.com
  • Facebook : Returns the latest posts on a page or profile on Facebook (There is an issue for public instances)
  • FlickrExplore : Latest interesting images from Flickr
  • GoogleSearch : Most recent results from Google Search
  • Identi.ca : Identica user timeline (Should be compatible with other Pump.io instances)
  • Instagram: Most recent photos from an Instagram user (It is recommended to configure this bridge to work)
  • OpenClassrooms: Lastest tutorials from openclassrooms.com
  • Pinterest: Most recent photos from user or search
  • ScmbBridge: Newest stories from secouchermoinsbete.fr
  • ThePirateBay : Returns the newest indexed torrents from The Pirate Bay with keywords
  • Twitter : Return keyword/hashtag search or user timeline
  • Wikipedia: highlighted articles from Wikipedia in English, German, French or Esperanto
  • YouTube : YouTube user channel, playlist or search

And many more, thanks to the community!

Output format

RSS-Bridge is capable of producing several output formats:

  • Atom : Atom feed, for use in feed readers
  • Html : Simple HTML page
  • Json : JSON, for consumption by other applications
  • Mrss : MRSS feed, for use in feed readers
  • Plaintext : Raw text, for consumption by other applications

You can extend RSS-Bridge with your own format, using the Format API!

Screenshot

Welcome screen:

Screenshot

RSS-Bridge hashtag (#rss-bridge) search on Twitter, in Atom format (as displayed by Firefox):

Screenshot

Requirements

RSS-Bridge requires PHP 7.1 or higher with following extensions enabled:

Find more information on our Documentation

Enable / Disable bridges

RSS-Bridge allows you to take full control over which bridges are displayed to the user. That way you can host your own RSS-Bridge service with your favorite collection of bridges!

Find more information on the Documentation

Notice: By default, RSS-Bridge will only show a small subset of bridges. Make sure to read up on whitelisting to unlock the full potential of RSS-Bridge!

Deploy

Thanks to the community, hosting your own instance of RSS-Bridge is as easy as clicking a button! Note: External providers' applications are packaged by 3rd parties. Use at your own discretion.

Deploy on Scalingo Deploy to Heroku Deploy to Cloudron

Getting involved

There are many ways for you to getting involved with RSS-Bridge. Here are a few things:

  • Share RSS-Bridge with your friends (Twitter, Facebook, ...you name it...)
  • Report broken bridges or bugs by opening Issues on GitHub
  • Request new features or suggest ideas (via Issues)
  • Discuss bugs, features, ideas or issues
  • Add new bridges or improve the API
  • Improve the Documentation
  • Host an instance of RSS-Bridge for your personal use or make it available to the community 💖

Authors

We are RSS-Bridge community, a group of developers continuing the project initiated by sebsauvage, webmaster of sebsauvage.net, author of Shaarli and ZeroBin.

Contributors (sorted alphabetically):

Licenses

The source code for RSS-Bridge is Public Domain.

RSS-Bridge uses third party libraries with their own license:

Technical notes

  • RSS-Bridge uses caching to prevent services from banning your server for repeatedly updating feeds. The specific cache duration can be different between bridges. Cached files are deleted automatically after 24 hours.
  • You can implement your own bridge, following these instructions.
  • You can enable debug mode to disable caching. Find more information on the Wiki

Rant

Dear so-called "social" websites.

Your 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.

You'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.

We 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.

We are rebuilding bridges you have willfully destroyed.

Get your shit together: Put RSS/Atom back in.