Mercurial > prosody-modules

comparison mod_component_http/README.markdown @ 2953:0092bcceda0a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_component_http: Update README to include config snippet example
author Matthew Wild <mwild1@gmail.com>
date Mon, 26 Mar 2018 14:01:00 +0100
parents 01ed9eb111d4
children 1f06a7fe75a8
comparison
equal deleted inserted replaced
2952:e8462d6dbc6d 2953:0092bcceda0a
31 ?> 31 ?>
32 ``` 32 ```
33 33
34 Configuration 34 Configuration
35 ============= 35 =============
36
37 The module is quite flexible, but should generally be loaded as a component like this:
38
39 ```
40 Component "yourservice.example.com" "component_http"
41 component_post_url = "https://example.com/your-api"
42 ```
43
44 Such a component would handle traffic for all JIDs with 'yourservice.example.com' as the hostname, such
45 as 'foobar@yourservice.example.com'. Although this example uses a subdomain, there is no requirement for
46 the component to use a subdomain.
47
48 Available configuration options are:
49
36 50
37 Option Description 51 Option Description
38 ------------------------------------ ------------------------------------------------------------------------------------------------------------------------------------------------- 52 ------------------------------------ -------------------------------------------------------------------------------------------------------------------------------------------------
39 component\_post\_url The URL that will handle incoming stanzas 53 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" }`. 54 component\_post\_stanzas A list of stanza types to forward over HTTP. Defaults to `{ "message" }`.