view mod_pubsub_feeds.wiki @ 389:b4f1aeb37ae7

Describe the actual feature
author Kim Alvefur <zash@zash.se>
date Mon, 15 Jul 2013 01:56:57 +0200
parents ce55e811637b
children 528721aaea46
line wrap: on
line source

#summary Subscribe to Atom and RSS feeds over pubsub

= Introduction =

This module allows Prosody to fetch Atom and RSS feeds for you, and push new results to subscribers over XMPP.

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.

= Configuration =

This module must be loaded on a Prosody pubsub component. Add it to `modules_enabled` and configure like so:

{{{
Component "pubsub.example.com" "pubsub"
    modules_enabled = { "pubsub_feeds" }
    
    feeds = {
			planet_jabber = "http://planet.jabber.org/atom.xml";
			prosody_blog = "http://blog.prosody.im/feed/atom.xml";
		}
}}}

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.

|| *Option* || *Description* ||
|| feeds || A list of virtual nodes to create and their associated Atom or RSS URL. ||
|| feed_pull_interval || Number of minutes between polling for new results (default 15) ||
|| use_pubsubhubub || If PubSubHubbub should be enabled, true by default. ||

= Compatibility =
|| 0.9 || Works ||