comparison mod_pubsub_feeds.wiki @ 364:ce55e811637b

Add an actual description
author Kim Alvefur <zash@zash.se>
date Wed, 12 Jun 2013 18:12:10 +0200
parents 010cc20c03fa
children 528721aaea46
comparison
equal deleted inserted replaced
363:4a39ef28e2d9 364:ce55e811637b
1 This module implements a [http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html PubSubHubbub] subscriber, which stores data in [http://xmpp.org/extensions/xep-0060.html Publish-Subscribe] nodes with mod_pubsub. 1 #summary Subscribe to Atom and RSS feeds over pubsub
2
3 = Introduction =
4
5 This module allows Prosody to fetch Atom and RSS feeds for you, and push new results to subscribers over XMPP.
6
7 This module also implements a [http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html PubSubHubbub] subscriber, allowing updates be delivered without polling for supporting feed publishers.
8
9 = Configuration =
10
11 This module must be loaded on a Prosody pubsub component. Add it to `modules_enabled` and configure like so:
12
13 {{{
14 Component "pubsub.example.com" "pubsub"
15 modules_enabled = { "pubsub_feeds" }
16
17 feeds = {
18 planet_jabber = "http://planet.jabber.org/atom.xml";
19 prosody_blog = "http://blog.prosody.im/feed/atom.xml";
20 }
21 }}}
22
23 This example creates two nodes, 'planet_jabber' and 'prosody_blog' that clients can subscribe to using [http://xmpp.org/extensions/xep-0060.html XEP-0060]. Results are in [http://atomenabled.org/ ATOM 1.0 format] for easy consumption.
24
25 || *Option* || *Description* ||
26 || feeds || A list of virtual nodes to create and their associated Atom or RSS URL. ||
27 || feed_pull_interval || Number of minutes between polling for new results (default 15) ||
28 || use_pubsubhubub || If PubSubHubbub should be enabled, true by default. ||
29
30 = Compatibility =
31 || 0.9 || Works ||