view mod_pubsub_feeds/README.markdown @ 4876:0f5f2d4475b9

mod_http_xep227: Add support for import via APIs rather than direct store manipulation In particular this transitions PEP nodes and data to be imported via mod_pep's APIs, fixing issues with importing at runtime while PEP data may already be live in RAM. Next obvious candidate for this approach is rosters, so clients get immediate roster pushes and other special handling (such as emitting subscribes to reach the desired subscription state).
author Matthew Wild <mwild1@gmail.com>
date Tue, 18 Jan 2022 17:01:18 +0000
parents e4a986d55bb2
children 43b67142b37c
line wrap: on
line source

---
summary: Subscribe to Atom and RSS feeds over pubsub
---

# Introduction

This module allows Prosody to fetch Atom and RSS feeds for you, and push
new results to subscribers over XMPP.

# Configuration

This module needs to be be loaded together with
[mod\_pubsub][doc:modules:mod\_pubsub].

For example, this is how you could add it to an existing pubsub
component:

``` lua
Component "pubsub.example.com" "pubsub"
modules_enabled = { "pubsub_feeds" }

feeds = {
  -- The part before = is used as PubSub node
  planet_jabber = "http://planet.jabber.org/atom.xml";
  prosody_blog = "http://blog.prosody.im/feed/atom.xml";
}
```

This example creates two nodes, 'planet\_jabber' and 'prosody\_blog'
that clients can subscribe to using
[XEP-0060](http://xmpp.org/extensions/xep-0060.html). Results are in
[ATOM 1.0 format](http://atomenabled.org/) for easy consumption.

# PubSubHubbub

This module also implements a
[PubSubHubbub](http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html)
subscriber. This allows feeds that have an associated "hub" to push
updates when they are published.

Not all feeds support this.

It needs to expose a HTTP callback endpoint to work.

# Option summary

  Option                 Description
  ---------------------- -------------------------------------------------------------------------
  `feeds`                A list of virtual nodes to create and their associated Atom or RSS URL.
  `feed_pull_interval`   Number of minutes between polling for new results (default 15)
  `use_pubsubhubub`      Set to `false` to disable PubSubHubbub

# Compatibility

  ----- -------
  0.9   Works
  ----- -------