plugins/RSSCloud/README

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