changeset 2953:0092bcceda0a

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 e8462d6dbc6d
children 1f06a7fe75a8
files mod_component_http/README.markdown
diffstat 1 files changed, 14 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/mod_component_http/README.markdown	Mon Mar 26 13:56:18 2018 +0100
+++ b/mod_component_http/README.markdown	Mon Mar 26 14:01:00 2018 +0100
@@ -34,6 +34,20 @@
 Configuration
 =============
 
+The module is quite flexible, but should generally be loaded as a component like this:
+
+```
+Component "yourservice.example.com" "component_http"
+  component_post_url = "https://example.com/your-api"
+```
+
+Such a component would handle traffic for all JIDs with 'yourservice.example.com' as the hostname, such
+as 'foobar@yourservice.example.com'. Although this example uses a subdomain, there is no requirement for
+the component to use a subdomain.
+
+Available configuration options are:
+
+
   Option                                 Description
   ------------------------------------   -------------------------------------------------------------------------------------------------------------------------------------------------
   component\_post\_url                   The URL that will handle incoming stanzas