Clarify server_uri and client_uri registration settings.

Used some of Rusty's suggested language plus also included
more SIPesque descriptions of where the URIs are actually
used in an outgoing REGISTER.

(closes issue ASTERISK-22390)
reported by Rusty Newton
........

Merged revisions 398368 from http://svn.asterisk.org/svn/asterisk/branches/12

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@398369 65c4cc65-6c06-0410-ace0-fbb531ad65f3

diff --git a/res/res_pjsip_outbound_registration.c b/res/res_pjsip_outbound_registration.c
index be72081..9c3ae1f 100644 (file)
--- a/res/res_pjsip_outbound_registration.c
+++ b/res/res_pjsip_outbound_registration.c
@@ -57,6 +57,15 @@
                                </configOption>
                                <configOption name="client_uri">
                                        <synopsis>Client SIP URI used when attemping outbound registration</synopsis>
+                                       <description><para>
+                                               This is the address-of-record for the outbound registration (i.e. the URI in
+                                               the To header of the REGISTER).</para>
+                                               <para>For registration with an ITSP, the client SIP URI may need to consist of
+                                               an account name or number and the provider's hostname for their registrar, e.g.
+                                               client_uri=1234567890@example.com. This may differ between providers.</para>
+                                               <para>For registration to generic registrars, the client SIP URI will depend
+                                               on networking specifics and configuration of the registrar.
+                                       </para></description>
                                </configOption>
                                <configOption name="contact_user">
                                        <synopsis>Contact User to use in request</synopsis>
@@ -78,6 +87,12 @@
                                </configOption>
                                <configOption name="server_uri">
                                        <synopsis>SIP URI of the server to register against</synopsis>
+                                       <description><para>
+                                               This is the URI at which to find the registrar to send the outbound REGISTER. This URI
+                                               is used as the request URI of the outbound REGISTER request from Asterisk.</para>
+                                               <para>For registration with an ITSP, the setting may often be just the domain of
+                                               the registrar, e.g. sip:sip.example.com.
+                                       </para></description>
                                </configOption>
                                <configOption name="transport">
                                        <synopsis>Transport used for outbound authentication</synopsis>