mod_pubsub_text_interface/README.markdown
author Kim Alvefur <zash@zash.se>
Mon, 20 Aug 2018 20:22:43 +0200
changeset 3248 2b888a7aa21c
child 3414 a0e0ec729aab
permissions -rw-r--r--
mod_pubsub_text_interface: Add a README
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3248
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     1
# Introduction
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     2
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     3
This module lets you manage subscriptions to pubsub nodes via simple
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     4
chat messages. Subscriptions are always added based on bare JID. The
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     5
`include_body` flag is enabled so that a plain text body version of events
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     6
can be included, where supported.
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     7
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     8
# Configuring
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     9
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    10
```lua
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    11
Component "pubsub.example.com" "pubub"
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    12
modules_enabled = {
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    13
    "pubsub_text_interface",
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    14
}
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    15
```
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    16
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    17
# Commands
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    18
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    19
The following commands are supported. Simply send a normal chat message
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    20
to the PubSub component where this module is enabled. When subscribing
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    21
or unsubscribing, be sure to replace `node` with the node you want to
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    22
subscribe to or unsubscribe from.
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    23
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    24
- `help` - a help message, listing these commands
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    25
- `list` - list available nodes
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    26
- `subscribe node` - subscribe to a node
2b888a7aa21c mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    27
- `unsubscribe node` - unsubscribe from a node