Software /
code /
prosody-modules
File
mod_pubsub_feeds/README.markdown @ 5661:e76ec7ad941e
mod_invites_register_web: update README for `invites_template_html`.
author | Trần H. Trung <xmpp:trần.h.trung@trung.fun> |
---|---|
date | Tue, 29 Aug 2023 22:06:19 +0700 |
parent | 5570:f93b1fc1aa31 |
line wrap: on
line source
--- summary: Subscribe to Atom and RSS feeds over pubsub rockspec: build: modules: mod_pubsub_feeds.feeds: feeds.lib.lua --- # 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. # WebSub {#pubsubhubbub} This module also implements [WebSub](https://www.w3.org/TR/websub/), formerly known as [PubSubHubbub](http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html). This allows "feed hubs" to instantly push feed updates to subscribers. This may be removed in the future since it does not seem to be oft used anymore. # Option summary Option Description ------------------------------ -------------------------------------------------------------------------- `feeds` A list of virtual nodes to create and their associated Atom or RSS URL. `feed_pull_interval_seconds` Number of seconds between polling for new results (default 15 *minutes*) `use_pubsubhubub` Set to `true` to enable WebSub # Compatibility ------ ------- 0.12 Works 0.11 Works ------ -------