[sr-dev] git:master:68cbac03: xhttp_rpc: added notes about how to use the module

Fri Mar 18 17:19:17 CET 2016

Thank you for taking the time to update the docs.

-ovidiu

On Thu, Mar 17, 2016 at 5:57 PM, Daniel-Constantin Mierla
<miconda at gmail.com> wrote:
> Module: kamailio
> Branch: master
> Commit: 68cbac03d95893f4f27b46a37233cf796a7484d9
> URL: https://github.com/kamailio/kamailio/commit/68cbac03d95893f4f27b46a37233cf796a7484d9
>
> Author: Daniel-Constantin Mierla <miconda at gmail.com>
> Committer: Daniel-Constantin Mierla <miconda at gmail.com>
> Date: 2016-03-17T22:56:41+01:00
>
> xhttp_rpc: added notes about how to use the module
>
> ---
>
> Modified: modules/xhttp_rpc/README
> Modified: modules/xhttp_rpc/doc/xhttp_rpc_admin.xml
>
> ---
>
> Diff:  https://github.com/kamailio/kamailio/commit/68cbac03d95893f4f27b46a37233cf796a7484d9.diff
> Patch: https://github.com/kamailio/kamailio/commit/68cbac03d95893f4f27b46a37233cf796a7484d9.patch
>
> ---
>
> diff --git a/modules/xhttp_rpc/README b/modules/xhttp_rpc/README
> index b85f033..62c6a5e 100644
> --- a/modules/xhttp_rpc/README
> +++ b/modules/xhttp_rpc/README
> @@ -10,13 +10,11 @@ Ovidiu Sas
>
>     <osas at voipembedded.com>
>
> -Edited by
> -
>  Alex Balashov
>
>     <abalashov at evaristesys.com>
>
> -   Copyright © 2011 VoIPEmbedded Inc.
> +   Copyright © 2011 VoIPEmbedded Inc.
>       __________________________________________________________________
>
>     Table of Contents
> @@ -41,6 +39,8 @@ Alex Balashov
>
>                4.1. dispatch_xhttp_rpc()
>
> +        5. Usage
> +
>     List of Examples
>
>     1.1. Set xhttp_rpc_root parameter
> @@ -69,6 +69,8 @@ Chapter 1. Admin Guide
>
>          4.1. dispatch_xhttp_rpc()
>
> +   5. Usage
> +
>  1. Overview
>
>     1.1. Limitations
> @@ -145,7 +147,7 @@ modparam("xhttp", "xhttp_rpc_buf_size", 1024)
>
>     4.1. dispatch_xhttp_rpc()
>
> -4.1.  dispatch_xhttp_rpc()
> +4.1. dispatch_xhttp_rpc()
>
>     Handle the HTTP request and generate a response.
>
> @@ -168,3 +170,15 @@ event_route[xhttp:request] {
>                          "<html><body>Wrong URL $hu</body></html>");
>  }
>  ...
> +
> +5. Usage
> +
> +   The module is not intended to be used in a "scripted" mode with command
> +   line tools. It only provides a simple web interface with all the
> +   available RPC commands. Point a web browser to
> +   http://serverip:port/http_rpc and browse through the available rpc
> +   commands.
> +
> +   If you don't configure a dedicated port for HTTP, then you have to use
> +   same port as for SIP TCP. If you load and configure TLS module, then
> +   you can browse using HTTPS to the SIP TLS port.
> diff --git a/modules/xhttp_rpc/doc/xhttp_rpc_admin.xml b/modules/xhttp_rpc/doc/xhttp_rpc_admin.xml
> index ca02556..e40fbf9 100644
> --- a/modules/xhttp_rpc/doc/xhttp_rpc_admin.xml
> +++ b/modules/xhttp_rpc/doc/xhttp_rpc_admin.xml
> @@ -166,5 +166,20 @@ event_route[xhttp:request] {
>             </example>
>         </section>
>         </section>
> +       <section>
> +       <title>Usage</title>
> +           <para>
> +               The module is not intended to be used in a "scripted" mode with
> +               command line tools.
> +               It only provides a simple web interface with all the available
> +               RPC commands. Point a web browser to http://serverip:port/http_rpc
> +               and browse through the available rpc commands.
> +               </para>
> +               <para>
> +               If you don't configure a dedicated port for HTTP, then you have
> +               to use same port as for SIP TCP. If you load and configure TLS
> +               module, then you can browse using HTTPS to the SIP TLS port.
> +               </para>
> +       </section>
>  </chapter>
>
>
>
>
> _______________________________________________
> sr-dev mailing list
> sr-dev at lists.sip-router.org
> http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
>

-- 
VoIP Embedded, Inc.
http://www.voipembedded.com