[Home]

Summary:ASTERISK-27737: wiki: 'identify_by' pjsip.conf option documentation is wrong
Reporter:Jacek Konieczny (jkonieczny)Labels:pjsip
Date Opened:2018-03-12 09:29:27Date Closed:2018-09-04 16:02:26
Priority:MinorRegression?
Status:Closed/CompleteComponents:Documentation
Versions:15.2.2 Frequency of
Occurrence
Related
Issues:
Environment:Attachments:
Description:The table at the top of https://wiki.asterisk.org/wiki/display/AST/Asterisk+15+Configuration_res_pjsip shows the default value to be '{{username,location}}'.

Then, in the [option description|https://wiki.asterisk.org/wiki/display/AST/Asterisk+15+Configuration_res_pjsip#Asterisk15Configuration_res_pjsip-endpoint_identify_by], {{username}} and {{auth_username}} are listed as valid values.

Identification by the {{identify}} section is mentioned in a way that suggests that only {{identify}} section would be used when {{identify_by}} is not set.

The actual behaviour is quite different:
* The accepted values are: {{username}}, {{auth_username}} and {{ip}}
* The default value is: {{username,ip}}
* …which is used when {{identify_by}} is not set in the config file, so existing {{identify}} section is used *in addition* to the user name.

Also, [res_pjsip_endpoint_identifier_ip documentation|https://wiki.asterisk.org/wiki/display/AST/Asterisk+15+Configuration_res_pjsip_endpoint_identifier_ip] does not mention {{identify_by}} at all, while its value influences how {{identify}} section will work.

That mismatch between documentation and actual behaviour may be quite confusing.
Comments:By: Asterisk Team (asteriskteam) 2018-03-12 09:29:27.801-0500

Thanks for creating a report! The issue has entered the triage process. That means the issue will wait in this status until a Bug Marshal has an opportunity to review the issue. Once the issue has been reviewed you will receive comments regarding the next steps towards resolution.

A good first step is for you to review the [Asterisk Issue Guidelines|https://wiki.asterisk.org/wiki/display/AST/Asterisk+Issue+Guidelines] if you haven't already. The guidelines detail what is expected from an Asterisk issue report.

Then, if you are submitting a patch, please review the [Patch Contribution Process|https://wiki.asterisk.org/wiki/display/AST/Patch+Contribution+Process].

By: Joshua C. Colp (jcolp) 2018-03-12 09:35:52.155-0500

The wiki is not currently up to date with the information contained within the source code, where things better reflect reality.

By: Richard Mudgett (rmudgett) 2018-09-04 16:02:27.366-0500

The wiki bot appears to be running again so closing the issue as the wiki is now updating.