Module: sip-router Branch: master Commit: 192228ca80f0c78481a9e768d82707ed5aa80ba7 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=192228c… Author: Juha Heinanen &lt;jh(a)tutpro.com&gt; Committer: Juha Heinanen &lt;jh(a)tutpro.com&gt; Date: Wed Apr 21 11:14:15 2010 +0300 modules/mediaproxy: added note on required Mediaproxy version - Added note that this modules Mediaproxy version 1.4.2 or higher. - Changed '&kamailio;' string to '&siprouter;' string. --- modules/mediaproxy/README | 53 ++++++++++++++------------- modules/mediaproxy/doc/mediaproxy_admin.xml | 17 +++++---- 2 files changed, 36 insertions(+), 34 deletions(-) diff --git a/modules/mediaproxy/README b/modules/mediaproxy/README index 6d5efc3..56d7e83 100644 --- a/modules/mediaproxy/README +++ b/modules/mediaproxy/README @@ -10,7 +10,7 @@ Dan Pascu &lt;dan(a)ag-projects.com&gt; - Copyright � 2004 Dan Pascu + Copyright © 2004 Dan Pascu Revision History Revision $Revision$ $Date$ __________________________________________________________________ @@ -24,7 +24,7 @@ Dan Pascu 3. Features 4. Dependencies - 4.1. Kamailio Modules + 4.1. SIP Router Modules 4.2. External Libraries or Applications 5. Exported parameters @@ -65,7 +65,7 @@ Chapter 1. Admin Guide 3. Features 4. Dependencies - 4.1. Kamailio Modules + 4.1. SIP Router Modules 4.2. External Libraries or Applications 5. Exported parameters @@ -86,7 +86,7 @@ Chapter 1. Admin Guide 1. Overview - Mediaproxy is an Kamailio module that is designed to allow automatic + Mediaproxy is an SIP Router module that is designed to allow automatic NAT traversal for the majority of existing SIP clients. This means that there will be no need to configure anything in particular on the NAT box to allow these clients to work behind NAT when using the mediaproxy @@ -100,28 +100,28 @@ Chapter 1. Admin Guide they think they talk directly with each other. Mediaproxy consists of 2 components: - * The Kamailio mediaproxy module + * The SIP Router mediaproxy module * An external application called MediaProxy which employs a dispatcher and multiple distributed media relays. This is available from http://ag-projects.com/MediaProxy.html (version 2.0.0 or newer is required by this module). - The mediaproxy dispatcher runs on the same machine as Kamailio and its - purpose is to select a media relay for a call. The media relay may run - on the same machine as the dispatcher or on multiple remote hosts and - its purpose is to forward the streams between the calling parties. To - find out more about the architecture of MediaProxy please read the + The mediaproxy dispatcher runs on the same machine as SIP Router and + its purpose is to select a media relay for a call. The media relay may + run on the same machine as the dispatcher or on multiple remote hosts + and its purpose is to forward the streams between the calling parties. + To find out more about the architecture of MediaProxy please read the documentation that comes with it. To be able to act as a relay between the 2 user agents, the machine(s) running the module/proxy server must have a public IP address. - Kamailio will ask the media relay to allocate as many ports as there + SIP Router will ask the media relay to allocate as many ports as there are media streams in the SDP offer and answer. The media relay will - send back to Kamailio the IP address and port(s) for them. Then - Kamailio will replace the original contact IP and RTP ports from the - SDP messages with the ones provided by the media relay. By doing this, - both user agents will try to contact the media relay instead of + send back to SIP Router the IP address and port(s) for them. Then SIP + Router will replace the original contact IP and RTP ports from the SDP + messages with the ones provided by the media relay. By doing this, both + user agents will try to contact the media relay instead of communicating directly with each other. Once the user agents contact the media relay, it will record the addresses they came from and will know where to forward packets received from the other endpoint. This is @@ -146,10 +146,10 @@ Chapter 1. Admin Guide 4. Dependencies - 4.1. Kamailio Modules + 4.1. SIP Router Modules 4.2. External Libraries or Applications -4.1. Kamailio Modules +4.1. SIP Router Modules The following modules must be loaded before this module: * dialog module - if engage_media_proxy is used (see below the @@ -158,8 +158,9 @@ Chapter 1. Admin Guide 4.2. External Libraries or Applications The following libraries or applications must be installed before - running Kamailio with this module loaded: - * None. + running SIP Router with this module loaded: + * Mediaproxy version 2.4.2 or higher (but not necessarily on the same + host as SIP Router). 5. Exported parameters @@ -179,7 +180,7 @@ Chapter 1. Admin Guide mediaproxy is disabled, calls to its functions will have no effect, allowing you to use the same configuration without changes. - Default value is "0". + Default value is “0”. Example 1.1. Setting the disable parameter ... @@ -191,7 +192,7 @@ modparam("mediaproxy", "disable", 1) It is the path to the filesystem socket where the mediaproxy dispatcher listens for commands from the module. - Default value is "/var/run/mediaproxy/dispatcher.sock". + Default value is “/var/run/mediaproxy/dispatcher.sock”. Example 1.2. Setting the mediaproxy_socket parameter ... @@ -204,7 +205,7 @@ modparam("mediaproxy", "mediaproxy_socket", "/var/run/mediaproxy/dispatcher.sock How much time (in milliseconds) to wait for an answer from the mediaproxy dispatcher. - Default value is "500". + Default value is “500”. Example 1.3. Setting the mediaproxy_timeout parameter ... @@ -226,7 +227,7 @@ modparam("mediaproxy", "mediaproxy_timeout", 500) to get the correct NAT IP address from where the SIP signaling originated. - Default value is "$avp(s:signaling_ip)". + Default value is “$avp(s:signaling_ip)”. Example 1.4. Setting the signaling_ip_avp parameter ... @@ -241,7 +242,7 @@ modparam("mediaproxy", "signaling_ip_avp", "$avp(s:nat_ip)") before calling use_media_proxy(), it will be preferred by the dispatcher over the normal selection algorithm. - Default value is "$avp(s:media_relay)". + Default value is “$avp(s:media_relay)”. Example 1.5. Setting the media_relay_avp parameter ... @@ -256,7 +257,7 @@ modparam("mediaproxy", "media_relay_avp", "$avp(s:media_relay)") selected then a low priority candidate will be added and if 'high-priority' is selected a high priority one. - Default value is "none". + Default value is “none”. Example 1.6. Setting the ice_candidate parameter ... @@ -273,7 +274,7 @@ modparam("mediaproxy", "ice_candidate", "low-priority") tm module to '1', and if the AVP is not set, the default value will be used. - Default value is "$avp(s:ice_candidate)". + Default value is “$avp(s:ice_candidate)”. Example 1.7. Setting the ice_candidate_avp parameter ... diff --git a/modules/mediaproxy/doc/mediaproxy_admin.xml b/modules/mediaproxy/doc/mediaproxy_admin.xml index d4ee4ad..992af06 100644 --- a/modules/mediaproxy/doc/mediaproxy_admin.xml +++ b/modules/mediaproxy/doc/mediaproxy_admin.xml @@ -17,7 +17,7 @@ <section> <title>Overview</title> <para> - Mediaproxy is an &kamailio; module that is designed to allow automatic + Mediaproxy is an &siprouter; module that is designed to allow automatic NAT traversal for the majority of existing SIP clients. This means that there will be no need to configure anything in particular on the NAT box to allow these clients to work behind NAT when using @@ -38,7 +38,7 @@ Mediaproxy consists of 2 components: <itemizedlist> <listitem> - <para>The &kamailio; mediaproxy module</para> + <para>The &siprouter; mediaproxy module</para> </listitem> <listitem> <para> @@ -52,7 +52,7 @@ </para> <para> - The mediaproxy dispatcher runs on the same machine as &kamailio; + The mediaproxy dispatcher runs on the same machine as &siprouter; and its purpose is to select a media relay for a call. The media relay may run on the same machine as the dispatcher or on multiple remote hosts and its purpose is to forward the streams between the @@ -66,9 +66,9 @@ </para> <para> - &kamailio; will ask the media relay to allocate as many ports as there are + &siprouter; will ask the media relay to allocate as many ports as there are media streams in the SDP offer and answer. The media relay will send back - to &kamailio; the IP address and port(s) for them. Then &kamailio; will + to &siprouter; the IP address and port(s) for them. Then &siprouter; will replace the original contact IP and RTP ports from the SDP messages with the ones provided by the media relay. By doing this, both user agents will try to contact the media relay instead of communicating directly with each @@ -115,7 +115,7 @@ <section> <title>Dependencies</title> <section> - <title>&kamailio; Modules</title> + <title>&siprouter; Modules</title> <para> The following modules must be loaded before this module: <itemizedlist> @@ -133,11 +133,12 @@ <title>External Libraries or Applications</title> <para> The following libraries or applications must be installed before - running &kamailio; with this module loaded: + running &siprouter; with this module loaded: <itemizedlist> <listitem> <para> - <emphasis>None</emphasis>. + <emphasis>Mediaproxy version 2.4.2 or higher (but not + necessarily on the same host as &siprouter;)</emphasis>. </para> </listitem> </itemizedlist>