plugins/RSSCloud/README

   1 This plugin enables RSSCloud (http://rsscloud.org/) publishing and subscription
   2 handling for RSS 2.0 profile feeds (i.e:
   3 http://SITE/PATH/api/statuses/user_timeline/USERNAME.rss). When the plugin is
   4 enabled, StatusNet acts as both the publisher and hub ('writer' and 'cloud' in
   5 RSSCloud parlance), but only for local StatusNet feeds. It's not possible to use
   6 it as a general purpose hub -- for instance you can't subscribe and get updates
   7 to a Wordpress feed from StatusNet using this plugin.
   8
   9 To use the plugin, add the following to your config.php:
  10
  11     addPlugin('RSSCloud');
  12
  13 Enabling the plugin will add a <cloud> element to your RSS 2.0 profile feeds
  14 that looks like this:
  15
  16     <cloud domain="SITE" port="80" path="/main/rsscloud/request_notify"
  17     registerProcedure="" protocol="http-post"/>
  18
  19 Aggregators may subscribe by sending a proper REST RSSCloud subscription request
  20 (the optional 'domain' parameter with challenge is supported). Subscribing
  21 aggregators will be notified ('pinged') when users they have subscribed to post
  22 new notices. Currently, REST is the only protocol supported for notifications.
  23
  24 Deamon
  25 ------
  26
  27 There's also a daemon for offline processing of queued notices with RSSCloud
  28 destinations, which will start automatically if/when you run
  29 scripts/startdaemons.sh.
  30
  31 Notes
  32 -----
  33
  34 - Again, only RSS 2.0 profile feeds may be subscribed to, and they have to be
  35   the ones with user names in them, like:
  36       http://SITE/PATH/api/statuses/user_timeline/USERNAME.rss
  37 - Subscriptions are deleted after three notification failures in a row (not sure
  38   this is optimal).
  39 - The plugin includes a dummy LoggingAggregator class that can be used for
  40   end-to-end testing.  You probably don't want to mess with it.
  41
  42 TODO
  43 ----
  44
  45 - Figure out why the RSSCloudSubcription can't ->delete() or ->update()
  46 - Support pinging via XML-RPC and SOAP
  47 - Automatically delete subscriptions? Point of reference: Dave's hub
  48   implementation auto-deletes them after 25 hours. WordPress never deletes them.
  49 - Support additional feed URL addresses for the same feed (e.g.: by numeric ID,
  50   ?user_id=xxx, etc.)
  51 - Support additional feeds that make sense (e.g: replies)?
  52 - Possibly use "rssCloud" (like Dave) instead of "RSSCloud" everywhere