Software / code / prosody-modules
Annotate
mod_pubsub_feeds/README.markdown @ 5483:f9cecbd03e11
mod_invites_adhoc: Fall back to generic allow_user_invites for role-less users
Fixes #1752
Backport of Prosody rev dc0c20753d6c
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Thu, 18 May 2023 18:15:50 +0200 |
| parent | 5275:3e30799deec2 |
| child | 5569:1f8c9e27b625 |
| rev | line source |
|---|---|
| 1803 | 1 --- |
| 2 summary: Subscribe to Atom and RSS feeds over pubsub | |
|
5110
43b67142b37c
mod_pubsub_feeds: Include feeds library in plugin package
Kim Alvefur <zash@zash.se>
parents:
3052
diff
changeset
|
3 rockspec: |
|
43b67142b37c
mod_pubsub_feeds: Include feeds library in plugin package
Kim Alvefur <zash@zash.se>
parents:
3052
diff
changeset
|
4 build: |
|
43b67142b37c
mod_pubsub_feeds: Include feeds library in plugin package
Kim Alvefur <zash@zash.se>
parents:
3052
diff
changeset
|
5 modules: |
|
5275
3e30799deec2
mod_pubsub_feeds: Fix packaging of support library for installer
Kim Alvefur <zash@zash.se>
parents:
5110
diff
changeset
|
6 mod_pubsub_feeds.feeds: feeds.lib.lua |
|
3048
4e8f73402577
mod_pubsub_feeds/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1893
diff
changeset
|
7 --- |
| 1803 | 8 |
|
3048
4e8f73402577
mod_pubsub_feeds/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1893
diff
changeset
|
9 # Introduction |
| 1803 | 10 |
| 11 This module allows Prosody to fetch Atom and RSS feeds for you, and push | |
| 12 new results to subscribers over XMPP. | |
| 13 | |
|
3048
4e8f73402577
mod_pubsub_feeds/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1893
diff
changeset
|
14 # Configuration |
| 1803 | 15 |
|
1893
8064b5e346ab
mod_pubsub_feeds/README: Update wording to be clearer
Kim Alvefur <zash@zash.se>
parents:
1892
diff
changeset
|
16 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
|
17 [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
|
18 |
|
8064b5e346ab
mod_pubsub_feeds/README: Update wording to be clearer
Kim Alvefur <zash@zash.se>
parents:
1892
diff
changeset
|
19 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
|
20 component: |
| 1803 | 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 = { |
|
3049
268f55bd3c81
mod_pubsub_feeds/README: Add comment explaining what the index in 'feeds' does
Kim Alvefur <zash@zash.se>
parents:
3048
diff
changeset
|
27 -- The part before = is used as PubSub node |
|
1820
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
28 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
|
29 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
|
30 } |
|
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
31 ``` |
| 1803 | 32 |
| 33 This example creates two nodes, 'planet\_jabber' and 'prosody\_blog' | |
| 34 that clients can subscribe to using | |
| 35 [XEP-0060](http://xmpp.org/extensions/xep-0060.html). Results are in | |
| 36 [ATOM 1.0 format](http://atomenabled.org/) for easy consumption. | |
| 37 | |
|
3052
e4a986d55bb2
mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents:
3051
diff
changeset
|
38 # PubSubHubbub |
|
e4a986d55bb2
mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents:
3051
diff
changeset
|
39 |
|
e4a986d55bb2
mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents:
3051
diff
changeset
|
40 This module also implements a |
|
e4a986d55bb2
mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents:
3051
diff
changeset
|
41 [PubSubHubbub](http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html) |
|
e4a986d55bb2
mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents:
3051
diff
changeset
|
42 subscriber. This allows feeds that have an associated "hub" to push |
|
e4a986d55bb2
mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents:
3051
diff
changeset
|
43 updates when they are published. |
|
e4a986d55bb2
mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents:
3051
diff
changeset
|
44 |
|
e4a986d55bb2
mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents:
3051
diff
changeset
|
45 Not all feeds support this. |
|
e4a986d55bb2
mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents:
3051
diff
changeset
|
46 |
|
e4a986d55bb2
mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents:
3051
diff
changeset
|
47 It needs to expose a HTTP callback endpoint to work. |
|
e4a986d55bb2
mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents:
3051
diff
changeset
|
48 |
|
3050
9fb944fad619
mod_pubsub_feeds/README: Give option summary its own heading
Kim Alvefur <zash@zash.se>
parents:
3049
diff
changeset
|
49 # Option summary |
|
9fb944fad619
mod_pubsub_feeds/README: Give option summary its own heading
Kim Alvefur <zash@zash.se>
parents:
3049
diff
changeset
|
50 |
| 1803 | 51 Option Description |
| 52 ---------------------- ------------------------------------------------------------------------- | |
|
3051
99e42058a29d
mod_pubsub_feeds/README: Markup options in table as code
Kim Alvefur <zash@zash.se>
parents:
3050
diff
changeset
|
53 `feeds` A list of virtual nodes to create and their associated Atom or RSS URL. |
|
99e42058a29d
mod_pubsub_feeds/README: Markup options in table as code
Kim Alvefur <zash@zash.se>
parents:
3050
diff
changeset
|
54 `feed_pull_interval` Number of minutes between polling for new results (default 15) |
|
99e42058a29d
mod_pubsub_feeds/README: Markup options in table as code
Kim Alvefur <zash@zash.se>
parents:
3050
diff
changeset
|
55 `use_pubsubhubub` Set to `false` to disable PubSubHubbub |
| 1803 | 56 |
|
3048
4e8f73402577
mod_pubsub_feeds/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents:
1893
diff
changeset
|
57 # Compatibility |
| 1803 | 58 |
| 59 ----- ------- | |
| 60 0.9 Works | |
| 61 ----- ------- |
