author | Kim Alvefur <zash@zash.se> |
Sun, 27 May 2018 17:43:43 +0200 | |
changeset 3053 | 268f55bd3c81 |
parent 3052 | 4e8f73402577 |
child 3054 | 9fb944fad619 |
permissions | -rw-r--r-- |
1807 | 1 |
--- |
2 |
summary: Subscribe to Atom and RSS feeds over pubsub |
|
3052
4e8f73402577
mod_pubsub_feeds/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1897
diff
changeset
|
3 |
--- |
1807 | 4 |
|
3052
4e8f73402577
mod_pubsub_feeds/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1897
diff
changeset
|
5 |
# Introduction |
1807 | 6 |
|
7 |
This module allows Prosody to fetch Atom and RSS feeds for you, and push |
|
8 |
new results to subscribers over XMPP. |
|
9 |
||
10 |
This module also implements a |
|
11 |
[PubSubHubbub](http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html) |
|
12 |
subscriber, allowing updates be delivered without polling for supporting |
|
13 |
feed publishers. |
|
14 |
||
3052
4e8f73402577
mod_pubsub_feeds/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1897
diff
changeset
|
15 |
# Configuration |
1807 | 16 |
|
1897
8064b5e346ab
mod_pubsub_feeds/README: Update wording to be clearer
Kim Alvefur <zash@zash.se>
parents:
1896
diff
changeset
|
17 |
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:
1896
diff
changeset
|
18 |
[mod\_pubsub][doc:modules:mod\_pubsub]. |
8064b5e346ab
mod_pubsub_feeds/README: Update wording to be clearer
Kim Alvefur <zash@zash.se>
parents:
1896
diff
changeset
|
19 |
|
8064b5e346ab
mod_pubsub_feeds/README: Update wording to be clearer
Kim Alvefur <zash@zash.se>
parents:
1896
diff
changeset
|
20 |
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:
1896
diff
changeset
|
21 |
component: |
1807 | 22 |
|
1824
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
23 |
``` lua |
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
24 |
Component "pubsub.example.com" "pubsub" |
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
25 |
modules_enabled = { "pubsub_feeds" } |
1807 | 26 |
|
1824
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
27 |
feeds = { |
3053
268f55bd3c81
mod_pubsub_feeds/README: Add comment explaining what the index in 'feeds' does
Kim Alvefur <zash@zash.se>
parents:
3052
diff
changeset
|
28 |
-- The part before = is used as PubSub node |
1824
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
29 |
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:
1807
diff
changeset
|
30 |
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:
1807
diff
changeset
|
31 |
} |
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
32 |
``` |
1807 | 33 |
|
34 |
This example creates two nodes, 'planet\_jabber' and 'prosody\_blog' |
|
35 |
that clients can subscribe to using |
|
36 |
[XEP-0060](http://xmpp.org/extensions/xep-0060.html). Results are in |
|
37 |
[ATOM 1.0 format](http://atomenabled.org/) for easy consumption. |
|
38 |
||
39 |
Option Description |
|
40 |
---------------------- ------------------------------------------------------------------------- |
|
41 |
feeds A list of virtual nodes to create and their associated Atom or RSS URL. |
|
42 |
feed\_pull\_interval Number of minutes between polling for new results (default 15) |
|
43 |
use\_pubsubhubub If PubSubHubbub should be enabled, true by default. |
|
44 |
||
3052
4e8f73402577
mod_pubsub_feeds/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1897
diff
changeset
|
45 |
# Compatibility |
1807 | 46 |
|
47 |
----- ------- |
|
48 |
0.9 Works |
|
49 |
----- ------- |