plugins/OStatus/README

   1 Plugin to support importing and exporting notices through Atom and RSS feeds.
   2 The OStatus plugin concentrates on user-to-user cases for federating StatusNet
   3 and similar social networking / microblogging / blogging sites, but includes
   4 low-level feed subscription systems which are used by some other plugins.
   5
   6 Uses WebSub (previously named PubSubHubbub or PuSH) for push feed updates;
   7 currently non-WebSub feeds cannot be subscribed unless an external
   8 WebSub hub proxy is used.
   9
  10
  11 Configuration options available:
  12
  13 $config['ostatus']['hub']
  14     (default internal hub)
  15     Set to URL of an external WebSub hub to use it instead of our internal hub
  16     for sending outgoing updates in user and group feeds.
  17
  18 $config['ostatus']['hub_retries']
  19     (default 0)
  20     Number of times to retry a WebSub send to consumers if using internal hub
  21
  22
  23 Settings controlling incoming feed subscription:
  24
  25 $config['feedsub']['fallback_hub']
  26     To subscribe to feeds that don't have a hub, an external WebSub proxy hub
  27     such as Superfeedr may be used. Any feed without a hub of its own will
  28     be subscribed through the specified hub URL instead. If the external hub
  29     has usage charges, be aware that there is no restriction placed to how
  30     many feeds may be subscribed!
  31
  32     $config['feedsub']['fallback_hub'] = 'https://superfeedr.com/hubbub';
  33
  34 $config['feedsub']['hub_user']
  35 $config['feedsub']['hub_password']
  36     If using the fallback hub mode, these settings may be used to provide
  37     HTTP authentication credentials for contacting the hub. Default hubs
  38     specified from feeds are assumed to not require
  39
  40
  41 For testing, shouldn't be used in production:
  42
  43 $config['ostatus']['skip_signatures']
  44     (default use signatures)
  45     Disable generation and validation of Salmon magicenv signatures
  46
  47 $config['feedsub']['nohub']
  48     (default require hub)
  49     Allow low-level feed subscription setup for feeds without hubs.
  50     Not actually usable at this stage, OStatus will check for hubs too
  51     and we have no polling backend. (The fallback hub option can be used
  52     with a 3rd-party service to provide such polling.)
  53
  54 Todo:
  55 * better support for feeds that aren't natively oriented at social networking
  56 * make use of tags/categories from feeds
  57 * better repeat handling