Mercurial > prosody-modules

annotate mod_pubsub_get/README.md @ 6274:63ef69b2f046

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_http_oauth2: Assume Prosody 13.0+ roles are available Per the README, 0.12 is not supported, so we should not need to worry about this. Plus it is assumed to be present elsewhere and that would throw errors.
author Kim Alvefur <zash@zash.se>
date Wed, 02 Jul 2025 16:15:32 +0200
parents 119c0eb65bf3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6176
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
1 ---
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
2 labels:
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
3 - "Stage-Alpha"
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
4 summary: Get pubsub items via HTTP GET
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
5 ---
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
6
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
7 # Introduction
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
8
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
9 WARNING: this module does not implement any type of access control and will effectively make all
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
10 pubsub data public on the component it is loaded onto.
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
11
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
12 This module lets you fetch the items of a specific pubsub node via an HTTP GET request.
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
13 I implemented it for a read-only view of comments published according to XEP-0277.
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
14
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
15 # Configuration
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
16
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
17 Nothing is configurable, just load the module on a specific component.
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
18
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
19 ```lua
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
20 Component "comments.example.com" "pubsub"
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
21 modules_enabled = { "pubsub_get" }
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
22 ```
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
23
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
24 # Use
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
25
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
26 To query the items of the node "urn:xmpp:microblog:0:comments/some-article", issue a GET for
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
27 `https://comments.example.com:5281/pubsub_get?node=urn:xmpp:microblog:0:comments/some-article`.
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
28 This will return a JSON object containing the items data.
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
29
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
30 # TODO
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
31
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
32 - Only return items with "open" access model
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
33
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
34 # Compatibility
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
35
119c0eb65bf3 mod_pubsub: new module to fetch pubsub items via HTTP GET
nicoco <nicoco@nicoco.fr>
parents:
diff changeset
36 Requires Prosody trunk / 0.12