prosody-modules
d194d1012fd3
mod_pubsub_text_interface/README.markdown
Software / code / prosody-modules
File
mod_pubsub_text_interface/README.markdown @ 5931:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
| author | Ben Smith <bens@effortlessis.com> |
|---|---|
| date | Mon, 13 May 2024 13:25:13 -0700 |
| parent | 3436:12c7c0d7e1b0 |
line wrap: on
line source
# Introduction This module lets you manage subscriptions to pubsub nodes via simple chat messages. Subscriptions are always added based on bare JID. The `include_body` flag is enabled so that a plain text body version of events can be included, where supported. # Configuring ``` {.lua} Component "pubsub.example.com" "pubsub" modules_enabled = { "pubsub_text_interface", } ``` # Commands The following commands are supported. Simply send a normal chat message to the PubSub component where this module is enabled. When subscribing or unsubscribing, be sure to replace `node` with the node you want to subscribe to or unsubscribe from. - `help` - a help message, listing these commands - `list` - list available nodes - `subscribe node` - subscribe to a node - `unsubscribe node` - unsubscribe from a node - `last node` - sends the last published item from the node to you # Compatibility Should work with Prosody since 0.9, when [mod\_pubsub][doc:modules:mod_pubsub] was introduced. The `last` command is available from Prosody 0.11.
