prosody-modules
1da4b815d2fe
mod_http_rest/README.markdown
Software / code / prosody-modules
File
mod_http_rest/README.markdown @ 4730:1da4b815d2fe
mod_cloud_notify: Identify (and immediately push) urgent stanzas, e.g. calls
This covers the following things:
- A session that appears online, but has a broken TCP connection
- Clients such as Siskin and Snikket iOS that require a push for calls to work
It allows the stanza to be pushed immediately instead of waiting for the
session to hibernate or an ack to timeout.
It shouldn't break any existing cases.
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Wed, 27 Oct 2021 19:12:03 +0100 |
| parent | 2336:79432b859d21 |
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>'
