Mercurial > prosody-modules
annotate mod_pubsub_feeds/README.markdown @ 1855:7eef1a3a2a17
mod_admin_blocklist: Add README
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Mon, 14 Sep 2015 13:11:26 +0200 |
parents | 8de50be756e5 |
children | 981143617dcf |
rev | line source |
---|---|
1803 | 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 | |
1820
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
22 ``` lua |
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
23 Component "pubsub.example.com" "pubsub" |
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
24 modules_enabled = { "pubsub_feeds" } |
1803 | 25 |
1820
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
26 feeds = { |
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
27 planet_jabber = "http://planet.jabber.org/atom.xml"; |
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
28 prosody_blog = "http://blog.prosody.im/feed/atom.xml"; |
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
29 } |
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
30 ``` |
1803 | 31 |
32 This example creates two nodes, 'planet\_jabber' and 'prosody\_blog' | |
33 that clients can subscribe to using | |
34 [XEP-0060](http://xmpp.org/extensions/xep-0060.html). Results are in | |
35 [ATOM 1.0 format](http://atomenabled.org/) for easy consumption. | |
36 | |
37 Option Description | |
38 ---------------------- ------------------------------------------------------------------------- | |
39 feeds A list of virtual nodes to create and their associated Atom or RSS URL. | |
40 feed\_pull\_interval Number of minutes between polling for new results (default 15) | |
41 use\_pubsubhubub If PubSubHubbub should be enabled, true by default. | |
42 | |
43 Compatibility | |
44 ------------- | |
45 | |
46 ----- ------- | |
47 0.9 Works | |
48 ----- ------- |