prosody-modules
78ef5d9e2361
mod_pubsub_feeds/README.markdown

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Annotate

mod_pubsub_feeds/README.markdown @ 4657:78ef5d9e2361

mod_watch_spam_reports: Prepare for changing 'reason' to an optional value
author Kim Alvefur <zash@zash.se>
date Wed, 25 Aug 2021 16:31:10 +0200
parent 3052:e4a986d55bb2
child 5110:43b67142b37c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 ---
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 summary: Subscribe to Atom and RSS feeds over pubsub
3048
4e8f73402577 mod_pubsub_feeds/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents: 1893
diff changeset
3 ---
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4
3048
4e8f73402577 mod_pubsub_feeds/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents: 1893
diff changeset
5 # Introduction
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 This module allows Prosody to fetch Atom and RSS feeds for you, and push
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 new results to subscribers over XMPP.
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9
3048
4e8f73402577 mod_pubsub_feeds/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents: 1893
diff changeset
10 # Configuration
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11
1893
8064b5e346ab mod_pubsub_feeds/README: Update wording to be clearer
Kim Alvefur <zash@zash.se>
parents: 1892
diff changeset
12 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
13 [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
14
8064b5e346ab mod_pubsub_feeds/README: Update wording to be clearer
Kim Alvefur <zash@zash.se>
parents: 1892
diff changeset
15 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
16 component:
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17
1820
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
18 ``` lua
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
19 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
20 modules_enabled = { "pubsub_feeds" }
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
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 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
23 -- 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
24 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
25 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
26 }
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
27 ```
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29 This example creates two nodes, 'planet\_jabber' and 'prosody\_blog'
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30 that clients can subscribe to using
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
31 [XEP-0060](http://xmpp.org/extensions/xep-0060.html). Results are in
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
32 [ATOM 1.0 format](http://atomenabled.org/) for easy consumption.
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
33
3052
e4a986d55bb2 mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents: 3051
diff changeset
34 # PubSubHubbub
e4a986d55bb2 mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents: 3051
diff changeset
35
e4a986d55bb2 mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents: 3051
diff changeset
36 This module also implements a
e4a986d55bb2 mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents: 3051
diff changeset
37 [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
38 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
39 updates when they are published.
e4a986d55bb2 mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents: 3051
diff changeset
40
e4a986d55bb2 mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents: 3051
diff changeset
41 Not all feeds support this.
e4a986d55bb2 mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents: 3051
diff changeset
42
e4a986d55bb2 mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents: 3051
diff changeset
43 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
44
3050
9fb944fad619 mod_pubsub_feeds/README: Give option summary its own heading
Kim Alvefur <zash@zash.se>
parents: 3049
diff changeset
45 # Option summary
9fb944fad619 mod_pubsub_feeds/README: Give option summary its own heading
Kim Alvefur <zash@zash.se>
parents: 3049
diff changeset
46
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
47 Option Description
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
48 ---------------------- -------------------------------------------------------------------------
3051
99e42058a29d mod_pubsub_feeds/README: Markup options in table as code
Kim Alvefur <zash@zash.se>
parents: 3050
diff changeset
49 `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
50 `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
51 `use_pubsubhubub` Set to `false` to disable PubSubHubbub
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
52
3048
4e8f73402577 mod_pubsub_feeds/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents: 1893
diff changeset
53 # Compatibility
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
54
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
55 ----- -------
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
56 0.9 Works
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
57 ----- -------