Mercurial > prosody-modules

comparison mod_pubsub_feeds/README.markdown @ 1803:4d73a1a6ba68

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parents
children 8de50be756e5
comparison
equal deleted inserted replaced
1802:0ab737feada6 1803:4d73a1a6ba68
1 ---
2 summary: Subscribe to Atom and RSS feeds over pubsub
3 ...
4
5 Introduction
6 ------------
7
8 This module allows Prosody to fetch Atom and RSS feeds for you, and push
9 new results to subscribers over XMPP.
10
11 This module also implements a
12 [PubSubHubbub](http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html)
13 subscriber, allowing updates be delivered without polling for supporting
14 feed publishers.
15
16 Configuration
17 -------------
18
19 This module must be loaded on a Prosody pubsub component. Add it to
20 `modules_enabled` and configure like so:
21
22 Component "pubsub.example.com" "pubsub"
23 modules_enabled = { "pubsub_feeds" }
24
25 feeds = {
26 planet_jabber = "http://planet.jabber.org/atom.xml";
27 prosody_blog = "http://blog.prosody.im/feed/atom.xml";
28 }
29
30 This example creates two nodes, 'planet\_jabber' and 'prosody\_blog'
31 that clients can subscribe to using
32 [XEP-0060](http://xmpp.org/extensions/xep-0060.html). Results are in
33 [ATOM 1.0 format](http://atomenabled.org/) for easy consumption.
34
35 Option Description
36 ---------------------- -------------------------------------------------------------------------
37 feeds A list of virtual nodes to create and their associated Atom or RSS URL.
38 feed\_pull\_interval Number of minutes between polling for new results (default 15)
39 use\_pubsubhubub If PubSubHubbub should be enabled, true by default.
40
41 Compatibility
42 -------------
43
44 ----- -------
45 0.9 Works
46 ----- -------