annotate mod_pubsub_feeds.wiki @ 380:0f832ed3fbd1

mod_pubsub_hub.wiki: Improve introduction and add config example
author Kim Alvefur <zash@zash.se>
date Sat, 29 Jun 2013 22:53:18 +0200
parents ce55e811637b
children 528721aaea46
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
364
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
1 #summary Subscribe to Atom and RSS feeds over pubsub
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
2
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
3 = Introduction =
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
4
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
5 This module allows Prosody to fetch Atom and RSS feeds for you, and push new results to subscribers over XMPP.
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
6
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
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.
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
8
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
9 = Configuration =
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
10
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
11 This module must be loaded on a Prosody pubsub component. Add it to `modules_enabled` and configure like so:
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
12
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
13 {{{
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
14 Component "pubsub.example.com" "pubsub"
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
15 modules_enabled = { "pubsub_feeds" }
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
16
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
17 feeds = {
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
18 planet_jabber = "http://planet.jabber.org/atom.xml";
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
19 prosody_blog = "http://blog.prosody.im/feed/atom.xml";
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
20 }
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
21 }}}
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
22
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
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.
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
24
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
25 || *Option* || *Description* ||
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
26 || feeds || A list of virtual nodes to create and their associated Atom or RSS URL. ||
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
27 || feed_pull_interval || Number of minutes between polling for new results (default 15) ||
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
28 || use_pubsubhubub || If PubSubHubbub should be enabled, true by default. ||
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
29
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
30 = Compatibility =
ce55e811637b Add an actual description
Kim Alvefur <zash@zash.se>
parents: 294
diff changeset
31 || 0.9 || Works ||