Diff

mod_pubsub_hub/README.md @ 6003:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parent 2330:f933e3909795
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_pubsub_hub/README.md	Tue Oct 22 10:26:01 2024 +0200
@@ -0,0 +1,36 @@
+---
+summary: PubSubHubbub hub
+...
+
+Introduction
+============
+
+This module implements a
+[PubSubHubbub](http://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.3.html)
+(PuSH) hub, allowing PuSH clients to subscribe to local XMPP
+[Publish-Subscribe](http://xmpp.org/extensions/xep-0060.html) nodes
+stored by [mod\_pubsub](http://prosody.im/doc/modules/mod_pubsub) and
+receive real time updates to feeds.
+
+Configuration
+=============
+
+    Component "pubsub.example.com" "pubsub"
+
+    modules_enabled = {
+      "pubsub_hub";
+    }
+
+The hub is then available on `http://pubsub.example.com:5280/hub`.
+
+Compatibility
+=============
+
+  ------- --------------
+  trunk   Works
+  0.10    Should work
+  0.9     Works
+  0.8     Doesn't work
+  ------- --------------
+
+