mod_pubsub_feeds/README.markdown
changeset 3056 e4a986d55bb2
parent 3055 99e42058a29d
child 5114 43b67142b37c
equal deleted inserted replaced
3055:99e42058a29d 3056:e4a986d55bb2
     4 
     4 
     5 # Introduction
     5 # Introduction
     6 
     6 
     7 This module allows Prosody to fetch Atom and RSS feeds for you, and push
     7 This module allows Prosody to fetch Atom and RSS feeds for you, and push
     8 new results to subscribers over XMPP.
     8 new results to subscribers over XMPP.
     9 
       
    10 This module also implements a
       
    11 [PubSubHubbub](http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html)
       
    12 subscriber, allowing updates be delivered without polling for supporting
       
    13 feed publishers.
       
    14 
     9 
    15 # Configuration
    10 # Configuration
    16 
    11 
    17 This module needs to be be loaded together with
    12 This module needs to be be loaded together with
    18 [mod\_pubsub][doc:modules:mod\_pubsub].
    13 [mod\_pubsub][doc:modules:mod\_pubsub].
    34 This example creates two nodes, 'planet\_jabber' and 'prosody\_blog'
    29 This example creates two nodes, 'planet\_jabber' and 'prosody\_blog'
    35 that clients can subscribe to using
    30 that clients can subscribe to using
    36 [XEP-0060](http://xmpp.org/extensions/xep-0060.html). Results are in
    31 [XEP-0060](http://xmpp.org/extensions/xep-0060.html). Results are in
    37 [ATOM 1.0 format](http://atomenabled.org/) for easy consumption.
    32 [ATOM 1.0 format](http://atomenabled.org/) for easy consumption.
    38 
    33 
       
    34 # PubSubHubbub
       
    35 
       
    36 This module also implements a
       
    37 [PubSubHubbub](http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html)
       
    38 subscriber. This allows feeds that have an associated "hub" to push
       
    39 updates when they are published.
       
    40 
       
    41 Not all feeds support this.
       
    42 
       
    43 It needs to expose a HTTP callback endpoint to work.
       
    44 
    39 # Option summary
    45 # Option summary
    40 
    46 
    41   Option                 Description
    47   Option                 Description
    42   ---------------------- -------------------------------------------------------------------------
    48   ---------------------- -------------------------------------------------------------------------
    43   `feeds`                A list of virtual nodes to create and their associated Atom or RSS URL.
    49   `feeds`                A list of virtual nodes to create and their associated Atom or RSS URL.