Software /
code /
prosody-modules
Annotate
mod_pubsub_feeds/README.markdown @ 2595:307ddebb72e1
mod_storage_xmlarchive: Assume offset to be zero if not included (thanks pep.)
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sat, 04 Mar 2017 19:52:41 +0100 |
parent | 1893:8064b5e346ab |
child | 3048:4e8f73402577 |
rev | line source |
---|---|
1803 | 1 --- |
2 summary: Subscribe to Atom and RSS feeds over pubsub | |
3 ... | |
4 | |
5 Introduction | |
1892
981143617dcf
mod_pubsub_feeds/README: Increase header levels (modules.prosody.im decreases all by one)
Kim Alvefur <zash@zash.se>
parents:
1820
diff
changeset
|
6 ============ |
1803 | 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 | |
1892
981143617dcf
mod_pubsub_feeds/README: Increase header levels (modules.prosody.im decreases all by one)
Kim Alvefur <zash@zash.se>
parents:
1820
diff
changeset
|
17 ============= |
1803 | 18 |
1893
8064b5e346ab
mod_pubsub_feeds/README: Update wording to be clearer
Kim Alvefur <zash@zash.se>
parents:
1892
diff
changeset
|
19 This module needs to be be loaded together with |
8064b5e346ab
mod_pubsub_feeds/README: Update wording to be clearer
Kim Alvefur <zash@zash.se>
parents:
1892
diff
changeset
|
20 [mod\_pubsub][doc:modules:mod\_pubsub]. |
8064b5e346ab
mod_pubsub_feeds/README: Update wording to be clearer
Kim Alvefur <zash@zash.se>
parents:
1892
diff
changeset
|
21 |
8064b5e346ab
mod_pubsub_feeds/README: Update wording to be clearer
Kim Alvefur <zash@zash.se>
parents:
1892
diff
changeset
|
22 For example, this is how you could add it to an existing pubsub |
8064b5e346ab
mod_pubsub_feeds/README: Update wording to be clearer
Kim Alvefur <zash@zash.se>
parents:
1892
diff
changeset
|
23 component: |
1803 | 24 |
1820
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
25 ``` lua |
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
26 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
|
27 modules_enabled = { "pubsub_feeds" } |
1803 | 28 |
1820
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
29 feeds = { |
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
30 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
|
31 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
|
32 } |
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
33 ``` |
1803 | 34 |
35 This example creates two nodes, 'planet\_jabber' and 'prosody\_blog' | |
36 that clients can subscribe to using | |
37 [XEP-0060](http://xmpp.org/extensions/xep-0060.html). Results are in | |
38 [ATOM 1.0 format](http://atomenabled.org/) for easy consumption. | |
39 | |
40 Option Description | |
41 ---------------------- ------------------------------------------------------------------------- | |
42 feeds A list of virtual nodes to create and their associated Atom or RSS URL. | |
43 feed\_pull\_interval Number of minutes between polling for new results (default 15) | |
44 use\_pubsubhubub If PubSubHubbub should be enabled, true by default. | |
45 | |
46 Compatibility | |
1892
981143617dcf
mod_pubsub_feeds/README: Increase header levels (modules.prosody.im decreases all by one)
Kim Alvefur <zash@zash.se>
parents:
1820
diff
changeset
|
47 ============= |
1803 | 48 |
49 ----- ------- | |
50 0.9 Works | |
51 ----- ------- |