Rss-Bridge/README.md
Teromene fbf874cb29
Update README.md
Remove allow_url_fopen requirement. This should no longer be necessary. Added requirement for curl.
2018-07-16 12:37:09 +02:00

7 KiB

rss-bridge

LICENSE Build Status

rss-bridge is a PHP project capable of generating ATOM feeds for websites which don't have one.

Supported sites/pages (main)

  • Bandcamp : Returns last release from bandcamp for a tag
  • 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
  • FlickrExplore : Latest interesting images from Flickr
  • GooglePlus : Most recent posts of user timeline
  • 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
  • OpenClassrooms: Lastest tutorials from fr.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

Plus many other bridges to enable, thanks to the community

Output format

Output format can take several forms:

  • Atom : ATOM Feed, for use in RSS/Feed readers
  • Html : Simple html page.
  • Json : Json, for consumption by other applications.
  • Mrss : MRSS Feed, for use in RSS/Feed readers
  • Plaintext : raw text (php object, as returned by print_r)

Screenshot

Welcome screen:

Screenshot

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

Screenshot

Requirements

  • PHP 5.6, e.g. AddHandler application/x-httpd-php56 .php in .htaccess
  • openssl extension enabled in PHP config (php.ini)
  • curl extension enabled in PHP config (php.ini)

Enabling/Disabling bridges

By default, the script creates whitelist.txt and adds the main bridges (see above). whitelist.txt is ignored by git, you can edit it:

  • to enable extra bridges (one bridge per line)
  • to disable main bridges (remove the line)
  • to enable all bridges (just one wildcard * as file content)

New bridges are disabled by default, so make sure to check regularly what's new and whitelist what you want!

Deploy

Deploy on Scalingo

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.

Patch/contributors :

Licenses

Code is Public Domain.

Including PHP Simple HTML DOM Parser under the MIT License

Technical notes

  • There is a cache so that source services won't ban you even if you hammer the rss-bridge with requests. Each bridge can have a different duration for the cache. The cache subdirectory will be automatically created and cached objects older than 24 hours get purged.
  • To implement a new Bridge, follow the specifications and take a look at existing Bridges for examples.
  • To enable debug mode (disabling cache and enabling error reporting), create an empty file named DEBUG in the root directory (next to index.php).
  • For more information refer to 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 wilfully destroyed.

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