Clarify documentation for the "identify_by" option for SIP endpoints.

This also removes documentation for the options that no longer exist.

(closes issue ASTERISK-22306)
reported by Rusty Newton


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@397111 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Mark Michelson 2013-08-20 15:39:38 +00:00
parent 63134ea011
commit 86741bdf46
1 changed files with 9 additions and 4 deletions

View File

@ -220,13 +220,18 @@
<configOption name="identify_by" default="username,location">
<synopsis>Way(s) for Endpoint to be identified</synopsis>
<description><para>
There are currently two methods to identify an endpoint. By default
both are used to identify an endpoint.
An endpoint can be identified in multiple ways. Currently, the only supported
option is <literal>username</literal>, which matches the endpoint based on the
username in the From header.
</para>
<note><para>Endpoints can also be identified by IP address; however, that method
of identification is not handled by this configuration option. See the documentation
for the <literal>identify</literal> configuration section for more details on that
method of endpoint identification. If this option is set to <literal>username</literal>
and an <literal>identify</literal> configuration section exists for the endpoint, then
the endpoint can be identified in multiple ways.</para></note>
<enumlist>
<enum name="username" />
<enum name="location" />
<enum name="username,location" />
</enumlist>
</description>
</configOption>