Mercurial > prosody-modules

comparison mod_component_http/README.markdown @ 2951:01ed9eb111d4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_component_http: Fix headings in README
author Matthew Wild <mwild1@gmail.com>
date Mon, 26 Mar 2018 13:52:38 +0100
parents 18e6d437003f
children 0092bcceda0a
comparison
equal deleted inserted replaced
2950:18e6d437003f 2951:01ed9eb111d4
30 30
31 ?> 31 ?>
32 ``` 32 ```
33 33
34 Configuration 34 Configuration
35 ------------- 35 =============
36 36
37 Option Description 37 Option Description
38 ------------------------------------ ------------------------------------------------------------------------------------------------------------------------------------------------- 38 ------------------------------------ -------------------------------------------------------------------------------------------------------------------------------------------------
39 component\_post\_url The URL that will handle incoming stanzas 39 component\_post\_url The URL that will handle incoming stanzas
40 component\_post\_stanzas A list of stanza types to forward over HTTP. Defaults to `{ "message" }`. 40 component\_post\_stanzas A list of stanza types to forward over HTTP. Defaults to `{ "message" }`.
41 41
42 Details 42 Details
43 ------- 43 =======
44 44
45 Requests 45 Requests
46 ======== 46 --------
47 47
48 Each received stanza is converted into a JSON object, and submitted to `component_post_url` using a HTTP POST request. 48 Each received stanza is converted into a JSON object, and submitted to `component_post_url` using a HTTP POST request.
49 49
50 The JSON object always has the following properties: 50 The JSON object always has the following properties:
51 51
62 -------------------------- ------------ 62 -------------------------- ------------
63 body If the stanza is a message, and it contains a body, this is the string content of the body. 63 body If the stanza is a message, and it contains a body, this is the string content of the body.
64 64
65 65
66 Responses 66 Responses
67 ========= 67 ---------
68 68
69 If you wish to respond to a stanza, you may include a reply when you respond to the HTTP request. 69 If you wish to respond to a stanza, you may include a reply when you respond to the HTTP request.
70 70
71 Responses must have a HTTP status 200 (OK), and must set the Conent-Type header to `application/json`. 71 Responses must have a HTTP status 200 (OK), and must set the Conent-Type header to `application/json`.
72 72
78 78
79 If 'stanza' is set, it overrides all of the above, and the supplied stanza is sent as-is using Prosody's normal routing rules. Note that stanzas 79 If 'stanza' is set, it overrides all of the above, and the supplied stanza is sent as-is using Prosody's normal routing rules. Note that stanzas
80 sent by components must have a 'to' and 'from'. 80 sent by components must have a 'to' and 'from'.
81 81
82 Presence 82 Presence
83 ======== 83 --------
84 84
85 By default the module automatically handles presence to provide an always-on component, that automatically accepts subscription requests. 85 By default the module automatically handles presence to provide an always-on component, that automatically accepts subscription requests.
86 86
87 This means that by default presence stanzas are not forwarded to the configured URL. To provide your own presence handling, you can override 87 This means that by default presence stanzas are not forwarded to the configured URL. To provide your own presence handling, you can override
88 this by adding "presence" to the component\_post\_stanzas option in your config. 88 this by adding "presence" to the component\_post\_stanzas option in your config.
89 89
90 90
91 Compatibility 91 Compatibility
92 ------------- 92 =============
93 93
94 Should work with all versions of Prosody from 0.9 upwards. 94 Should work with all versions of Prosody from 0.9 upwards.