mod_pubsub_feeds/README.markdown
author Matthew Wild <mwild1@gmail.com>
Tue, 12 Mar 2024 14:27:43 +0000
changeset 5869 bfc35ae9edcb
parent 5574 f93b1fc1aa31
permissions -rw-r--r--
mod_firewall: 'REPORT TO': fix default reason fallback if none is provided
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1807
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
5114
43b67142b37c mod_pubsub_feeds: Include feeds library in plugin package
Kim Alvefur <zash@zash.se>
parents: 3056
diff changeset
     3
rockspec:
43b67142b37c mod_pubsub_feeds: Include feeds library in plugin package
Kim Alvefur <zash@zash.se>
parents: 3056
diff changeset
     4
  build:
43b67142b37c mod_pubsub_feeds: Include feeds library in plugin package
Kim Alvefur <zash@zash.se>
parents: 3056
diff changeset
     5
    modules:
5279
3e30799deec2 mod_pubsub_feeds: Fix packaging of support library for installer
Kim Alvefur <zash@zash.se>
parents: 5114
diff changeset
     6
      mod_pubsub_feeds.feeds: feeds.lib.lua
3052
4e8f73402577 mod_pubsub_feeds/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents: 1897
diff changeset
     7
---
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     8
3052
4e8f73402577 mod_pubsub_feeds/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents: 1897
diff changeset
     9
# Introduction
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    10
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    11
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
    12
new results to subscribers over XMPP.
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    13
3052
4e8f73402577 mod_pubsub_feeds/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents: 1897
diff changeset
    14
# Configuration
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    15
1897
8064b5e346ab mod_pubsub_feeds/README: Update wording to be clearer
Kim Alvefur <zash@zash.se>
parents: 1896
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: 1896
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: 1896
diff changeset
    18
8064b5e346ab mod_pubsub_feeds/README: Update wording to be clearer
Kim Alvefur <zash@zash.se>
parents: 1896
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: 1896
diff changeset
    20
component:
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    21
1824
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents: 1807
diff changeset
    22
``` lua
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents: 1807
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: 1807
diff changeset
    24
modules_enabled = { "pubsub_feeds" }
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    25
1824
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents: 1807
diff changeset
    26
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
    27
  -- 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
    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: 1807
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: 1807
diff changeset
    30
}
8de50be756e5 Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents: 1807
diff changeset
    31
```
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    32
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    33
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
    34
that clients can subscribe to using
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    35
[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
    36
[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
    37
5573
1f8c9e27b625 mod_pubsub_feeds: Disable WebSub (formerly PubSubHubbub) by default
Kim Alvefur <zash@zash.se>
parents: 5279
diff changeset
    38
# WebSub {#pubsubhubbub}
3056
e4a986d55bb2 mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents: 3055
diff changeset
    39
5573
1f8c9e27b625 mod_pubsub_feeds: Disable WebSub (formerly PubSubHubbub) by default
Kim Alvefur <zash@zash.se>
parents: 5279
diff changeset
    40
This module also implements [WebSub](https://www.w3.org/TR/websub/),
1f8c9e27b625 mod_pubsub_feeds: Disable WebSub (formerly PubSubHubbub) by default
Kim Alvefur <zash@zash.se>
parents: 5279
diff changeset
    41
formerly known as
1f8c9e27b625 mod_pubsub_feeds: Disable WebSub (formerly PubSubHubbub) by default
Kim Alvefur <zash@zash.se>
parents: 5279
diff changeset
    42
[PubSubHubbub](http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html).
1f8c9e27b625 mod_pubsub_feeds: Disable WebSub (formerly PubSubHubbub) by default
Kim Alvefur <zash@zash.se>
parents: 5279
diff changeset
    43
This allows "feed hubs" to instantly push feed updates to subscribers.
3056
e4a986d55bb2 mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents: 3055
diff changeset
    44
5573
1f8c9e27b625 mod_pubsub_feeds: Disable WebSub (formerly PubSubHubbub) by default
Kim Alvefur <zash@zash.se>
parents: 5279
diff changeset
    45
This may be removed in the future since it does not seem to be oft used
1f8c9e27b625 mod_pubsub_feeds: Disable WebSub (formerly PubSubHubbub) by default
Kim Alvefur <zash@zash.se>
parents: 5279
diff changeset
    46
anymore.
3056
e4a986d55bb2 mod_pubsub_feeds/README: Give PubSubHubbub its own section
Kim Alvefur <zash@zash.se>
parents: 3055
diff changeset
    47
3054
9fb944fad619 mod_pubsub_feeds/README: Give option summary its own heading
Kim Alvefur <zash@zash.se>
parents: 3053
diff changeset
    48
# Option summary
9fb944fad619 mod_pubsub_feeds/README: Give option summary its own heading
Kim Alvefur <zash@zash.se>
parents: 3053
diff changeset
    49
5574
f93b1fc1aa31 mod_pubsub_feeds: Add new interval setting in seconds (old still works)
Kim Alvefur <zash@zash.se>
parents: 5573
diff changeset
    50
  Option                         Description
f93b1fc1aa31 mod_pubsub_feeds: Add new interval setting in seconds (old still works)
Kim Alvefur <zash@zash.se>
parents: 5573
diff changeset
    51
  ------------------------------ --------------------------------------------------------------------------
f93b1fc1aa31 mod_pubsub_feeds: Add new interval setting in seconds (old still works)
Kim Alvefur <zash@zash.se>
parents: 5573
diff changeset
    52
  `feeds`                        A list of virtual nodes to create and their associated Atom or RSS URL.
f93b1fc1aa31 mod_pubsub_feeds: Add new interval setting in seconds (old still works)
Kim Alvefur <zash@zash.se>
parents: 5573
diff changeset
    53
  `feed_pull_interval_seconds`   Number of seconds between polling for new results (default 15 *minutes*)
f93b1fc1aa31 mod_pubsub_feeds: Add new interval setting in seconds (old still works)
Kim Alvefur <zash@zash.se>
parents: 5573
diff changeset
    54
  `use_pubsubhubub`              Set to `true` to enable WebSub
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    55
3052
4e8f73402577 mod_pubsub_feeds/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents: 1897
diff changeset
    56
# Compatibility
1807
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    57
5573
1f8c9e27b625 mod_pubsub_feeds: Disable WebSub (formerly PubSubHubbub) by default
Kim Alvefur <zash@zash.se>
parents: 5279
diff changeset
    58
  ------ -------
1f8c9e27b625 mod_pubsub_feeds: Disable WebSub (formerly PubSubHubbub) by default
Kim Alvefur <zash@zash.se>
parents: 5279
diff changeset
    59
  0.12    Works
1f8c9e27b625 mod_pubsub_feeds: Disable WebSub (formerly PubSubHubbub) by default
Kim Alvefur <zash@zash.se>
parents: 5279
diff changeset
    60
  0.11    Works
1f8c9e27b625 mod_pubsub_feeds: Disable WebSub (formerly PubSubHubbub) by default
Kim Alvefur <zash@zash.se>
parents: 5279
diff changeset
    61
  ------ -------