Mercurial > prosody-modules

view mod_http_rest/README.markdown @ 4579:b305814bd930

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_muc_dicebot: A thing to roll dice Do you see what happens, Jitsi? Do you see what happens when you make it hard for me to use a proper bot? This is what happens, Jitsi. This is what happens when you meet a stranger in the alps! Ahem. In all seriousness, this is more of a quick hack than anything else. It will look for `.r` in MUC messages and if it finds it, it'll interpret it as an instruction to roll a few dice. Injects the results in the body of the message. Eats the message alive if it is malformed.
author Jonas Schäfer <jonas@wielicki.name>
date Sat, 29 May 2021 15:17:05 +0200
parents 79432b859d21
children
line wrap: on
line source

---
labels:
- 'Stage-Alpha'
summary: Send XMPP stanzas via REST/HTTP
...

This module provides a [REST](https://en.wikipedia.org/wiki/Representational_state_transfer)ful
method for sending XMPP stanzas.

This enables you to send stanzas by making HTTP requests to `http://${prosody-url}/rest`.

**DANGER/ACHTUNG!: This module does NOT enforce any authentication or user-checking.
This means that by default stanzas can be sent *anyone* on behalf of *any* user.**

You should enable [mod_http_authentication](https://modules.prosody.im/mod_http_authentication.html),
to require authentication for calls made to this module, or alternatively, you
could use a reverse proxy like Nginx.

# To enable this module

Add `"http_rest"` to `modules_enabled`, either globally or for a particular virtual
host.

# How to test:

You can use curl to make the HTTP request to Prosody, to test whether this
module is working properly:

    curl -k http://localhost:5280/rest -u username:password -H "Content-Type: text/xml" -d '<iq to="pubsub.localhost" type="set" id="4dd1a1e3-ef91-4017-a5aa-eaba0a82eb94-1" from="user@localhost"><pubsub xmlns="http://jabber.org/protocol/pubsub"><publish node="Test mod_rest.lua"><item>Hello World!</item></publish></pubsub></iq>'